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 more info)
Line 5: Line 5:
This wiki aims to provide detailed descriptions and history on each blocks, and also the technical aspects of the mod.
This wiki aims to provide detailed descriptions and history on each blocks, and also the technical aspects of the mod.


The namespace of this mod is '''<code>jsblock</code>''' due to it's legacy name "'''Joestu Block Mod'''"
The namespace of this mod is '''<code>jsblock</code>''' due to it's legacy name "'''Joestu Block Mod'''".
 
=== Mod Dependencies ===
 
* [https://modrinth.com/mod/fabric-api Fabric API] (For Fabric)
* [https://modrinth.com/mod/architectury-api Architectury API] (For Forge)
* [https://modrinth.com/mod/minecraft-transit-railway Minecraft Transit Railway]
* [https://modrinth.com/mod/modmenu Mod Menu] (For fabric, used for configuring the mod, not strictly required)


== Download ==
== Download ==
Line 14: Line 21:
* [https://www.joban.tk/JCM/ Official Website]
* [https://www.joban.tk/JCM/ Official Website]
* Download link in the version page listed in [[JCM:Changelogs|Changelogs]]  
* Download link in the version page listed in [[JCM:Changelogs|Changelogs]]  
Modrinth and our websites will download the file via Modrinth.
Announcements made on Discord and Changelog listed in this wiki will download the file on our webserver hosted by zbx1425.


== Information ==
== Information ==
Line 51: Line 54:
[https://github.com/TerraformersMC/ModMenu Mod Menu] - Allows configuring for Mod Menu users running on Fabric
[https://github.com/TerraformersMC/ModMenu Mod Menu] - Allows configuring for Mod Menu users running on Fabric


=== FAQ ===
== FAQ ==
'''Q: How do I add PIDS Preset?'''
'''Q: How do I add PIDS Preset?'''


'''A:''' Implying you have basic json knowledge, you can download the example pack in the [[JCM:Joban PIDS|Joban PIDS]] article
'''A:''' We have not fully documented the instructions. However if you have basic JSON knowledge, you can download the example resource pack in the [[JCM:Joban PIDS|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?'''
'''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 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.
'''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.


== Support ==
== Support ==
Please check the '''Troubleshooting''' section listed below first.
'''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 [https://discord.gg/FNc2rgWmP2 Discord Server]
If you need any help on installing this mod, or providing bug reports/suggestions, please join our [https://discord.gg/FNc2rgWmP2 Discord Server]
Line 73: Line 82:
**'''MultiMC'''
**'''MultiMC'''
**'''PrismLauncher'''
**'''PrismLauncher'''
**'''ATLauncher'''
*Support outside these launcher are not always guaranteed.
*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)
* 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 ==
== 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.
* 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 01:21, 27 April 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 1.16.5+ Forge/Fabric addon for the Minecraft Transit Railway mod that adds various blocks/functionalities.

This wiki aims to provide detailed descriptions and history on each blocks, and also the technical aspects of the mod.

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

Mod Dependencies

Download

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

Information

For Normal Users

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

For Technical Users

  • To see what JCM does when the game launches, check out Startup Behavior.
  • To check what mixins JCM has applied, please see Mixins
  • To see what packet JCM sends and receives, please check Packets

Dependencies used

Architectury Loom & Architectury Plugin - Make multiplatform development easier

Architectury API - Required by Minecraft Transit Railway

Fabric API - Required by Minecraft Transit Railway

Forgix - Merge both Forge & Fabric version into one jar

Manifold - Preprocessor to ease cross version development

ParchmentMC - Provide parameter name mappings for Mojang mapping.

Minecraft Transit Railway - Used for registering content and other functional blocks.

Minecraft Mappings - Cross version mappings

Mod Menu - Allows configuring for Mod Menu users running on Fabric

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.

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).