stephenseo/TurnBasedMinecraftMod
1
0
Fork 0
Code Issues Pull requests Projects Releases 21 Wiki Activity Actions

Update docs
Some checks failed
deploy_gh_pages_mkdocs / deploy (push) Has been cancelled
Details

Browse source
This commit is contained in:
Stephen Seo 2024-10-29 19:14:33 +09:00
parent b0a50a4a93
commit 35e24f08be
3 changed files with 37 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
tbmm-docs/docs/client_config.md
View file

@ -22,3 +22,24 @@ triggers the "battle" music or the "silly" music.
battle required to play silly music. This means if the setting is 49%, and there battle required to play silly music. This means if the setting is 49%, and there
is one player, one zombie, and two sheep in battle, then the game will play is one player, one zombie, and two sheep in battle, then the game will play
silly music (since 50% of the combatants are sheep and is greater than 49%). silly music (since 50% of the combatants are sheep and is greater than 49%).
## Battle/Silly Music
!!! note
The TurnBasedMinecraftMod (TBMM) configuration folders need to be
generated. Run the mod once to generate them, then close Minecraft.
There are two folders in the `.minecraft/config/TurnBasedMinecraft/Music/`
directory: `battle` and `silly`.
Place your music files in those folders, and the appropriate music will play
depending on if the battle is with `silly` mobs or not.
!!! note
A random song will be picked in the `battle` folder on `battle` music, and
in the `silly` music folder on `silly` music.
!!! warning
It is recommended to use .ogg Vorbis files for music. There is support for
.mp3 files, but currently .ogg Vorbis files are more stable in this mod.
Note that .ogg Opus files are NOT supported, but .ogg Vorbis files are.

16
tbmm-docs/docs/server_config.md
View file

@ -8,8 +8,9 @@ In this text area, yellow texts are setting names, green texts are setting
values that can be set when clicked on, and dark-green texts are settings that values that can be set when clicked on, and dark-green texts are settings that
display more settings when clicked on. display more settings when clicked on.
You can hover/click these texts by pressing the "t" key to open the chatbox, and !!! note
using the mouse. You can hover/click these texts by pressing the "t" key to open the chatbox,
and using the mouse.
![tbm-server-edit info when hovered](tbm-server-edit-hover.png) ![tbm-server-edit info when hovered](tbm-server-edit-hover.png)
@ -58,6 +59,7 @@ attack instead of fleeing battle.
![mob setting decision attack 100%](tbm-edit-decision-attack.png) ![mob setting decision attack 100%](tbm-edit-decision-attack.png)
!!! note
Make sure to click on "Finished Editing" to save changes to the server-side Make sure to click on "Finished Editing" to save changes to the server-side
config. config.
@ -84,8 +86,10 @@ Hit the named mob to start the editing process.
![tbm-edit custom editing](tbm-edit-custom-editing.jpg) ![tbm-edit custom editing](tbm-edit-custom-editing.jpg)
Make your changes and click on "Finished Editing", and any mob with that exact Make your changes and click on "Finished Editing", and any mob with that exact
name will have these battle settings applied. Note that these settings are also name will have these battle settings applied.
in the server-side config.
!!! note
These settings are also in the server-side config.
## Other Things to Know ## Other Things to Know
@ -94,3 +98,7 @@ defaults. This is due to new mob entries in the settings. Check the
`.minecraft/config` folder (or `config` folder on the server) to see that the `.minecraft/config` folder (or `config` folder on the server) to see that the
old settings file was renamed and the new settings file is in its place. You may old settings file was renamed and the new settings file is in its place. You may
have to compare the files to keep the settings you want. have to compare the files to keep the settings you want.
## Frequently Asked Questions
[FAQ](https://github.com/Stephen-Seo/TurnBasedMinecraftMod/blob/neoforge/FAQ.md)

2
tbmm-docs/mkdocs.yml
View file

@ -3,3 +3,5 @@ theme:
name: mkdocs name: mkdocs
color_mode: dark color_mode: dark
user_color_mode_toggle: true user_color_mode_toggle: true
markdown_extensions:
- admonition