diff options
Diffstat (limited to 'Writerside')
| -rw-r--r-- | Writerside/c.list | 6 | ||||
| -rw-r--r-- | Writerside/cfg/buildprofiles.xml | 13 | ||||
| -rw-r--r-- | Writerside/md.tree | 12 | ||||
| -rw-r--r-- | Writerside/topics/configuration.md | 71 | ||||
| -rw-r--r-- | Writerside/topics/introduction.md | 14 | ||||
| -rw-r--r-- | Writerside/topics/usage.md | 13 | ||||
| -rw-r--r-- | Writerside/v.list | 5 | ||||
| -rw-r--r-- | Writerside/writerside.cfg | 8 |
8 files changed, 142 insertions, 0 deletions
diff --git a/Writerside/c.list b/Writerside/c.list new file mode 100644 index 0000000..c4c77a2 --- /dev/null +++ b/Writerside/c.list @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE categories + SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd"> +<categories> + <category id="wrs" name="Writerside documentation" order="1"/> +</categories>
\ No newline at end of file diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml new file mode 100644 index 0000000..8ddb9c7 --- /dev/null +++ b/Writerside/cfg/buildprofiles.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd"> +<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> + + <variables></variables> + <build-profile instance="md"> + <variables> + <noindex-content>true</noindex-content> + </variables> + </build-profile> + +</buildprofiles> diff --git a/Writerside/md.tree b/Writerside/md.tree new file mode 100644 index 0000000..d77dee5 --- /dev/null +++ b/Writerside/md.tree @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE instance-profile + SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd"> + +<instance-profile id="md" + name="Molehunt Docs" + start-page="introduction.md"> + + <toc-element topic="introduction.md"/> + <toc-element topic="configuration.md"/> + <toc-element topic="usage.md"/> +</instance-profile>
\ No newline at end of file diff --git a/Writerside/topics/configuration.md b/Writerside/topics/configuration.md new file mode 100644 index 0000000..e6fc92a --- /dev/null +++ b/Writerside/topics/configuration.md @@ -0,0 +1,71 @@ +# Configuration + +The mod has two configurations. +The first one modifies the settings of the current world. +The second one modifies the default settings of all your worlds. + +## Common concept + +- Game's duration: `game_duration` (or `gameDuration`). +Sets the game's duration in minutes (default: 90). +- Percentage of mole: `mole_percentage` (or `molePercentage`). +Sets the percentage of mole (default: 25). +- Number of mole: `mole_count` (or `moleCount`). +Sets the number of mole (default: -1). +If you want to use the percentage of mole instead, set this value to -1. +- Enable players' nametag: `show_nametags` (or `showNametags`). +Players' nametag is visible (default: false). +- Enable players' skin: `show_skins` (or `showSkins`). +Players' skin is visible (default: false). +- Enable tab: `show_tab` (or `showTab`). +Tab can be used (default: false). + +Every clientside rules (nametag, skin and tab) are only used by the client during a game. +Before and after the game, they are not used. + +## Configuration per world + +All settings can be modified via gamerules. + +Every gamerule related to this mod starts with the prefix `molehunt:`. + +## Modifying default configuration + +> These settings do not override the configuration per world! +{style="note"} + +A configuration file is available inside the `config` folder. +This is `molehunt.properties`. + +### Default configuration + +```ini +# Molehunt mod configuration file + +# The duration of a molehunt game, in minutes. +# Default: 90 minutes (1 hour 30 minutes). +game_duration = 90 + +# Mole percentage. +# For example, a mole percentage of 25% will get 1 mole every 4 players. +# Default: 25 %. +mole_percentage = 25 + +# Mole count (absolute). +# This setting will overwrite the mole_percentage setting. +# If set below 0, this setting is disabled. +# Default: -1. +mole_count = -1 + +# Show nametags +# Default: false +show_nametags = false + +# Show skins +# Default: false +show_skins = false + +# Show tab +# Default: false +show_tab = false +``` diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md new file mode 100644 index 0000000..3311fd0 --- /dev/null +++ b/Writerside/topics/introduction.md @@ -0,0 +1,14 @@ +# Introduction + +[Molehunt](https://modrinth.com/mod/molehunt-mod) is a mod creating the Molehunt game in Minecraft. +You can watch this [video](https://www.youtube.com/watch?v=NJBjQ8T_1cc) to understand what it is. +If you are speaking French, I realized this [30 seconds video](https://cdn.anhgelus.world/molehunt-presentation.mp4) explaining the concept. + +## Installation + +Download the mod for your version. + +The mod requires [Fabric-API](https://modrinth.com/mod/fabric-api) to works. +[Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat) is highly recommended. + +The mod has to be installed on the server *and* on every client. diff --git a/Writerside/topics/usage.md b/Writerside/topics/usage.md new file mode 100644 index 0000000..2a02033 --- /dev/null +++ b/Writerside/topics/usage.md @@ -0,0 +1,13 @@ +# Usage + +To start a game, execute `/molehunt start`. +You must be OP. + +To stop a game, execute `/molehunt stop`. +You must be OP. +(They are already an automatic end if there is no more survivors or if the time is over.) + +To get the list of moles, use `/molehunt moles`. +You must be a mole. + +To edit the timer above the hotbar, use `/molehunt timer show` to enable and `/molehunt timer hide` to disable. diff --git a/Writerside/v.list b/Writerside/v.list new file mode 100644 index 0000000..2d12cb3 --- /dev/null +++ b/Writerside/v.list @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd"> +<vars> + <var name="product" value="Writerside"/> +</vars> diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg new file mode 100644 index 0000000..1e00bbe --- /dev/null +++ b/Writerside/writerside.cfg @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd"> + +<ihp version="2.0"> + <topics dir="topics" web-path="topics"/> + <images dir="images" web-path="images"/> + <instance src="md.tree" web-path="molehunt" version="1.1.0"/> +</ihp>
\ No newline at end of file |
