Add 5.9.x docs (#49)

* Include most 5.9.x changes

* Remove a few legacy sections and upgrade some links to https

Author: stantios

.github/workflows/deploy.yml

@@ -2,7 +2,7 @@ name: Deploy the Docs
 on:
   push:
     branches:
-      - 5.8.5
+      - 5.9.x
 permissions:
   contents: write
 jobs:
@@ -23,4 +23,4 @@ jobs:
       - run: pip install mkdocs-material
       - run: pip install mkdocs-glightbox
       - run: pip install mike
-      - run: mike deploy 5.8.5 latest --update-aliases --push -F ./config/en/mkdocs.yml
+      - run: mike deploy 5.9.x latest --update-aliases --push -F ./config/en/mkdocs.yml

config/en/mkdocs.yml

@@ -93,6 +93,7 @@ nav:
       - Endpoints: 
           - Waypoint: Server Docs/Endpoints/waypoint.md
   - Tools & Customisation:
+      - Changelogs: Tools and Customisation/changelogs.md
       - Custom Mob Icons: Tools and Customisation/custom-mob-icons.md
       - Integrate your mod: Tools and Customisation/integration.md
       - JourneyMap Tools: Tools and Customisation/journeymap-tools.md

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

@@ -8,25 +8,26 @@ The cartography settings allow you to customize how the map is rendered, and wha
 
 The **bold** toggle settings below are enabled by default.
 
-| Toggle                       | Description                                                                       |
-|------------------------------|-----------------------------------------------------------------------------------|
-| Always Map Caves             | Whether to map caves below you when you’re on the surface                         |
-| Always Map Surface           | Whether to map the surface above you when you’re in caves                         |
-| **Blend Foliage**            | Whether to apply biome colours to foliage                                         |
-| **Blend Grass**              | Whether to apply biome colours to grass                                           |
-| Blend Water                  | Whether to apply biome colours to water                                           |
-| **Ignore Glass Ceilings**    | Whether to remain in surface mode when under a glass ceiling                      |
-| **Map Biomes**               | Whether to show biome colours on the map                                          |
-| **Map Topography**           | Whether to generate a contour map that shows elevation                            |
-| Show Bathymetry              | Whether to show underwater terrain on the map                                     |
-| **Show Crops**               | Whether to show crops on the map                                                  |
-| Show Plant Shadows           | Whether to plants and crops should cast shadows on the map                        |
-| Show Plants                  | Whether to show plants on the map                                                 |
-| **Show Surface Above Caves** | Whether to show a dimmed view of the surface when in cave mode                    |
-| Show Water Biome Colours     | Whether to show water colours based on biomes                                     |
-| **Use Antialiasing**         | Whether to use anti-aliasing to improve the shading effect used to show elevation |
-| **Use Cave Lighting**        | Whether to show lights underground - disable for a fully bright map               |
-| **Use Transparency**         | Whether transparent blocks should reveal what’s below them on the map             |
+| Toggle                       | Description                                                                                                     |
+|------------------------------|-----------------------------------------------------------------------------------------------------------------|
+| Always Map Caves             | Whether to map caves below you when you’re on the surface                                                       |
+| Always Map Surface           | Whether to map the surface above you when you’re in caves                                                       |
+| **Blend Foliage**            | Whether to apply biome colours to foliage                                                                       |
+| **Blend Grass**              | Whether to apply biome colours to grass                                                                         |
+| Blend Water                  | Whether to apply biome colours to water                                                                         |
+| Clear Unlit Caves            | Unlit and inner slice blocks are rendered clear instead of black. This option only effects newly mapped blocks. |
+| **Ignore Glass Ceilings**    | Whether to remain in surface mode when under a glass ceiling                                                    |
+| **Map Biomes**               | Whether to show biome colours on the map                                                                        |
+| **Map Topography**           | Whether to generate a contour map that shows elevation                                                          |
+| Show Bathymetry              | Whether to show underwater terrain on the map                                                                   |
+| **Show Crops**               | Whether to show crops on the map                                                                                |
+| Show Plant Shadows           | Whether to plants and crops should cast shadows on the map                                                      |
+| Show Plants                  | Whether to show plants on the map                                                                               |
+| **Show Surface Above Caves** | Whether to show a dimmed view of the surface when in cave mode                                                  |
+| Show Water Biome Colours     | Whether to show water colours based on biomes                                                                   |
+| **Use Antialiasing**         | Whether to use anti-aliasing to improve the shading effect used to show elevation                               |
+| **Use Cave Lighting**        | Whether to show lights underground - disable for a fully bright map                                             |
+| **Use Transparency**         | Whether transparent blocks should reveal what’s below them on the map                                           |
 
 ## **Other Settings**
 

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

@@ -7,7 +7,7 @@ allowing you to have two distinct minimaps available to switch between.
 
     The settings for each minimap are identical, so we’ll only cover a single preset below.
 
-To switch between minimap presets, press the switch minimap preset key (the # key by default).
+To switch between minimap presets, press the switch minimap preset key (the '\' key by default).
 
 ![Minimap-Settings](../../img/settings/client/minimap.png){: .center}
 

docs/en/Client Docs/waypoints.md

@@ -86,7 +86,7 @@ In JourneyMap 5.8.5, a new command was added which allows you to create, delete
 /jm reload
 ```
 
-The create and delete commands are only available when the server has JourneyMap installed and if the player has op permissions. You can find more information about the add and delete commands [here](https://teamjm.github.io/journeymap-docs/Server%20Docs/waypoints/).
+The create and delete commands are only available when the server has JourneyMap installed and if the player has op permissions. You can find more information about the add and delete commands [here](../Server%20Docs/Commands/waypoint_command.md).
 
 ## **How to Share Waypoints and Locations**
 

docs/en/Server Docs/Commands/waypoint_command.md

@@ -11,7 +11,7 @@ Note: <u>It will not be ported to older versions</u>
 
 ```text
 fields in [] are optional -> 
-[player] is the target player, if no player is specified it sends to all
+[player] is the target player, if no player is specified, it will show an error.
 [announce] is whether the player has a notification that a waypoint is being created, if it is not specified, defaults to false it is created silently.
 - /waypoint create "name" dimension x y z color [player] [announce]
 - /waypoint delete "name" [player] [announce]

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

@@ -2,7 +2,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+**
+## **Server Admin Config**
 
 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. 
 
@@ -33,101 +33,6 @@ 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.
-
-## **Server control of Radar and Cave Mapping**
-
-- Use server configs to selectively **disable radar** and/or **disable cave mapping**(which includes Nether/End mapping) for users.
-- Exceptions can be made to allow these features for just Ops or for lists of individual users (staff, donators, etc.)
-- Works with JourneyMap client 4.0.5, 5.0.0+ and the VoxelMap client
-- Current functionality uses the color control codes used by VoxelMap, so players who have VoxelMap instead of JourneyMap will be similarly restricted. Conversely, if your server is already sending VoxelMap codes through an MOTD or other mechanism, it may conflict with the options provided by the JourneyMap Server mod.
-
-!!! note "Note"
-
-    This feature currently only works in a Forge server environment. This appears to be an issue with the way color codes are sent from a Bukkit server.  This will be fixed with a later release when the color codes are no longer used.
-
-## **Multi-world Support for Maps and Waypoints**
-
-- **Important note**: If your server doesn't use multiple worlds, you do not need this feature!  Set **UseWorldID=false** in the config file.
-- For servers with multiple world folders (not just multiple dimensions) -- usually Bukkit not Forge -- this mod will automatically send a unique **World ID** to users with the JourneyMap client whenever the client loads a world.  This is necessary for servers which use multiple worlds, because it solves <http://www.minecraftforum.net/forums/minecraft-discussion/suggestions/79149-world-uid-for-multi-world-servers> this problem. The JourneyMap client uses the World Id to organize map images and waypoints when traversing between worlds.
-- Console commands are provided for server admins to manage the World ID without needing to restart the server.
-
-## **Server Reset**
-
-- 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).```
-
-## **Console/Chat Commands**
-
-``/jmserver``
-
-* **help** - displays a list of sub commands.
-* **worldid** - displays the current world id to the user. (If the config option UseWorldID=true)
-* **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.
-
-## **Config File Options**
-
-The config file is located here: ```(server folder)/configs/JourneyMapServer/(world).cfg```
-
-The following options in the config file can be modified to suit your needs. Changes require a server restart:
-
-**"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"**
-
-- 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"**
-
-- 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"**
-
-- 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"**
-
-- 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"**
-
-- Valid options: true, false. Default value: true
-- When set to false, users with the JourneyMap client will not have access to radar features.
-
-**"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"**
-
-- ''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"**
-
-- 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
-
 ## **What it is Not**
 
 * This is not a server-side mapping mod.  No maps are created, made, hosted, shared, or even contemplated on the server.

docs/en/Server Docs/installing.md

@@ -7,13 +7,3 @@ Installing JourneyMap on the server for Forge or Fabric adds some optional utili
 1. Put the JourneyMap.jar in your **server mods** folder: ```(server folder)/mods```
 2. The first time you start the server after installing JourneyMap, a new config file will be generated in ```(server folder)/journeymap/server/<version>/journeymap.server.minecraft~<world>.config```
 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.
-
-1. Put the JourneyMap .jar in your **server mods** folder: ```(server folder)/mods/```
-2. The first time you start the server after installing **1.0RC4** or later, a new config file will be generated in ```(server folder)/configs/JourneyMapServer/(world).cfg```  **If you had previously used 1.0RC3** or earlier, you will need to update this new config file with the settings from your old config file.  We apologize for the inconvenience.
-3. If you do not want to use the randomly-generated worldid, run the command: “/jmserver worldid set <name>” in the console or within the game as an admin.
-4. Clients that are connected will be automatically updated to the new 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).```  **New in client 5.0.0RC4**:  If this is the first time a World ID is assigned, the client will automatically migrate existing waypoints and map images to the new folder.