Code cleanup

RainbowVille · Aug 5, 2024 · 8e8c774 · 8e8c774
1 parent 283431b
commit 8e8c774
Show file tree

Hide file tree

Showing 267 changed files with 5,623 additions and 6,806 deletions.
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -40,38 +40,38 @@ jobs:
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
 
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
 
-        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
+          # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+          # queries: security-extended,security-and-quality
 
 
-    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
 
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
 
-    #   If the Autobuild fails above, remove it and uncomment the following three lines.
-    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+      #   If the Autobuild fails above, remove it and uncomment the following three lines.
+      #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
 
-    # - run: |
-    #     echo "Run, Build Application using script"
-    #     ./location_of_script_within_repo/buildscript.sh
+      # - run: |
+      #     echo "Run, Build Application using script"
+      #     ./location_of_script_within_repo/buildscript.sh
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/fg-2.1.yml b/.github/workflows/fg-2.1.yml
@@ -20,20 +20,20 @@ jobs:
       run:
         working-directory: forge/fg-2.1
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK
-      uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: 8
-    - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v3
-      with:
-        gradle-version: 4.10.3
-    - name: Run Gradle build
-      working-directory: forge/fg-2.1
-      run: gradle :${{ inputs.version }}:build
-    - uses: actions/upload-artifact@v4
-      with:
-        name: Minegasm-${{ inputs.version }}
-        path: forge/fg-2.1/${{ inputs.version }}/build/libs/*
+      - uses: actions/checkout@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 8
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 4.10.3
+      - name: Run Gradle build
+        working-directory: forge/fg-2.1
+        run: gradle :${{ inputs.version }}:build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Minegasm-${{ inputs.version }}
+          path: forge/fg-2.1/${{ inputs.version }}/build/libs/*
diff --git a/.github/workflows/fg-6.0.yml b/.github/workflows/fg-6.0.yml
@@ -20,24 +20,24 @@ jobs:
       run:
         working-directory: forge/fg-6.0
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK
-      uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: |
-          8
-          16
-          17
-          21
-    - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v3
-      with:
-        gradle-version: 8.9
-    - name: Run Gradle build
-      working-directory: forge/fg-6.0
-      run: gradle :${{ inputs.version }}:build
-    - uses: actions/upload-artifact@v4
-      with:
-        name: Minegasm-${{ inputs.version }}
-        path: forge/fg-6.0/${{ inputs.version }}/build/libs/*-${{ inputs.version }}*
+      - uses: actions/checkout@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: |
+            8
+            16
+            17
+            21
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 8.9
+      - name: Run Gradle build
+        working-directory: forge/fg-6.0
+        run: gradle :${{ inputs.version }}:build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Minegasm-${{ inputs.version }}
+          path: forge/fg-6.0/${{ inputs.version }}/build/libs/*-${{ inputs.version }}*
diff --git a/.github/workflows/ng-7.0.yml b/.github/workflows/ng-7.0.yml
@@ -20,21 +20,21 @@ jobs:
       run:
         working-directory: neoforge/ng-7.0
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK
-      uses: actions/setup-java@v4
-      with:
-        distribution: 'zulu'
-        java-version: |
-          21
-    - name: Setup Gradle
-      uses: gradle/actions/setup-gradle@v3
-      with:
-        gradle-version: 8.9
-    - name: Run Gradle build
-      working-directory: neoforge/ng-7.0
-      run: gradle :${{ inputs.version }}:build
-    - uses: actions/upload-artifact@v4
-      with:
-        name: Minegasm-${{ inputs.version }}
-        path: neoforge/ng-7.0/${{ inputs.version }}/build/libs/*-${{ inputs.version }}*
+      - uses: actions/checkout@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: |
+            21
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 8.9
+      - name: Run Gradle build
+        working-directory: neoforge/ng-7.0
+        run: gradle :${{ inputs.version }}:build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Minegasm-${{ inputs.version }}
+          path: neoforge/ng-7.0/${{ inputs.version }}/build/libs/*-${{ inputs.version }}*
diff --git a/README.md b/README.md
@@ -2,19 +2,20 @@
 
 User Guide: https://www.minegasm.net/
 
-| Minecraft             | Forge MDK    | JDK | FG  | Gradle | Status                                                                                                                                                                                        |
-|-----------------------|--------------|-----|-----|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 1.20.4                | 49.1.0       | 17  | 6.0 | 8.9    | [![1.20.4](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.20.4.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.20.4.yml) |
-| **1.19.4**            | 45.3.0       | 17  | 6.0 | 8.9    | [![1.19.4](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.4.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.4.yml) |
-| 1.19.2                | 43.4.0       | 17  | 6.0 | 8.9    | [![1.19.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.2.yml) |
-| **1.18.2**            | 40.2.0       | 17  | 6.0 | 8.9    | [![1.18.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.18.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.18.2.yml) |
-| **1.16.5**            | 36.2.34      | 8   | 6.0 | 8.9    | [![1.16.5](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.16.5.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.16.5.yml) |
-| **1.15.2**            | 31.2.57      | 8   | 6.0 | 8.9    | [![1.15.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.15.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.15.2.yml) |
-| **1.12.2**            | 14.23.5.2859 | 8   | 6.0 | 8.9    | [![1.12.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.12.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.12.2.yml) |
+| Minecraft  | Forge MDK    | JDK | FG  | Gradle | Status                                                                                                                                                                                        |
+|------------|--------------|-----|-----|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 1.20.4     | 49.1.0       | 17  | 6.0 | 8.9    | [![1.20.4](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.20.4.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.20.4.yml) |
+| **1.19.4** | 45.3.0       | 17  | 6.0 | 8.9    | [![1.19.4](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.4.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.4.yml) |
+| 1.19.2     | 43.4.0       | 17  | 6.0 | 8.9    | [![1.19.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.19.2.yml) |
+| **1.18.2** | 40.2.0       | 17  | 6.0 | 8.9    | [![1.18.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.18.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.18.2.yml) |
+| **1.16.5** | 36.2.34      | 8   | 6.0 | 8.9    | [![1.16.5](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.16.5.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.16.5.yml) |
+| **1.15.2** | 31.2.57      | 8   | 6.0 | 8.9    | [![1.15.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.15.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.15.2.yml) |
+| **1.12.2** | 14.23.5.2859 | 8   | 6.0 | 8.9    | [![1.12.2](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.12.2.yml/badge.svg)](https://github.com/RainbowVille/minegasm/actions/workflows/gradle-forge-1.12.2.yml) |
 
 ## Work in progress
 
-As more and more mods are switching to NeoForge, we plan to also completely switch to it from 1.21 onwards. We will have both Forge and NeoForge versions available for 1.20.6.
+As more and more mods are switching to NeoForge, we plan to also completely switch to it from 1.21 onwards. We will have
+both Forge and NeoForge versions available for 1.20.6.
 
 | Minecraft  | (Neo)Forge MDK | JDK | FG/NG | Gradle | Status                                                                                                                                                                                              |
 |------------|----------------|-----|-------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

diff --git a/common/gradle.properties b/common/gradle.properties
@@ -2,10 +2,7 @@
 # This is required to provide enough memory for the Minecraft decompilation process.
 org.gradle.jvmargs=-Xmx3G
 org.gradle.daemon=false
-
-
 ## Mod Properties
-
 # The unique mod identifier for the mod. Must be lowercase in English locale. Must fit the regex [a-z][a-z0-9_]{1,63}
 # Must match the String constant located in the main mod class annotated with @Mod.
 mod_id=minegasm
@@ -23,7 +20,6 @@ mod_group_id=com.therainbowville.minegasm
 mod_authors=RSwoop, RainbowVille's contributors
 # The description of the mod. This is a simple multiline text string that is used for display purposes in the mod list.
 mod_description=Just a simple mod to bring some gasm into Minecraft. ;)
-
 mod_issue_tracker_url=https://github.com/RainbowVille/minegasm/issues
 mod_update_json_url=https://www.minegasm.net/updates.json
 mod_display_url=https://www.minegasm.net/

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -10,4 +10,4 @@ callouts:
   highlight:
     color: blue
 plugins:
-- jemoji
+  - jemoji
diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html
@@ -1 +1 @@
-<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro">
+<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro" rel="stylesheet" type="text/css">
diff --git a/docs/_includes/nav_footer_custom.html b/docs/_includes/nav_footer_custom.html
@@ -1,3 +1,4 @@
 <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
@@ -6,9 +6,12 @@ nav_order: 3
 
 # 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`).
+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`).
 
 There are a few tables (collections of key/value pairs) in the config file:
+
 * `buttplug`: to configure the connection to the buttplug server
 * `minegasm`: to configure the in-game behaviors of the mod
 
@@ -22,12 +25,13 @@ At the moment, there is only one option:
 
 ## minegasm
 
-| Config   | Key                           | Description                                                           |
-|----------|-------------------------------|-----------------------------------------------------------------------|
-| Vibrate  | `vibrate`                     | Enable/disable vibration                                              |
-| Mode     | `mode`                        | Select gameplay mode: NORMAL, MASOCHIST, HEDONIST, or CUSTOM          |
+| Config  | Key       | Description                                                  |
+|---------|-----------|--------------------------------------------------------------|
+| Vibrate | `vibrate` | Enable/disable vibration                                     |
+| Mode    | `mode`    | Select gameplay mode: NORMAL, MASOCHIST, HEDONIST, or CUSTOM |
 
 Furthermore, it contains the following table(s):
+
 * intensity
 
 ### intensity

diff --git a/docs/develop/develop.md b/docs/develop/develop.md
@@ -6,6 +6,7 @@ has_children: true
 ---
 
 # Development Guide
+
 {: .no_toc }
 
 This section is intended for contributors.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro">
		<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro" rel="stylesheet" type="text/css">