The District of Joban Difference between revisions of "JCM:Joban Client Mod v1"

Difference between revisions of "JCM:Joban Client Mod v1"

From The District of Joban
(Add Packsquash FAQ)
(Too nerdy, JCM v2 is open source anyway)
Line 18: Line 18:


'''The current series of Joban Client Mod (1.x.x) will no longer receive feature updates, and there is currently no plan to port the Version 1 of the mod to MTR 4.0.0, with the intention that the newly rewritten version would supersede the current series.'''
'''The current series of Joban Client Mod (1.x.x) will no longer receive feature updates, and there is currently no plan to port the Version 1 of the mod to MTR 4.0.0, with the intention that the newly rewritten version would supersede the current series.'''
 
=== Dependencies for player ===
 
=== Mod Dependencies ===


* [https://modrinth.com/mod/fabric-api Fabric API] (For Fabric)
* [https://modrinth.com/mod/fabric-api Fabric API] (For Fabric)
Line 35: Line 33:
* Download link in the version page listed in [[JCM:Changelogs|Changelogs]]  
* Download link in the version page listed in [[JCM:Changelogs|Changelogs]]  


== More informations ==
== Information and content of this mod ==
 
=== For Normal Players ===
* For a list of all JCM blocks, see [[JCM:Blocks|Blocks]].
* For a list of all JCM blocks, see [[JCM:Blocks|Blocks]].
* For a list of JCM changelog, see [[JCM:Changelogs|Changelogs]]
* For a list of JCM changelogs, see [[JCM:Changelogs|Changelogs]]
*To learn more about adding new types of PIDS Preset, see [[JCM:Joban PIDS#PIDS%20Preset|Joban PIDS]]
*To learn more about adding new types of PIDS Preset, see [[JCM:Joban PIDS#PIDS%20Preset|Joban PIDS]]
=== For Technical Players ===
* To check what mixins JCM has applied, please see [[JCM:Mixins|Mixins]]
*To see what packet JCM sends and receives, please check [[JCM:Packets|Packets]]
==== Dependencies used ====
[https://docs.architectury.dev/docs/forge_loom/ Architectury Loom & Architectury Plugin]  - Make multiplatform development easier
[https://docs.architectury.dev/docs/architectury_api/ Architectury API] - Required by Minecraft Transit Railway
[https://github.com/FabricMC/fabric Fabric API] - Required by Minecraft Transit Railway
[https://github.com/PacifistMC/Forgix Forgix] - Merge both Forge & Fabric version into one jar
[https://github.com/manifold-systems/manifold Manifold] - Preprocessor to ease cross version development
[https://parchmentmc.org/ ParchmentMC] - Provide parameter name mappings for Mojang mapping.
[https://github.com/jonafanho/Minecraft-Transit-Railway Minecraft Transit Railway] - Used for registering content and other functional blocks.
[https://github.com/jonafanho/Minecraft-Mappings Minecraft Mappings] - Cross version mappings
[https://github.com/TerraformersMC/ModMenu Mod Menu] - Allows configuring for Mod Menu users running on Fabric


== FAQ ==
== FAQ ==
Line 102: Line 74:
== Known issues and information ==
== Known issues and information ==
* If you are on 1.16.5 running an Intel GPU, this mod may crash your game if you try to turn on MTR fonts via MTR Mod. This is due to us using TTF font provided by Minecraft (For simplicity reasons), which will crash game before 1.17. '''(This doesn't occur after 1.17, you may safely turn on MTR Fonts)'''
* If you are on 1.16.5 running an Intel GPU, this mod may crash your game if you try to turn on MTR fonts via MTR Mod. This is due to us using TTF font provided by Minecraft (For simplicity reasons), which will crash game before 1.17. '''(This doesn't occur after 1.17, you may safely turn on MTR Fonts)'''
* Optifine with shaders may cause rendering issues (Such as text turned to red and characters turning to rectangle). In this case please uninstall Optifine and use the alternatives (There's nothing we can do about it at the moment)
* OptiFine with shaders may cause rendering issues (Such as text turned to red and characters turning to rectangle). In this case please uninstall Optifine and use the alternatives (There's nothing we can do about it at the moment)
* Make sure you have downloaded the correct Minecraft version
* Make sure you have downloaded the correct Minecraft version
* Make sure the version you downloaded is compatible with the MTR version you have. (See [[JCM:Changelogs|Changelogs]]).
* Make sure the version you downloaded is compatible with the MTR version you have. (See [[JCM:Changelogs|Changelogs]]).

Revision as of 23:50, 17 December 2023

Note

Content mentioned in this page as Country of Joestu refers to the now District of Joban.
We are currently distinct from the Country of Joestu server and have no relationship with them.

Joban Client Mod is an addon mod for the Minecraft Transit Railway mod that adds various blocks/functionalities.

Currently supports 1.16.5 - 1.20.1 Forge/Fabric.

This wiki aims to provide detailed descriptions and history on each blocks and it's recipe, as well as the technical aspects of the mod.

The namespace of this mod is jsblock due to it's legacy name "Joestu Block Mod".

Version 2 (Rewrite)

Joban Client Mod is currently being rewritten from scratch, designed from the ground up for MTR 4.0.0, and will be released under the version number 2.x.x.

Those interested may view the source repo here, it is however still in early stages with many incomplete features.

More details will be announced as it approach closer to the final release, along with an alpha/beta version shipped before it.


The current series of Joban Client Mod (1.x.x) will no longer receive feature updates, and there is currently no plan to port the Version 1 of the mod to MTR 4.0.0, with the intention that the newly rewritten version would supersede the current series.

Dependencies for player

Download

You may download this mod from any of the source below:

Information and content of this mod

  • For a list of all JCM blocks, see Blocks.
  • For a list of JCM changelogs, see Changelogs
  • To learn more about adding new types of PIDS Preset, see Joban PIDS

FAQ

Q: How do I add PIDS Preset?

A: We have not fully documented the instructions. However if you have basic JSON knowledge, you can download the example resource pack in the Joban PIDS article and modify it to create new PIDS Preset.

Q: Can I include this mod in my modpack?

A: Yes, you are more welcomed to do so!

Q: Will you upload the mod to CurseForge?

A: No. There's a lack of human resources to maintain the project on CurseForge, along with other UI issues and inconveniences makes it simply isn't worth doing. Please however do not re-upload the mod without our consent, it will only make things harder to keep track of.

Q: Packsquash skipped my Joban PIDS Preset Images/Textures, what do I do?

A: You should put all your textures inside a folder named textures under the jsblock folder, that way packsquash will recognize that folder (As it also exist in vanilla Minecraft) and processes the textures. This is the recommended location to put your textures in, even if not using packsquash.

Support

Please check the Troubleshooting section listed below first.

If you need any help on installing this mod, or providing bug reports/suggestions, please join our Discord Server

Before doing that however, please read the following:

  • This mod is for Minecraft Java Edition only
  • We will not port the mod to Minecraft Bedrock Edition
  • If you need help with the installation of the mod, we officially support:
    • Official Minecraft Launcher
    • MultiMC
    • PrismLauncher
    • ATLauncher
  • Support outside these launcher are not always guaranteed.
  • We strongly recommend purchasing a genuine Minecraft Account, we will not provide assistance if you failed to do so. (Bug Reports or Suggestions are not affected)

Known issues and information

  • If you are on 1.16.5 running an Intel GPU, this mod may crash your game if you try to turn on MTR fonts via MTR Mod. This is due to us using TTF font provided by Minecraft (For simplicity reasons), which will crash game before 1.17. (This doesn't occur after 1.17, you may safely turn on MTR Fonts)
  • OptiFine with shaders may cause rendering issues (Such as text turned to red and characters turning to rectangle). In this case please uninstall Optifine and use the alternatives (There's nothing we can do about it at the moment)
  • Make sure you have downloaded the correct Minecraft version
  • Make sure the version you downloaded is compatible with the MTR version you have. (See Changelogs).
Retrieved from "https://www.joban.org/w/index.php?title=JCM:Joban_Client_Mod_v1&oldid=2733"