Add minimap position screen docs (#53)

TeamJM · Feb 2, 2024 · 69879f9 · 69879f9
1 parent c367db2
commit 69879f9
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 2 deletions.
diff --git a/config/en/mkdocs.yml b/config/en/mkdocs.yml
@@ -70,6 +70,7 @@ nav:
           - Overview: Client Docs/settings/overview.md
           - Grid: Client Docs/settings/grid.md
           - Minimap: Client Docs/settings/minimap.md
+          - Minimap Position: Client Docs/settings/minimap-position.md
           - Full-Screen Map: Client Docs/settings/full-screen-map.md
           - Webmap: Client Docs/settings/webmap.md
           - Waypoint: Client Docs/settings/waypoint.md

diff --git a/docs/en/Client Docs/settings/minimap-position.md b/docs/en/Client Docs/settings/minimap-position.md
@@ -0,0 +1,24 @@
+# **Minimap Position Settings**
+
+JourneyMap allows you configure the placement for both the effect icons and the actual minimap. This allows you as a user to move the minimap and the effect icons wherever you want on the screen
+
+![Minimap-Position](../../img/settings/client/minimap-position.png){: .center}
+
+## **Toggles**
+
+The **bold** toggle settings below are enabled by default.
+
+| Toggle                         | Description                                                                    |
+|--------------------------------|--------------------------------------------------------------------------------|
+| **Move Effect Icons**          | Enables moving the potion effects away from the minimap.                       |
+| Reverse Effect Icon Rendering  | Reversed Rendering of Icons. Vertical bottom to top, non Vertical let to right |
+| Vertical Effect Icon Rendering | Vertical Rendering of the icons first from top to bottom.                      |
+
+## **Other Settings**
+
+The default option for each setting below is marked with **bold** text.
+
+| Setting                       | Options                                                                                                                                    | Description                                                                                                                |
+|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
+| Minimap Key Move Pixel Offset | <ul><li>Range: 0.001 - 0.025 <br>**Default is 0.001**</li></ul>                                                                               | When moving the minimap with arrow keys, this option controls how may pixels per key press to help fine tune the location. |
+| Position                      | <ul><li>**Top Right**</li><li>Bottom Right</li><li>Bottom Left</li><li>Top Left</li><li>Top Center</li><li>Center</li><li>Custom</li></ul> | Where the minimap should be placed on the screen.                                                                          |
diff --git a/docs/en/Client Docs/settings/minimap.md b/docs/en/Client Docs/settings/minimap.md
@@ -1,7 +1,6 @@
 # **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.
+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.
 
 !!! note "Note"
 

diff --git a/docs/en/img/settings/client/minimap-position.png b/docs/en/img/settings/client/minimap-position.png