Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
Kenny-Hui committed Nov 19, 2023
1 parent ee36e93 commit 514f3a5
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,31 @@
# Joban Client Mod - Rewrite (v2)
<p align="center">
<img src="assets/JCM_logo.png" width="180px" alt="JCM Logo">
</p>

<h1 align="center">
Joban Client Mod
</h1>

<p align="center">Bring your transit world to life with various decoration blocks!</p>

<p align="center">
<a href="https://modrinth.com/mod/jcm">
<img alt="modrinth" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg">
</a>
<a href="https://discord.com/invite/FNc2rgWmP2">
<img alt="discord-plural" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg">
</a>
</p>

<hr>

Joban Client Mod is an addon mod for the **Minecraft Transit Railway 4**, adding various blocks, from emergency stop button, helpline to fully customizable blocks like the **Railway Vision PIDS** and more!

This is an experimental rewrite of the Joban Client Mod from scratch.
This is currently not production ready yet and contains many changes (Including block ids) from Joban Client Mod 1.x.x series which may not be migrated properly to v2.
It is currently not production ready yet and contains many changes (Including block ids) from Joban Client Mod v1 series which may not be migrated properly to v2.

Prebuilt jar of the mod can be found in the [action tab](https://github.com/DistrictOfJoban/JCM-Rewrite/actions).
Use with caution!

## Roadmap
### Implemented
- Block and Item Registration
- Block Entity
- Block Entity Rendering
- GUI Screen
- Integrate '''Minecraft Mapping''' project to provide cross version (1.16.5-1.20.2) and ~~cross-platform~~ compatibility

## To be done
- Add MTR Mod as dependencies (Need a way to depend on 4.0?)
- Finish all incomplete blocks and functionalities
- Start building for different modloaders
- Migration path for JCM Legacy 1.x.x
- Roadblock:
No official path to migrate blockstates and id, will have to find our own, potentially dangerous path... or have to leave all the player unsatisfied

## Contributing
This project is still in an early stage, feel free to PR stuff mentioned in the **To be done** category.
Note that I also have my own scheduling and thoughts on handling the new rewrite, as such I may modify your PR (Usually commiting on it or afterwards) before merging.

## License
This project is licensed under the MIT License.
Binary file added assets/JCM_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 514f3a5

Please sign in to comment.