Backport changes from the 5.8.5 version (#46)

* Backport changes from 5.8.5 version

* Add dependabot config

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/deploy.yml

@@ -9,11 +9,11 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.x
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           key: ${{ github.ref }}
           path: .cache

README.md

@@ -1,8 +1,8 @@
-## JourneyMap Docs
+# JourneyMap Docs
 
 This repository contains user documentation for the JourneyMap mod. Written in markdown and compiled into a static site using [MkDocs](https://www.mkdocs.org/) and [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material/).
 
-### Contributing
+## Contributing
 
 We are happy to accept pull requests for documentation changes. If you would like to contribute, please fork this repository and submit a pull request. If you are not familiar with Git or GitHub, you can also submit an issue with your suggested changes, and we will add them to the documentation.
 
@@ -15,14 +15,11 @@ When submitting a pull request, please follow these guidelines:
 
 To run the documentation locally, you will need to first install MkDocs and Material for MkDocs. You can do this by running the following commands:
 
-- `pip install mkdocs`
-- `pip install mkdocs-material`
-- `pip install mkdocs-glightbox`
-- `pip install mike`
+- `pip install -r requirements.txt`
 
 These commands will install MkDocs and Material for MkDocs.
 
-
 Run one of the following commands to start the local documentation server:
+
 1. `mkdocs serve -f ./config/en/mkdocs.yml`
 2. `python -m mkdocs serve -f ./config/en/mkdocs.yml`

config/en/mkdocs.yml

@@ -9,18 +9,26 @@ theme:
   name: material
   custom_dir: ../../overrides
   palette:
-    - scheme: default
-      primary: indigo
-      accent: indigo
+
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default 
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
-    - scheme: slate
-      primary: indigo
-      accent: indigo
+
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
       toggle:
         icon: material/brightness-4
-        name: Switch to light mode
+        name: Switch to system preference
 
 extra:
   version:

docs/en/About/credits.md

@@ -1,8 +1,10 @@
+# **Credits**
+
 >"It is amazing what you can accomplish if you do not care who gets the credit." - Harry S. Truman
 
 ## **Under The Hood**
 
-JourneyMap includes and/or makes use of the following software under their respective licenses: 
+JourneyMap includes and/or makes use of the following software under their respective licenses:
 
 **Minecraft**
 

docs/en/About/licensing.md

@@ -1,4 +1,4 @@
-## **Licensing**
+# **Licensing**
 
 JourneyMap is distributed under an All Rights Reserved license. This means that you may not alter, host or distribute JourneyMap yourself.
 

docs/en/About/support.md

@@ -1,4 +1,4 @@
-## **Live Help on Discord**
+# **Live Help on Discord**
 
 **Support is available on the public [JourneyMap Discord server](https://discord.gg/eP8gE69)**
 

docs/en/Client Docs/full-screen-map.md

@@ -1,4 +1,4 @@
-## **Full-Screen Map**
+# **Full-Screen Map**
 
 By pressing the full-screen map key (by default, the ++j++ key), you can open the full-screen map.
 

docs/en/Client Docs/installing.md

@@ -18,7 +18,7 @@ If you prefer a more complete guide you can read and follow along with at your o
     - [The CurseForge Launcher](https://download.curseforge.com/)
     - [MultiMC](https://multimc.org/)
     - [The official Minecraft Launcher](https://www.minecraft.net/download)
-    
+
     We recommend MultiMC for ease of use, but any launcher will work just fine.
 
 2. Ensure that you have a copy of Java installed. If not, you can download a copy from the [Adoptium website](https://adoptium.net/temurin/releases/).

docs/en/Client Docs/settings/advanced.md

@@ -1,4 +1,4 @@
-## **Advanced Settings**
+# **Advanced Settings**
 
 This section contains advanced settings for power users and those that may wish to tweak some of JourneyMap’s internals.
 

docs/en/Client Docs/settings/full-screen-map.md

@@ -1,4 +1,4 @@
-## **Full-Screen Map Settings**
+# **Full-Screen Map Settings**
 
 The full-screen map provides a large, scrollable view of your entire map. Just like the minimap presets, it can be
 customized to a great deal.

docs/en/Client Docs/settings/grid.md

@@ -1,4 +1,4 @@
-## **Grid Settings**
+# **Grid Settings**
 
 Both minimap presets and the full-screen map may have a configurable grid overlay. You can customize this overlay by
 clicking on the Edit Grid… button below the settings in each respective category.

docs/en/Client Docs/settings/minimap.md

@@ -1,4 +1,4 @@
-## **Minimap Settings**
+# **Minimap Settings**
 
 JourneyMap allows you to have two minimap presets. Each preset represents a separate set of settings - essentially
 allowing you to have two distinct minimaps available to switch between.

docs/en/Client Docs/settings/overview.md

@@ -1,4 +1,4 @@
-## **Settings**
+# **Settings**
 
 JourneyMap provides more than a few configuration options, allowing you to customize the behaviour and appearance of many different aspects of the mod. All of these settings are made available through the settings manager.
 

docs/en/Client Docs/settings/waypoint-beacon.md

@@ -1,4 +1,4 @@
-## **Waypoint Beacon Settings**
+# **Waypoint Beacon Settings**
 
 By default, waypoints are displayed in the world using a beacon beam in the distance, which allows you to see where they
 are from anywhere in the world. By default, you can look towards the beam and see the waypoint’s icon and label as well.

docs/en/Client Docs/settings/waypoint.md

@@ -1,4 +1,4 @@
-## **Waypoint Settings**
+# **Waypoint Settings**
 
 This category allows you to change some settings relating to how [waypoints](../waypoints.md) behave and are displayed.
 Waypoints also have a number of individual settings - you can find out about those

docs/en/Client Docs/settings/webmap.md

@@ -1,4 +1,4 @@
-## **Webmap Settings**
+# **Webmap Settings**
 
 The webmap is an entirely different way to view your map - in a web browser instead of from directly within Minecraft.
 This allows you to have a map view visible on another screen, or even another device!

docs/en/Client Docs/waypoints.md

@@ -1,4 +1,4 @@
-## **Waypoints**
+# **Waypoints**
 
 Waypoints allow you to mark specific locations on your map, in order to keep track of those locations or easily find your way back to them later.
 
@@ -38,7 +38,7 @@ Each waypoint has the following options available:
 
 - **Teleport**: If allowed by the server, teleport directly to the waypoint
 - **Find**: Find the waypoint on the [full-screen map](full-screen-map.md)
-- **On/Off**: Toggle the waypoint’s visibilty ingame
+- **On/Off**: Toggle the waypoint’s visibility ingame
 - **Remove**: Delete the waypoint
 - **Edit**: Open the waypoint editor
 - **Chat**: Copy the waypoint’s information to the chat box, as shown:

docs/en/Server Docs/basic-usage.md

@@ -3,6 +3,7 @@
 You don't have to have JourneyMap Server installed to use the JourneyMap Client. It simply provides a way for server admins to restrict some features, and/or support Bukkit Multiworld and BungeeCord installations. Some features may not be available in both Forge and Bukkit server environments, however, so please read the information on this page and the changelogs for each release to get specific information on features for your server.
 
 ## **JourneyMap 5.5.5+**
+
 To access the Server Admin Screen open the JourneyMap options screen. As an Opped user there will be a `Server Admin` button at the bottom of the screen.
 
 All Options in the Server Admin Screen have tooltips that explain them in detail.
@@ -15,7 +16,7 @@ The config file location for Fabric Servers: `(server_folder)/configs/journeymap
 
 The config file location for Forge Servers: `(server_folder)/world/serverconfig/journeymap_server.cfg`.
 
-```
+```text
     server {
     # Players in this list have access to the Journeymap's Server Admin Panel
     # Add users by name or UUID, Prefer UUID as it is more secure!
@@ -33,6 +34,7 @@ The config file location for Forge Servers: `(server_folder)/world/serverconfig/
 ```
 
 ## **Legacy Versions Below**
+
 !!! note "Legacy"
 The following only pertains to version pre JourneyMap version 5.5.5, before the Server Admin screen was added to JourneyMap.
 
@@ -57,7 +59,7 @@ The following only pertains to version pre JourneyMap version 5.5.5, before the
 
 - If you are resetting / wiping a server world map, it is not recommended to keep a previous World ID for the new world, because users will still have waypoints and map images from their old world map.
 - To reset the World ID, simply delete it from the config and a new one will be generated when the server starts up.
-- Note: Changing the World ID will result in the creation of a new folder on each JourneyMap 5.x client:  ```minecraft**'/journeymap/data/mp/(server_newworldid). ```If the client has already received a different World ID, the user's waypoints and map images will remain in the old folder: ```minecraft**'/journeymap/data/mp/(server_oldworldid).```
+- Note: Changing the World ID will result in the creation of a new folder on each JourneyMap 5.x client:  ```minecraft**'/journeymap/data/mp/(server_newworldid).```If the client has already received a different World ID, the user's waypoints and map images will remain in the old folder: ```minecraft**'/journeymap/data/mp/(server_oldworldid).```
 
 ## **Console/Chat Commands**
 
@@ -66,7 +68,7 @@ The following only pertains to version pre JourneyMap version 5.5.5, before the
 * **help** - displays a list of sub commands.
 * **worldid** - displays the current world id to the user. (If the config option UseWorldID=true)
 
-* **set** <name> - sets the world id to a user specified string and sends it to all connected clients.
+* **set** - sets the world id to a user specified string and sends it to all connected clients.
 * **setrandom** - sets the world id to a random UUID string and sends to all connected clients
 * **resync** - debug command, sends the current world id to all connected clients.  A need to use this is unusual.
 * **help** - displays the usage for /jmserver worldid
@@ -77,53 +79,53 @@ The config file is located here: ```(server folder)/configs/JourneyMapServer/(wo
 
 The following options in the config file can be modified to suit your needs. Changes require a server restart:
 
-**''UseWorldID''**
+**"UseWorldID"**
 
 - Valid options: true, false. Default value: true
 - **Important note**: If your server doesn't use multiple world folders, you do not need this feature!  Set to **false**.
 - When set to false:
     - The server will not send the worldid to the client.
     - All **/jmserver worldid** subcommands will be disabled.
 
-**''WorldID''**
+**"WorldID"**
 
 - Valid options: any valid string, no spaces!
 - This is the ID that is sent to JourneyMap for unique map instances.
 - This value is ignored if UseWorldID is set to false
 
-**''PlayerCaveMapping''**
+**"PlayerCaveMapping"**
 
 - Valid options: true, false. Default value: true
 - When set to false, users with the JourneyMap client will not have access to cave mapping features, including Nether and End maps.
 
-**''OpsCaveMapping''**
+**"OpsCaveMapping"**
 
 - Valid options: true, false. Default value: true
 - When set to true, Op users with the JourneyMap client will be allowed to use cave mapping features even if PlayerCaveMapping is disabled
 
-**''WhitelistCaveMapping''**
+**"WhitelistCaveMapping"**
 
 - A comma-separated list of usernames that will be allowed to use cave mapping features in the JourneyMap client even if PlayerCaveMapping is disabled
 - For example: WhitelistCaveMapping=techbrew,mysticdrew
 
-**''PlayerRadar''**
+**"PlayerRadar"**
 
 - Valid options: true, false. Default value: true
 - When set to false, users with the JourneyMap client will not have access to radar features.
 
-**''OpsRadar''**
+**"OpsRadar"**
 
 - Valid options: true, false. Default value: true
 - When set to true, Op users with the JourneyMap client will be allowed to use radar features even if PlayerRadar is disabled for normal users.
 
-**''SaveInWorldFolder''**
+**"SaveInWorldFolder"**
 
 - ''Valid for Forge only. Bukkit servers must keep this value false!''
 - Valid options: true, false. Default value: false
 - When set to true, the world ID will be saved to a separate file and placed in the world folder, rather than in the config file.
 - MCEdu servers must set this to true!  This ensures the world id stays with the world data when it is moved by the launcher.
 
-**''WhitelistRadar''**
+**"WhitelistRadar"**
 
 - A comma-separated list of usernames that will be allowed to use radar features in the JourneyMap client even if PlayerRadar is disabled
 - For example: WhitelistRadar=techbrew,mysticdrew

docs/en/Server Docs/installing.md

@@ -9,6 +9,7 @@ Installing JourneyMap on the server for Forge or Fabric adds some optional utili
 3. Clients that are connected will be automatically connected to the worldid. This results in the creation of a new folder by the client to store waypoints and map images: ```.minecraft/journeymap/data/mp/(server_worldid)```
 
 ## **Legacy Versions Below**
+
 !!! note "Legacy"
     The following only pertains to version pre JourneyMap version 5.5.5, before the Server Admin screen was added to JourneyMap.
 

docs/en/Tools and Customisation/custom-mob-icons.md

@@ -44,7 +44,8 @@ You can now provide icons to JourneyMap for your mod's mobs. Here's how:
 - The folder structure and filenames for your icons must mirror the folder structure and filename for your mob textures in <code>/assets/modname/textures/entity</code>.
 
 For example:
-```
+
+```text
   coolmod-1.0.jar
    └───assets
        └───coolmod
@@ -72,7 +73,8 @@ You can use a resource pack to provide icons to JourneyMap 5.3+ for any Minecraf
 - The folder structure and filenames for your icons must mirror the folder structure and filename for mob textures in minecraft or other mods in <code>/assets/<modname>/textures/entity</code>.
 
 For example, if you want to provide custom icons for both Minecraft mobs and a mod called "coolmod", the mob textures for both would along these lines:
-```
+
+```text
  minecraft.jar                         coolmod-1.0.jar
    └───assets                               └───assets
        └───minecraft                            └───coolmod
@@ -85,7 +87,8 @@ For example, if you want to provide custom icons for both Minecraft mobs and a m
 ```
 
 In your resource pack, therefore, you would mirror the above file trees, replacing "entity" with "entity_icon" to store your custom mob icon files:
-```
+
+```text
  awesomepack.zip                    
    └───assets                              
        ├───minecraft                       

docs/en/Tools and Customisation/journeymap-tools.md

@@ -17,7 +17,8 @@ Source code is available at <https://github.com/TeamJM/journeymap-tools> and you
 - Follow the prompts
 
 ## **MapSaver Sample Output**
-```
+
+```text
     
     > java -jar journeymap-tools-0.3.jar
     

docs/en/Tools and Customisation/translate.md

@@ -1,12 +1,12 @@
 ## **I. Check the current language files**
 
-This Git repository contains the latest language files for JourneyMap: **[JourneyMap Language Files](https://github.com/TeamJM/journeymap-lang)**. 
+This Git repository contains the latest language files for JourneyMap: **[JourneyMap Language Files](https://github.com/TeamJM/journeymap-lang)**.
 
 - If your language file is in the repository, view it and check it for accuracy.
 - If your language file is **not** in the repository, your language has not yet been translated for JourneyMap.
 
 ## **II. Instructions for creating / using the language file**
- 
+
 If your language file does not yet exist:
 
 1. Copy the en_US.lang file

docs/en/Tools and Customisation/ui-themes.md

@@ -34,7 +34,8 @@ Modpacks can provide a theme for users by creating a theme folder just like the
 
 This can be done by creating this file: .minecraft/journeymap/icon/theme/default.theme.config
 The contents of the file provide the theme folder name, json file name, and the name designated within the json file, like so:
-```
+
+```json
  {
   "directory": "Victorian",
   "filename": "Victorian",
@@ -43,11 +44,12 @@ The contents of the file provide the theme folder name, json file name, and the
 ```
 
 ## **Code and Comments for Themes**
+
+Each theme.json file is read by JourneyMap via GSON and creates a simple Java class hierarchy used to build the UI elements. **You cannot change the structure of the json files in any way, only edit the values provided.**
 
-Each theme.json file is read by JourneyMap via GSON and creates a simple Java class hierarchy used to build the UI elements. **You cannot change the structure of the json files in any way, only edit the values provided.**   
-
-Here is the source code of the Java class used to generate the theme.json files.  The comments are intended to give you insight into how each property is used: 
-```
+Here is the source code of the Java class used to generate the theme.json files.  The comments are intended to give you insight into how each property is used:
+
+```java
  /**
   * Theme specification for JourneyMap 5.0
   */