From 8d1ce55f1c2592968c76786083a81151cfc004a3 Mon Sep 17 00:00:00 2001 From: anhgelus Date: Sat, 24 Aug 2024 16:40:02 +0000 Subject: build(docs): install writerside --- Writerside/c.list | 6 ++++++ Writerside/cfg/buildprofiles.xml | 13 +++++++++++++ Writerside/md.tree | 10 ++++++++++ Writerside/topics/introduction.md | 5 +++++ Writerside/v.list | 5 +++++ Writerside/writerside.cfg | 8 ++++++++ 6 files changed, 47 insertions(+) create mode 100644 Writerside/c.list create mode 100644 Writerside/cfg/buildprofiles.xml create mode 100644 Writerside/md.tree create mode 100644 Writerside/topics/introduction.md create mode 100644 Writerside/v.list create mode 100644 Writerside/writerside.cfg 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 @@ + + + + + \ 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 @@ + + + + + + + + true + + + + diff --git a/Writerside/md.tree b/Writerside/md.tree new file mode 100644 index 0000000..a3f2998 --- /dev/null +++ b/Writerside/md.tree @@ -0,0 +1,10 @@ + + + + + + + \ No newline at end of file diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md new file mode 100644 index 0000000..c5446c3 --- /dev/null +++ b/Writerside/topics/introduction.md @@ -0,0 +1,5 @@ +# Introduction + +Molehunt 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. 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 @@ + + + + + diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg new file mode 100644 index 0000000..c8afa7c --- /dev/null +++ b/Writerside/writerside.cfg @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file -- cgit v1.2.3 From b3ab83266a69d8be10057fa7e6d285bc81a3e671 Mon Sep 17 00:00:00 2001 From: anhgelus Date: Sat, 24 Aug 2024 16:43:33 +0000 Subject: docs(writerside): installation --- Writerside/topics/introduction.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md index c5446c3..7c6b8f4 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -3,3 +3,13 @@ Molehunt 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. + -- cgit v1.2.3 From f8e49bdad3ff71a7b054714e97caf1023987debe Mon Sep 17 00:00:00 2001 From: anhgelus Date: Sat, 24 Aug 2024 17:03:08 +0000 Subject: docs(writerside): configuration --- Writerside/md.tree | 1 + Writerside/topics/configuration.md | 71 ++++++++++++++++++++++++++++++++++++++ Writerside/topics/introduction.md | 1 - 3 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 Writerside/topics/configuration.md diff --git a/Writerside/md.tree b/Writerside/md.tree index a3f2998..870bbb4 100644 --- a/Writerside/md.tree +++ b/Writerside/md.tree @@ -7,4 +7,5 @@ start-page="introduction.md"> + \ 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 index 7c6b8f4..78749be 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -12,4 +12,3 @@ 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. - -- cgit v1.2.3 From d819094e8dc23384ac86d06ac20bb8dfc7d162fe Mon Sep 17 00:00:00 2001 From: anhgelus Date: Sat, 24 Aug 2024 17:09:49 +0000 Subject: docs(writerside): usage --- Writerside/md.tree | 1 + Writerside/topics/usage.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 Writerside/topics/usage.md diff --git a/Writerside/md.tree b/Writerside/md.tree index 870bbb4..d77dee5 100644 --- a/Writerside/md.tree +++ b/Writerside/md.tree @@ -8,4 +8,5 @@ + \ No newline at end of file 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. -- cgit v1.2.3 From 1e42af1d9ac1e0bc7d26c8323272fd6a32e3c400 Mon Sep 17 00:00:00 2001 From: anhgelus Date: Sat, 24 Aug 2024 17:18:05 +0000 Subject: ci(actions): build and publish wiki to github pages --- .github/workflows/build-docs.yml | 76 +++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ Writerside/topics/introduction.md | 2 +- Writerside/writerside.cfg | 2 +- 4 files changed, 80 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/build-docs.yml diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml new file mode 100644 index 0000000..efd7cb3 --- /dev/null +++ b/.github/workflows/build-docs.yml @@ -0,0 +1,76 @@ +name: Build documentation + +on: + push: + branches: ["main"] + workflow_dispatch: + +env: + INSTANCE: 'Writerside/md' + ARTIFACT: 'webHelpMD2-all.zip' + DOCKER_VERSION: '241.18775' + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Build docs using Writerside Docker builder + uses: JetBrains/writerside-github-action@v4 + with: + instance: ${{ env.INSTANCE }} + artifact: ${{ env.ARTIFACT }} + docker-version: ${{ env.DOCKER_VERSION }} + + - name: Save artifact with build results + uses: actions/upload-artifact@v4 + with: + name: docs + path: | + artifacts/${{ env.ARTIFACT }} + artifacts/report.json + retention-days: 7 + test: + needs: build + runs-on: ubuntu-latest + steps: + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: docs + path: artifacts + + - name: Test documentation + uses: JetBrains/writerside-checker-action@v1 + with: + instance: ${{ env.INSTANCE }} + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + needs: [build, test] + runs-on: ubuntu-latest + steps: + - name: Download artifacts + uses: actions/download-artifact@v4 + with: + name: docs + + - name: Unzip artifact + run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d dir + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Package and upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: dir + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index f739a69..b81628c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Molehunt is a Minecraft mod creating the game with the same name in this cubic game. +A complete wiki is available [here](https://www.anhgelus.world/molehunt/). + ## Usage Install the mod on the server and on all clients. diff --git a/Writerside/topics/introduction.md b/Writerside/topics/introduction.md index 78749be..3311fd0 100644 --- a/Writerside/topics/introduction.md +++ b/Writerside/topics/introduction.md @@ -1,6 +1,6 @@ # Introduction -Molehunt is a mod creating the Molehunt game in Minecraft. +[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. diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg index c8afa7c..1e00bbe 100644 --- a/Writerside/writerside.cfg +++ b/Writerside/writerside.cfg @@ -4,5 +4,5 @@ - + \ No newline at end of file -- cgit v1.2.3