Update docs

RainbowVille · Aug 5, 2024 · 74a8de2 · 74a8de2
1 parent 90dfc56
commit 74a8de2
Show file tree

Hide file tree

Showing 13 changed files with 107 additions and 43 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,8 +1,13 @@
 title: Minegasm
-logo: minegasm.png
+logo: /minegasm.png
 repository: RainbowVille/minegasm
-description: A haptics Minecraft Forge mod
+description: A haptics Minecraft (Neo)Forge mod
 theme: just-the-docs
 color_scheme: minegasm
+callouts:
+  warning:
+    color: red
+  highlight:
+    color: blue
 plugins:
 - jemoji
diff --git a/docs/_includes/nav_footer_custom.html b/docs/_includes/nav_footer_custom.html
@@ -1,3 +1,3 @@
 <footer class="site-footer">
-    Powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>.
+    Powered by <a href="https://jekyllrb.com/">Jekyll</a> & <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>
 </footer>
diff --git a/docs/config.md b/docs/config.md
@@ -1,10 +1,10 @@
 ---
 layout: default
-title: Config
+title: Configure
 nav_order: 3
 ---
 
-# Config
+# Configuration
 
 Since `v0.2`, it is possible to customize the behaviors of the mod to certain extent. It might be done through the mod config screen (when available) or by editing the `minegasm-client.toml` config file manually with a text editor. The file should typically reside in the minecraft's config directory (usually `.minecraft/config`).
 

diff --git a/docs/develop/develop.md b/docs/develop/develop.md
@@ -0,0 +1,11 @@
+---
+layout: default
+title: Development Guide
+nav_order: 7
+has_children: true
+---
+
+# Development Guide
+{: .no_toc }
+
+This section is intended for contributors.
diff --git a/docs/index.md b/docs/index.md
@@ -4,7 +4,10 @@ title: Home
 nav_order: 1
 ---
 
-Minegasm is a client-side Minecraft (Java Edition) Forge mod that provides haptic feedback to enhance the gameplay experience. This mod is intended to be used only by consenting adults.
+Minegasm is a client-side Minecraft (Java Edition) Forge mod that provides haptic feedback to enhance the gameplay experience.
+
+{: .warning }
+This mod is intended for adults only. By downloading and using this mod, you agree that you are of legal age in your country.
 
 ## Download
 
@@ -23,6 +26,9 @@ Minegasm is a client-side Minecraft (Java Edition) Forge mod that provides hapti
 * Deprecated versions (might be removed in future releases): 1.17.1, 1.18.2
 * While 1.17.1 can use both Java 16 or 17, we recommend Java 17.
 
