For Mod Developers

Releasing your Mod

Learn what to watch out for when releasing your mod.

Congratulations on your new mod!

Before releasing it into the wild, you should make sure some things are set up correctly so players won't run into issues.

If you are only using the embedded shogi-api to enable support for Shogi in your mod, you do not need to do anything more. Your mod will run just fine whether the user has Shogi installed or not.

Mod Metadata

If you are using advanced Shogi features, such as classes from shogi-common or .networked() values, make sure that your mod metadata files declare a dependency on Shogi.

fabric/src/main/resources/fabric.mod.json
  "depends": {
    "shogi": ">=${shogi_version}"
  }
fabric/src/main/resources/META-INF/neoforge.mods.toml
[[dependencies.yourmodid]]
modId="shogi"
mandatory=true
versionRange="[${shogi_version},)"
ordering="NONE"
side="BOTH"
fabric/src/main/resources/META-INF/mods.toml
[[dependencies.yourmodid]]
modId="shogi"
mandatory=true
versionRange="[${shogi_version},)"
ordering="NONE"
side="BOTH"

If you're adding these lines, make sure your Gradle setup correctly replaces the ${shogi_version} placeholder as well.

File Dependencies

If you are using advanced Shogi features, such as classes from shogi-common or .networked() values, you should also declare Shogi as a Required Dependency on your CurseForge / Modrinth upload. That way players installing your mod with a Launcher will have Shogi installed automatically alongside your mod.

Mod Hosting Platforms

Shogi is available on CurseForge only.

Third Party Downloads are enabled, so Shogi can be easily installed even outside of the official CurseForge App.