From 74a8de2994e9ed7508b97d1f2646d2a3f8a03aef Mon Sep 17 00:00:00 2001 From: RSwoop <47505753+RSwoop@users.noreply.github.com> Date: Mon, 5 Aug 2024 04:03:10 +0200 Subject: [PATCH] Update docs --- docs/_config.yml | 9 +++++-- docs/_includes/nav_footer_custom.html | 2 +- docs/config.md | 4 +-- docs/develop/develop.md | 11 ++++++++ docs/index.md | 8 +++++- docs/release-notes/release-notes.md | 9 +++++++ docs/release-notes/v0.1.md | 10 +++++++ docs/release-notes/v0.2.md | 16 +++++++++++ docs/release-notes/v0.3.md | 10 +++++++ docs/release-notes/v0.4.md | 17 ++++++++++++ docs/release-notes/v0.5.md | 14 ++++++++++ docs/releases.md | 38 ++------------------------- docs/troubleshoot.md | 2 +- 13 files changed, 107 insertions(+), 43 deletions(-) create mode 100644 docs/develop/develop.md create mode 100644 docs/release-notes/release-notes.md create mode 100644 docs/release-notes/v0.1.md create mode 100644 docs/release-notes/v0.2.md create mode 100644 docs/release-notes/v0.3.md create mode 100644 docs/release-notes/v0.4.md create mode 100644 docs/release-notes/v0.5.md diff --git a/docs/_config.yml b/docs/_config.yml index 877f5bc..27d8b64 100644 --- 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 index f40b961..f116f46 100644 --- a/docs/_includes/nav_footer_custom.html +++ b/docs/_includes/nav_footer_custom.html @@ -1,3 +1,3 @@ \ No newline at end of file diff --git a/docs/config.md b/docs/config.md index 121b301..e1d4212 100644 --- 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 new file mode 100644 index 0000000..394686f --- /dev/null +++ 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 index 44876a6..1084d75 100644 --- 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 new file mode 100644 index 0000000..2677d24 --- /dev/null +++ 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 new file mode 100644 index 0000000..04b15d1 --- /dev/null +++ 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 new file mode 100644 index 0000000..f67b7a7 --- /dev/null +++ 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 new file mode 100644 index 0000000..c55e5d0 --- /dev/null +++ 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 new file mode 100644 index 0000000..141cc8d --- /dev/null +++ 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–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 new file mode 100644 index 0000000..dda18ac --- /dev/null +++ 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–1.16.5 now uses proper Java 8 version diff --git a/docs/releases.md b/docs/releases.md index ca57606..45a14c1 100644 --- 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–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–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: \ No newline at end of file diff --git a/docs/troubleshoot.md b/docs/troubleshoot.md index 2e9ed2e..0c0446f 100644 --- a/docs/troubleshoot.md +++ b/docs/troubleshoot.md @@ -1,7 +1,7 @@ --- layout: default title: Troubleshoot -nav_order: 5 +nav_order: 4 --- # Troubleshooting