Add "mkdocs" documentation

This commit is contained in:
Stephen Seo 2024-10-29 17:37:35 +09:00
commit 551b50b680
21 changed files with 136 additions and 0 deletions

View file

@ -0,0 +1,24 @@
# Client-side Config
The client config can be opened in two ways.
One way is via the mod-list (only works in NeoForge, not Forge).
![Mod list config button](tbm-client-edit-modlist.jpg)
The other way is via the `/tbm-client-edit` command.
![tbm-client-edit command](tbm-client-edit-cmd.png)
Currently, the client config allows for configuration for client-side music
playback.
![client config](tbm-client-edit-config.jpg)
The "categories" settings are comma-separated words that define what "category"
triggers the "battle" music or the "silly" music.
"Silly Music Threshold" determines the percentage of silly-category-mobs in
battle required to play silly music. This means if the setting is 49%, and there
is one player, one zomibe, and two sheep in battle, then the game will play
silly music (since 50% of the combatants are sheep and is greater than 49%).

11
tbmm-docs/docs/index.md Normal file
View file

@ -0,0 +1,11 @@
# TurnBasedMinecraftMod
[Main repository link.](https://github.com/Stephen-Seo/TurnBasedMinecraftMod)
[Alternate repository link.](https://git.seodisparate.com/stephenseo/TurnBasedMinecraftMod)
## Pages
[Client-side config](client_config.md)
[Server-side config](server_config.md)

View file

@ -0,0 +1,96 @@
# Server-side Config
Invoke `/tbm-server-edit` to print out server settings to the "chat" area.
![tbm-server-edit output](tbm-server-edit-full.png)
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
display more settings when clicked on.
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 output when haste-speed is set](tbm-server-edit-set-haste.png)
When clicking on the dark-green texts, a description and list is shown. You can
hover over the text to show what actions may occur when clicked.
![tbm-server-edit ignore-damage-sources
output](tbm-server-edit-damage-sources.png)
On click, the action taken will be shown.
![tbm-server-edit ignore-damage-sources
modified](tbm-server-edit-damage-sources-set.png)
It is also possible to set config settings via a command, but it is recommended
to use the "click-on-chat" interface for general server config settings.
## Per-Mob Settings
To demonstrate setting "per-mob" settings, it will be shown how to do so with
sheep.
![sheep](tbm-edit-sheep.jpg)
Invoke `/tbm-edit`. Some helpful text will show.
![/tbm-edit output](tbm-edit-output.jpg)
At this point, TBMM (TurnBasedMinecraftMod) will be keeping track of who you
will attack next, so that you can edit their settings. Currently this only
applies to mobs like sheep, zombies, skeletons, bees, etc. This is done so that
you can physically select the mob you want to "edit".
![mob settings](tbm-edit-settings.jpg)
In this example, the "AE" (attack effect) setting will be changed to
"levitation", which will cause the sheep to make the player levitate 50% of the
time.
![mob setting attack effect levitation](tbm-edit-levitation.png)
Also, "DecisionAttack" will be set to 100%, so that the sheep will choose to
attack instead of fleeing battle.
![mob setting decision attack 100%](tbm-edit-decision-attack.png)
Make sure to click on "Finished Editing" to save changes to the server-side
config.
Note that for sheep to enter battle, they must be removed from the "ignore
battle categories" setting (remove the "passive" category).
![server edit remove passive from ignore
categories](tbm-edit-server-edit-ignore-battle-types.png)
Now, sheep will attack and cause "levitation" 50% of the time.
![after battle with levitation effect](tbm-edit-post-battle.jpg)
## Custom Name Settings
Additional entries can be added to the server-side config that applies to mobs
named with a specific name (like with a name-tag). Name a mob, then invoke
`/tbm-edit custom`.
![tbm-edit custom command](tbm-edit-custom.png)
Hit the named mob to start the editing process.
![tbm-edit custom editing](tbm-edit-custom-editing.jpg)
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
in the server-side config.
## Other Things to Know
Sometimes a mod update will "reset" the settings in the server-config to
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
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.

Binary file not shown.

After

Width:  |  Height:  |  Size: 6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

5
tbmm-docs/mkdocs.yml Normal file
View file

@ -0,0 +1,5 @@
site_name: Documentation for TurnBasedMinecraftMod
theme:
name: mkdocs
color_mode: dark
user_color_mode_toggle: true