+{: .highlight }
+We will be switching to NeoForge from 1.21 onwards. Please stay tuned for updates.
+
 ### Dependencies
 1. Intiface Central: [https://intiface.com/central/](https://intiface.com/central/)
 2. Minecraft Forge: the versions mentioned on the corresponding Forge column above are the tested versions (newer versions are probably okay) 

diff --git a/docs/release-notes/release-notes.md b/docs/release-notes/release-notes.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: Release Notes
+nav_order: 6
+has_children: true
+---
+
+# Release Notes
+{: .no_toc }
diff --git a/docs/release-notes/v0.1.md b/docs/release-notes/v0.1.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: v0.1
+nav_order: 5
+parent: Release Notes
+---
+
+# v0.1
+
+Initial release with very basic functionalities. The mod will connect to the toy upon starting and issue a vibrate command with a random intensity and duration whenever the player is hurt.
diff --git a/docs/release-notes/v0.2.md b/docs/release-notes/v0.2.md
@@ -0,0 +1,16 @@
+---
+layout: default
+title: v0.2
+nav_order: 4
+parent: Release Notes
+---
+
+# v0.2
+
+The mod is now configurable. From the mod config menu, you can choose between 3 predefined modes:
+
+* NORMAL: the toy will vibrate when you attack other entities, mine, or gain XP.
+* MASOCHIST: the toy will vibrate when you're hurt or dying.
+* HEDONIST: the toy will vibrate on all events defined in other modes, except dying (this is replaced, instead, by having the toy vibrate when you're full and healthy).
+
+The fourth CUSTOM mode allows you to set your own preferences by defining the intensity of the vibration on various events.
diff --git a/docs/release-notes/v0.3.md b/docs/release-notes/v0.3.md
@@ -0,0 +1,10 @@
+---
+layout: default
+title: v0.3
+nav_order: 3
+parent: Release Notes
+---
+
+# v0.3
+
+*Internal only*. Switched the hardware control library to [`buttplug-rs-ffi`](https://github.com/buttplugio/buttplug-rs-ffi). Abandoned in favor of v0.4.
diff --git a/docs/release-notes/v0.4.md b/docs/release-notes/v0.4.md
@@ -0,0 +1,17 @@
+---
+layout: default
+title: v0.4
+nav_order: 2
+parent: Release Notes
+---
+
+# v0.4
+
+* Now covers Minecraft 1.12 to 1.20
+* Migrated hardware control library to [`buttplug4j`](https://github.com/blackspherefollower/buttplug4j) (this supersedes v0.3)
+* Java 11 is required for 1.12.2&ndash;1.16.5 because of the `buttplug4j` library.
+
+## Known Issues
+* The mod for 1.12.2 is reported to be broken.
+* There is currently a bug in some versions of the Minecraft launcher that prevents the use of newer Java runtimes: [https://bugs.mojang.com/browse/MCL-18306](https://bugs.mojang.com/browse/MCL-18306). This affects the mods for the Minecraft versions before 1.17 as Minegasm requires at least Java 11. If you encounter this issue, a workaround is to delete `JavaCheck.jar` shipped with the launcher.
+* In-game config menu is missing for 1.13.2, 1.17.1, 1.18.2, 1.19.4, and 1.20.1. The mod can still be configured manually by editing the config file.
diff --git a/docs/release-notes/v0.5.md b/docs/release-notes/v0.5.md
@@ -0,0 +1,14 @@
+---
+layout: default
+title: v0.5
+nav_order: 1
+parent: Release Notes
+---
+
+# v0.5
+
+* Added multiplayer support
+* Vibration intensity calculation is readjusted
+* Various fixes and stability improvements
+* Removed some unpopular versions: 1.13.2, 1.14.4, 1.16.3
+* 1.12.2&ndash;1.16.5 now uses proper Java 8 version
diff --git a/docs/releases.md b/docs/releases.md
@@ -1,7 +1,7 @@
 ---
 layout: default
-title: Releases
-nav_order: 4
+title: Past Releases
+nav_order: 5
 ---
 
 # Releases
@@ -47,38 +47,4 @@ Click on the ✅ buttons to download the JARs.
 |            | Forge    | [14.23.5.2859](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.12.2.html)                    | [14.23.5.2859](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.12.2.html)                    | [14.23.5.2855](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.12.2.html)             |                                                                                                   |
 |            | Java     | 8                                                                                                                   | 8                                                                                                                   | 8                                                                                                            |                                                                                                   |
 
-## Release Notes
-
-### v0.5
-* Added multiplayer support
-* Vibration intensity calculation is readjusted
-* Various fixes and stability improvements
-* Removed some unpopular versions: 1.13.2, 1.14.4, 1.16.3
-* 1.12.2&ndash;1.16.5 now uses proper Java 8 version
-
-### v0.4
-* Now covers Minecraft 1.12 to 1.20
-* Migrated hardware control library to [`buttplug4j`](https://github.com/blackspherefollower/buttplug4j) (this supersedes v0.3)
-* Java 11 is required for 1.12.2&ndash;1.16.5 because of the `buttplug4j` library.
-
-#### Known Issues
-* The mod for 1.12.2 is reported to be broken.
-* There is currently a bug in some versions of the Minecraft launcher that prevents the use of newer Java runtimes: [https://bugs.mojang.com/browse/MCL-18306](https://bugs.mojang.com/browse/MCL-18306). This affects the mods for the Minecraft versions before 1.17 as Minegasm requires at least Java 11. If you encounter this issue, a workaround is to delete `JavaCheck.jar` shipped with the launcher.
-* In-game config menu is missing for 1.13.2, 1.17.1, 1.18.2, 1.19.4, and 1.20.1. The mod can still be configured manually by editing the config file.
-
-### v0.3
-*Internal only*. Switched the hardware control library to [`buttplug-rs-ffi`](https://github.com/buttplugio/buttplug-rs-ffi). Abandoned in favor of v0.4.
-
-### v0.2
-The mod is now configurable. From the mod config menu, you can choose between 3 predefined modes:
-
-* NORMAL: the toy will vibrate when you attack other entities, mine, or gain XP.
-* MASOCHIST: the toy will vibrate when you're hurt or dying.
-* HEDONIST: the toy will vibrate on all events defined in other modes, except dying (this is replaced, instead, by having the toy vibrate when you're full and healthy).
-
-The fourth CUSTOM mode allows you to set your own preferences by defining the intensity of the vibration on various events.
-
-### v0.1
-Initial release with very basic functionalities. The mod will connect to the toy upon starting and issue a vibrate command with a random intensity and duration whenever the player is hurt.
-
 Other outdated minor releases can be found on: <https://github.com/RainbowVille/minegasm/releases>
diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Troubleshoot
-nav_order: 5
+nav_order: 4
 ---
 
 # Troubleshooting