TurnBasedMinecraftMod/README.md

TurnBasedMinecraftMod

This mod puts turn-based-combat of RPGs into Minecraft!

Links/Downloads

Precompiled jars are available here:
https://seodisparate.com/static/tbm_releases/
https://burnedkirby.com/tbmm_downloads/
https://www.curseforge.com/minecraft/mc-mods/turnbasedminecraft/files

(Once modrinth.com has approved this mod, the modrinth page of this mod will be linked here.)

Reproducibility

This mod should support reproducible builds. See Reproducibility.md to see more details.

Forge or NeoForge

The master branch tracks the version of the mod for Minecraft Forge.

The neoforge branch tracks the version of the mod for Minecraft NeoForge.

What changed in what version

See the Changelog

Things you may need to know about this mod

On first run, this mod will create a config file and some directories in your Minecraft directory. They will typically be located at .minecraft/config/TurnBasedMinecraft. (for the server they will be in the config directory in the server directory.)

The config file .minecraft/config/TurnBasedMinecraft/TBM_Config.toml is commented with info on what each option does. It will also be moved if a newer version of this mod has a newer version of the config file (usually renamed with a timestamp). I will try my best to not move the previous version config, but rather edit the previous version config to have new options. When a new config version is made, usually because a new entry has been added, the existing config is renamed to a file with a timestamp in the filename of when it was replaced. One can set a config option in the config to prevent it being overwritten if necessary.

Some options in the config file only affect the Server, and some only affect the Client. When playing multiplayer, some configuration of the config on the server may be needed.

Features

• Combat between players and mobs or other players will invoke a turn based battle between them
• Supports use of the vanilla Minecraft bow and arrows (have bow selected when in battle)
• Supports custom battle music to be played when fighting enemies. (They must be placed in .minecraft/config/TurnBasedMinecraft/Music/battle or .minecraft/config/TurnBasedMinecraft/Music/silly. Client-side config determines which song plays in battle for the client. only .wav, .mid, and .mp3 files supported. Only .mid files are not affected by volume options (master and music sliders)) Midi file playback has been disabled for now due to lack of volume control issues. MP3 file playback sometimes fails, but seems to work better when the file is as "barebones" as possible (no album art metadata in the file).
• Config allows limiting number of combatants in turn-based battle.
• Config can be modified (server-side) to add entries of mobs from other mods. (by default an unknown mob cannot enter turn-based battle, so the config must be configured for them.)
  • Alternatively, the command "/tbm-edit" can be used in-game to add/edit entities for the mod.
  • Also, one can make entries for specific custom names
  • Server-side config can be edited in-game with the "/tbm-server-edit" command

Building

Simply invoke ./gradlew build in the mod directory and after some time the finished jar will be saved at "build/libs/TurnBasedMinecraft-NeoForge-1.24.0-all.jar"

Other notes

This mod uses shadow which is licenced under the Apache License 2.0.

This mod also uses JavaMP3 which is licensed under the MIT License.

Related Videos

See related videos here