diff --git a/README.md b/README.md index dfa20de1..3d198671 100644 --- a/README.md +++ b/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. @@ -13,16 +13,13 @@ When submitting a pull request, please follow these guidelines: ## Installing -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: +To run the documentation locally, you will need to first install MkDocs and Material for MkDocs. You can do this by running the following command: -- `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` diff --git a/config/en/mkdocs.yml b/config/en/mkdocs.yml index 71d7ae4f..7b2790ad 100644 --- a/config/en/mkdocs.yml +++ b/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: diff --git a/docs/en/About/credits.md b/docs/en/About/credits.md index 6c1073c3..353fbf49 100644 --- a/docs/en/About/credits.md +++ b/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** diff --git a/docs/en/About/licensing.md b/docs/en/About/licensing.md index 188dac32..6a6276e6 100644 --- a/docs/en/About/licensing.md +++ b/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. diff --git a/docs/en/About/support.md b/docs/en/About/support.md index b8a20a7a..ff507057 100644 --- a/docs/en/About/support.md +++ b/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)** diff --git a/docs/en/Client Docs/full-screen-map.md b/docs/en/Client Docs/full-screen-map.md index a0a2c856..7f78e4fa 100644 --- a/docs/en/Client Docs/full-screen-map.md +++ b/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. diff --git a/docs/en/Client Docs/installing.md b/docs/en/Client Docs/installing.md index 355d8b73..936c82c7 100644 --- a/docs/en/Client Docs/installing.md +++ b/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/). diff --git a/docs/en/Client Docs/settings/advanced.md b/docs/en/Client Docs/settings/advanced.md index ea707880..0ddf679e 100644 --- a/docs/en/Client Docs/settings/advanced.md +++ b/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. diff --git a/docs/en/Client Docs/settings/cartography.md b/docs/en/Client Docs/settings/cartography.md index 1d7bc742..966af937 100644 --- a/docs/en/Client Docs/settings/cartography.md +++ b/docs/en/Client Docs/settings/cartography.md @@ -1,4 +1,4 @@ -## **Cartography Settings** +# **Cartography Settings** The cartography settings allow you to customize how the map is rendered, and what is shown on it. @@ -35,6 +35,6 @@ The default option for each setting below is marked with **bold text.** | Setting | Options | Description | |----------------------|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Reveal Shape | | Whether to reveal chunks in a circle or square - circle reveals show fewer chunks at once, and so perform better | -| Render Delay | Range: 0 - 10 (in seconds, Default: **2**) | How often JourneyMap should try to render the chunks around you - Higher values can result in better performance, but may result in chunks being missed when travelling at high speed | +| Render Delay | Range: 0 - 10 (in seconds, Default: **2**) | How often JourneyMap should try to render the chunks around you - Higher values can result in better performance, but may result in chunks being missed when traveling at high speed | | Cave Max Distance | Range: 0 - 32 (in chunks, Default: **0**) | The maximum distance within which to attempt to render the map while in a cave - if you set this higher than your render distance, then this will use that instead | | Surface Max Distance | Range: 0 - 32 (in chunks, default: **0**) | The maximum distance within which to attempt to render the map while above ground -if you set this higher than your render distance, then this will use that instead | diff --git a/docs/en/Client Docs/settings/full-screen-map.md b/docs/en/Client Docs/settings/full-screen-map.md index 9d6a1da7..595a27bd 100644 --- a/docs/en/Client Docs/settings/full-screen-map.md +++ b/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. diff --git a/docs/en/Client Docs/settings/grid.md b/docs/en/Client Docs/settings/grid.md index aaf58c7b..bac41dc9 100644 --- a/docs/en/Client Docs/settings/grid.md +++ b/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. diff --git a/docs/en/Client Docs/settings/minimap.md b/docs/en/Client Docs/settings/minimap.md index aed243e2..458e41ac 100644 --- a/docs/en/Client Docs/settings/minimap.md +++ b/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. diff --git a/docs/en/Client Docs/settings/overview.md b/docs/en/Client Docs/settings/overview.md index 7acab8d0..7f389673 100644 --- a/docs/en/Client Docs/settings/overview.md +++ b/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. diff --git a/docs/en/Client Docs/settings/waypoint-beacon.md b/docs/en/Client Docs/settings/waypoint-beacon.md index 66c3b166..c06828a4 100644 --- a/docs/en/Client Docs/settings/waypoint-beacon.md +++ b/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. diff --git a/docs/en/Client Docs/settings/waypoint.md b/docs/en/Client Docs/settings/waypoint.md index 09a8914c..f72f2c46 100644 --- a/docs/en/Client Docs/settings/waypoint.md +++ b/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 diff --git a/docs/en/Client Docs/settings/webmap.md b/docs/en/Client Docs/settings/webmap.md index 2918d8f2..1d72d41d 100644 --- a/docs/en/Client Docs/settings/webmap.md +++ b/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! diff --git a/docs/en/Client Docs/waypoints.md b/docs/en/Client Docs/waypoints.md index 882d8983..45be0cc7 100644 --- a/docs/en/Client Docs/waypoints.md +++ b/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: @@ -82,9 +82,10 @@ In JourneyMap 5.8.5, a new command was added which allows you to create, delete - Reloads waypoints in the waypoint directory without having to restart. - Primarily used when dropping waypoint files into the folder while the game is running. -``` +```text /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/). ## **How to Share Waypoints and Locations** @@ -108,7 +109,7 @@ A location must minimally have the x and z coordinates, but any of the following A location consists of 2 or more ''name:value'' pairs, separated with commas. Any of the following values is supported: - x (integer) **required** -- y (integer) +- y (integer) - z (integer) **required** - dim (integer) - name (string, no quotes, no commas) diff --git a/docs/en/Server Docs/Commands/waypoint_command.md b/docs/en/Server Docs/Commands/waypoint_command.md index a2cf975c..576e3602 100644 --- a/docs/en/Server Docs/Commands/waypoint_command.md +++ b/docs/en/Server Docs/Commands/waypoint_command.md @@ -1,15 +1,15 @@ -## **Waypoint Commands** +# **Waypoint Commands** Commands allows you to create and delete waypoints from the chat. -Note: It will not be ported to older versions +Note: It will not be ported to older versions - Command: waypoint - Alias: wp **Create Waypoint** -``` +```text fields in [] are optional -> [player] is the target player, if no player is specified it sends to all [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. @@ -19,7 +19,7 @@ fields in [] are optional -> **Examples** -``` +```text - /waypoint create "Spawn" minecraft:overworld 1 50 12 aqua - /waypoint create "Home" minecraft:overworld 1 50 12 aqua mysticdrew - /waypoint create "Home" minecraft:overworld 1 50 12 aqua true~~ currently bugged in v5.8.x @@ -28,9 +28,9 @@ fields in [] are optional -> **Delete Waypoint** -Note: Only deletes waypoints created by command +Note: Only deletes waypoints created by command -``` +```text /waypoint delete "WaypointName" /waypoint delete "WaypointName" true /waypoint delete "WaypointName" mysticdrew @@ -39,4 +39,4 @@ Note: Only deletes waypoints created by command **As of JourneyMap 5.9.0** -All waypoint commands require use of the player field. It takes a player or a list of players or `@a` for both create and delete. \ No newline at end of file +All waypoint commands require use of the player field. It takes a player or a list of players or `@a` for both create and delete. diff --git a/docs/en/Server Docs/Endpoints/waypoint.md b/docs/en/Server Docs/Endpoints/waypoint.md index 3155365e..ed6cdcd9 100644 --- a/docs/en/Server Docs/Endpoints/waypoint.md +++ b/docs/en/Server Docs/Endpoints/waypoint.md @@ -1,4 +1,4 @@ -## **Waypoints** +# **Waypoints** The External Waypoint Packet Listener is a feature that allows the server to send waypoints to the client. This is useful for server admins who want to provide waypoints to players without requiring an addon mod. @@ -7,18 +7,23 @@ The External Waypoint Packet Listener is a feature that allows the server to sen Below is an example of what the packet json looks like and what information the server sends to the client to process and interpret. Packet Identifier -``` + +```text discriminator:0 channel:journeymap:waypoint ``` Packet Buffer + +```text waypoint StringUtf value -> waypointjson.toString(); action StringUtf value-> "create" or "delete" announce Boolean -> value true or false : Announce determines if the user is notified when a waypoint is created or deleted. +``` Packet Reader (journeymap's client code) -``` + +```text this.waypoint = buf.readUtf(); this.action = buf.readUtf(); this.announce = buf.readBoolean(); @@ -26,7 +31,7 @@ this.announce = buf.readBoolean(); **Example Create Payload** -``` +```json { "id": "home_-10,70,32", "name": "home", @@ -47,6 +52,7 @@ this.announce = buf.readBoolean(); } ``` +```text id -> id = "name + "_" + x + "," + y + "," + z" this format is required.
name -> waypoint name
icon -> journeymap:ui/img/waypoint-icon.png this is required
@@ -61,11 +67,11 @@ g -> green value
b -> blue value
persistent -> true saves to disk, will load when the user restarts minecraft, or changes dimensions. false is not saved to disk, is removed from memory when the user exists minecraft
dimensions -> list of dimensions
- +``` **Example Delete Payload** -``` +```json { "name": "test" } @@ -73,7 +79,8 @@ dimensions -> list of dimensions
name -> waypoint name is all that is required to delete the waypoint. Example implementation using CraftBukkit -``` + +```java public static void createWaypoint(Player player, String name, IntVector3 pos, WaypointType type, ChatColor color) { Color rgb = color.getColor(); JsonObject obj = new JsonObject(); @@ -119,7 +126,8 @@ Example implementation using CraftBukkit If you have the PacketDataSerializer (PacketBuffer) deobfuscated it would most likely use buffer.writeString(...) rather than buffer.a(...) If you want to use a different buffer/write manually the internals of that method are something like: -``` + +```java public PacketDataSerializer writeString(String s, int byteLimit) { byte[] bytes = s.getBytes(StandardCharsets.UTF_8); diff --git a/docs/en/Server Docs/basic-usage.md b/docs/en/Server Docs/basic-usage.md index c36882ce..c377fbd7 100644 --- a/docs/en/Server Docs/basic-usage.md +++ b/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,12 +34,13 @@ 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. +- 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. @@ -57,7 +59,7 @@ The config file location for Forge Servers: `(server_folder)/world/serverconfig/ - 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,10 +68,13 @@ The config file location for Forge Servers: `(server_folder)/world/serverconfig/ * **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. -** **help** - displays the usage for /jmserver worldid +**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 ## **Config File Options** @@ -77,7 +82,7 @@ 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**. @@ -85,45 +90,45 @@ The following options in the config file can be modified to suit your needs. Cha - 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 diff --git a/docs/en/Server Docs/installing.md b/docs/en/Server Docs/installing.md index f6efcfba..53e338b7 100644 --- a/docs/en/Server Docs/installing.md +++ b/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. diff --git a/docs/en/Server Docs/multiplayer.md b/docs/en/Server Docs/multiplayer.md index 38c7ddf2..2d3ab3a9 100644 --- a/docs/en/Server Docs/multiplayer.md +++ b/docs/en/Server Docs/multiplayer.md @@ -1,4 +1,4 @@ -## **Settings** +# **Settings** The Multiplayer section is a section designed to give users control on how they are viewed on other clients using the JourneyMap mod, and how they are displayed on the map. This section is only unlocked when the server is running the JourneyMap mod and can be disabled by the server. diff --git a/docs/en/Server Docs/settings/default-dimension-properties.md b/docs/en/Server Docs/settings/default-dimension-properties.md index 216199bd..de144457 100644 --- a/docs/en/Server Docs/settings/default-dimension-properties.md +++ b/docs/en/Server Docs/settings/default-dimension-properties.md @@ -1,4 +1,4 @@ -## **Default Dimension Properties** +# **Default Dimension Properties** The Default Dimension Properties category contains settings that will be the default settings for all new dimensions created. These settings can be overridden on a per-dimension basis. diff --git a/docs/en/Server Docs/settings/dimension-end.md b/docs/en/Server Docs/settings/dimension-end.md index 1a0ce5ff..fd4eafb5 100644 --- a/docs/en/Server Docs/settings/dimension-end.md +++ b/docs/en/Server Docs/settings/dimension-end.md @@ -1,4 +1,4 @@ -## **Dimension: minecraft:the_end** +# **Dimension: minecraft:the_end** The Dimension: minecraft:the_end category contains settings that will be the default settings for the end dimension. diff --git a/docs/en/Server Docs/settings/dimension-nether.md b/docs/en/Server Docs/settings/dimension-nether.md index 2a6b3a69..2a15cfeb 100644 --- a/docs/en/Server Docs/settings/dimension-nether.md +++ b/docs/en/Server Docs/settings/dimension-nether.md @@ -1,4 +1,4 @@ -## **Dimension: minecraft:the_nether** +# **Dimension: minecraft:the_nether** The Dimension: minecraft:the_nether category contains settings that will be the default settings for the nether dimension. diff --git a/docs/en/Server Docs/settings/dimension-overworld.md b/docs/en/Server Docs/settings/dimension-overworld.md index 01e7a62b..0b5e62bd 100644 --- a/docs/en/Server Docs/settings/dimension-overworld.md +++ b/docs/en/Server Docs/settings/dimension-overworld.md @@ -1,4 +1,4 @@ -## **Dimension: minecraft:overworld** +# **Dimension: minecraft:overworld** The Dimension: minecraft:overworld category contains settings that will be the default settings for the overworld dimension. diff --git a/docs/en/Server Docs/settings/global-properties.md b/docs/en/Server Docs/settings/global-properties.md index aa079aea..d36dc4bc 100644 --- a/docs/en/Server Docs/settings/global-properties.md +++ b/docs/en/Server Docs/settings/global-properties.md @@ -1,4 +1,4 @@ -## **Global Properties** +# **Global Properties** The Global Properties category contains settings that affect the server side behaviour of the mod. These are the default properties for the server. diff --git a/docs/en/Server Docs/settings/overview.md b/docs/en/Server Docs/settings/overview.md index 60581e32..5f7f92c5 100644 --- a/docs/en/Server Docs/settings/overview.md +++ b/docs/en/Server Docs/settings/overview.md @@ -1,4 +1,4 @@ -## **Settings** +# **Settings** JourneyMap Server provides a few configuration options, allowing you to customize the behaviour of clients connecting with the JourneyMap mod and many different aspects of the mod. All of these settings are made available through the Server Admin tab in the settings manager. diff --git a/docs/en/Tools and Customisation/custom-mob-icons.md b/docs/en/Tools and Customisation/custom-mob-icons.md index db80f8c7..158a51f5 100644 --- a/docs/en/Tools and Customisation/custom-mob-icons.md +++ b/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 /assets/modname/textures/entity. 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 /assets//textures/entity. 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 diff --git a/docs/en/Tools and Customisation/journeymap-tools.md b/docs/en/Tools and Customisation/journeymap-tools.md index c5139fbe..3f3c0f0f 100644 --- a/docs/en/Tools and Customisation/journeymap-tools.md +++ b/docs/en/Tools and Customisation/journeymap-tools.md @@ -1,55 +1,5 @@ -## **Overview** +# **JourneyMap Tools** -**JourneyMap Tools** is a set of command line utilities which can be useful for manipulating the image tiles generated by the JourneyMap client mod. +**JourneyMap Tools** is an application which can be useful for merging map tiles into a single image. -You can find the mod at - -Source code is available at and you are encouraged to contribute! - -- **MapSaver**: Save all region tile images to a single file, with optional resizing. -- **MapMerger**: Merge tiles from two directories (usually from different players). ''Not implemented yet, can you help'?' - -## **How to use JourneyMap Tools** - -- Java 7 or Java 8 must be installed on your machine. -- Download the latest release -- Open a command line and run: `java -jar journeymap-tools*.jar -- Follow the prompts - -## **MapSaver Sample Output** -``` - - > java -jar journeymap-tools-0.3.jar - - == JourneyMapTools 0.3 == - Use at your own risk. Always back up your files before use. - - MapSaver Arguments: "" "" " Path to data/sp/worldname - "" Path of PNG image file to save. - Current tile size. Unless you've resized them, use 512. - New tile size for output. Use sourceTileSize to avoid resizing. - Vertical slice to map. Use -1 for the surface in Overworld. - Dimension ID. 1 for Nether, 0 for Overworld, 1 for End - Whether to add a grid overlay. One of the following: true,false - One of the following: day,night,underground. End/Nether require underground - - Example Usage: MapSaver "C:\\Game\\.minecraft\\journeyMap\\data\\sp\\MyWorld" "C:\\tmp\\MyWorld.png" 512 512 -1 0 false day - - > java -jar journeymap-tools-0.3.jar MapSaver "C:/Users/Mark/AppData/Roaming/.minecraft/journeymap/data/sp/Prodigious City" "C:/Users/Mark/Desktop/PCity.png" 512 512 -1 0 true day - - == JourneyMapTools 0.3 == - Use at your own risk. Always back up your files before use. - - 2014-08-08 17:40:57 [INFO] MapSaver: Scanning for region tiles... - 2014-08-08 17:40:57 [INFO] MapSaver: 24 Region tiles found. 11 blank tiles will be added to fill gaps. - 2014-08-08 17:40:57 [INFO] MapSaver: Total area is 7 regions wide by 5 regions high (224 chunks x 160 chunks) - 2014-08-08 17:40:57 [INFO] MapSaver: Combined tile images equal to: 3584 px x 2560 px - 2014-08-08 17:40:57 [INFO] PngjHelper: Processing row 1 of 5... - 2014-08-08 17:40:57 [INFO] PngjHelper: Processing row 2 of 5... - 2014-08-08 17:40:57 [INFO] PngjHelper: Processing row 3 of 5... - 2014-08-08 17:40:58 [INFO] PngjHelper: Processing row 4 of 5... - 2014-08-08 17:40:58 [INFO] PngjHelper: Processing row 5 of 5... - 2014-08-08 17:40:58 [INFO] MapSaver: Map saved: C:\Users\Mark\Desktop\PCity.png - 2014-08-08 17:40:58 [INFO] MapSaver: Elapsed: 0 min, 1 sec, 210ms -``` +Download and Documentation diff --git a/docs/en/Tools and Customisation/translate.md b/docs/en/Tools and Customisation/translate.md index d6ee59e5..abf84b30 100644 --- a/docs/en/Tools and Customisation/translate.md +++ b/docs/en/Tools and Customisation/translate.md @@ -41,7 +41,7 @@ The sample lines above have the **keys** of "jm.common.chat_announcement" and "j **Incorrect**: example.llave=Esta es una frase. -- Many of the phrases contain one or more numbered **parameters**. For example: "%1$s", "%1$d", "%2$s", etc. These are placeholders which will be replaced with a value when the message is displayed. You may reorder these parameters if it is required by the grammar rules of your language. +- Many of the phrases contain one or more numbered **parameters**. For example: "%1$s", "%1$d", "%2$s", etc. These are placeholders which will be replaced with a value when the message is displayed. You may reorder these parameters if it is required by the grammar rules of your language. For example: diff --git a/docs/en/Tools and Customisation/ui-themes.md b/docs/en/Tools and Customisation/ui-themes.md index 188d293c..eff386a9 100644 --- a/docs/en/Tools and Customisation/ui-themes.md +++ b/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.** - -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 */ diff --git a/docs/en/index.md b/docs/en/index.md index 421da6f5..94a22ff8 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -10,23 +10,22 @@ If you’d like a featureful, easy-to-use mapping mod then why not give JourneyM ## **First Steps** -- [Download JourneyMap](Client Docs/installing/) -- [Use the Options Manager](Client Docs/settings/overview) -- [Share Waypoints](Client Docs/waypoints/#sharing-waypoints) -- [Get Support](About/support/) +- [Download JourneyMap](Client Docs/installing.md) +- [Use the Options Manager](Client Docs/settings/overview.md) +- [Share Waypoints](Client Docs/waypoints.md/#sharing-waypoints) +- [Get Support](About/support.md) ## **Learn More** -- [Support for Forge/Bukkit/Sponge Servers](Server Docs/bukkit-and-spigot) -- [Use Keyboard Shortcuts (Keybindings)](Client Docs/basic-usage/#key-mappings) -- [Customize Topographic Maps](Tools and Customisation/topographic/) -- [Map a multiplayer server](Tools and Customisation/multiplayer-server/) -- [Generate custom-scale maps](Tools and Customisation/journeymap-tools/) +- [Use Keyboard Shortcuts (Keybindings)](Client Docs/basic-usage.md/#key-mappings) +- [Customize Topographic Maps](Tools and Customisation/topographic.md) +- [Map a multiplayer server](Tools and Customisation/multiplayer-server.md) +- [Generate custom-scale maps](Tools and Customisation/journeymap-tools.md) ## **Advanced Topics** -- [Use in a Modpack](About/licensing/) -- [Integrate your mod](Tools and Customisation/integration/) -- [Make custom mob Icons](Tools and Customisation/custom-mob-icons/) -- [Create a UI Theme (Skin)](Tools and Customisation/ui-themes/) -- [Translate JourneyMap For Your Language](Tools and Customisation/translate/) +- [Use in a Modpack](About/licensing.md) +- [Integrate your mod](Tools and Customisation/integration.md) +- [Make custom mob Icons](Tools and Customisation/custom-mob-icons.md) +- [Create a UI Theme (Skin)](Tools and Customisation/ui-themes.md) +- [Translate JourneyMap For Your Language](Tools and Customisation/translate.md) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..61014058 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +mkdocs +mkdocs-material +mkdocs-glightbox +mike \ No newline at end of file