Files
Speedometer/readme.md
Zacharias 822bb28b45 Update readme.md
Updated crediting to org.json
Added github CI build shield
2025-07-15 23:49:16 +02:00

30 lines
1.3 KiB
Markdown

# Speedometer
This is a simple mod for Forge, Fabric, and NeoForged that displays your current speed
[![Build Status](https://github.com/zaze06/Speedometer/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/zaze06/Speedometer/actions/workflows/gradle.yml)
## Credits to
[org.json](https://www.json.org/json-en.html) *Included via Gradle and MavenCenter*
## Compile your own version?
1. Download source code
* Run `git clone https://github.com/zaze06/Speedometer`
* Download the source code from GitHub page [master.zip](https://github.com/zaze06/Speedometer/archive/refs/heads/master.zip)
* unzip the folder
2. Open the folder
3. Run `gradlew build`(Windows cmd) or `./gradlew build`(Linux, MacOS, Windows powershell)
4. the compiled version will be in
* Fabic: `fabric/build/libs`
* NeoForge: `neoforged/build/libs`
* Forge: `forge/build/libs`
## Forge Support Transition
As of version 1.21 I chose to no longer support Forge in fevour of NeoForged
# This mod is a newer version of [speedometer-forge](https://github.com/zaze06/speedometer-forge)
## Changes from old forge version?
This was just a project I choose for trying the Architectury API for abstraction.
So changes are that now Architectury APi is required for this mod to work