Skip to content

Commit 406fdf1

Browse files
mysticdrewmysticdrew
committed
updates
1 parent 7a8ea7e commit 406fdf1

46 files changed

Lines changed: 777 additions & 117 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/en/about/support.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
**Support is available on the public [JourneyMap Discord server](https://discord.gg/eP8gE69)**
44

5-
- Be sure to report the version of Minecraft (for example 1.21.1 or 26.1), the version of JourneyMap, and your mod loader (Fabric, NeoForge, or Forge) when you ask a question. The Minecraft version matters: JourneyMap 6.0 has a separate build for the 1.21.1 line and the 26.1 line, and some features differ between them.
5+
- Be sure to report the version of Minecraft (for example 1.21.1, 1.21.11, 26.1, or 26.2), the version of JourneyMap, and your mod loader (Fabric, NeoForge, or Forge) when you ask a question. The Minecraft version matters: JourneyMap 6.0 has separate builds for the 1.21.1 line and the 26.x line, and some features differ between them.
66
- If you aren't answered right away, **be patient and stay connected**. Discord often is paced more like a forum than a chat room. Even though people are connected, they may actually be away from their computer when you join.

‎docs/en/changelogs.md‎

Lines changed: 49 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/en/client/full-screen-map.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,24 @@ Around the edge of the full-screen map is a set of buttons, which you can use to
8787
| ![Save](../img/icons/savemap.png){: .center} | Save the whole map to a file. |
8888
| ![Auto-Map](../img/icons/automap.png){: .center} | Map the explored world, in single-player. |
8989
| ![Disable](../img/icons/disable.png){: .center} | Toggle mapping on and off. |
90+
91+
!!! note "Auto-Map options"
92+
93+
Opening **Auto-Map** shows a dialog of mapping options. When cave
94+
mapping is enabled it includes a **Map All Layers** option, which
95+
maps every surface map type (Day/Night, Topography, Biome) and every
96+
cave layer in a single pass. It is thorough but takes significantly
97+
longer and uses more disk space.
98+
99+
![Auto-Map](../img/client/automap.png){: .center}
100+
101+
!!! note "Invalidate Zoom LODs"
102+
103+
The **Delete** map popup has an **Invalidate Zoom LODs** option, for
104+
the current dimension or all dimensions. Zoom LODs are the
105+
lower-detail tiles shown when the map is zoomed out; invalidating
106+
them forces them to regenerate from your full-detail tiles as you
107+
view the map. Use it to fix rare cases where the zoomed-out map looks
108+
wrong, without deleting your actual map data.
109+
110+
![Delete-Map](../img/client/delete-map.png){: .center}

‎docs/en/client/installing.md‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,22 @@ JourneyMap can be found on [CurseForge](https://www.curseforge.com/minecraft/mc-
44

55
## **Requirements**
66

7-
JourneyMap 6.0 is released for two Minecraft lines. Download the file that matches your Minecraft version and mod loader, and make sure you have the right version of Java installed.
7+
JourneyMap 6.0 is released for several Minecraft versions. Download the file that matches your Minecraft version and mod loader, and make sure you have the right version of Java installed.
88

99
| Minecraft version | Java | Mod loaders |
1010
|-------------------|---------|---------------------------|
1111
| 1.21.1 | Java 21 | Fabric, NeoForge, Forge |
12+
| 1.21.11 | Java 21 | Fabric, NeoForge, Forge |
1213
| 26.1 | Java 25 | Fabric, NeoForge, Forge |
14+
| 26.2 | Java 25 | Fabric, NeoForge, Forge |
1315

1416
If you do not have the right version of Java, you can download a copy from the [Adoptium website](https://adoptium.net/temurin/releases/).
1517

18+
!!! note "Renderer"
19+
20+
The 1.21.1, 1.21.11, and 26.1 builds use Minecraft's OpenGL
21+
renderer. The 26.2 build uses Minecraft's new Vulkan renderer.
22+
1623
!!! note "Which loader?"
1724

1825
JourneyMap is built for Fabric, NeoForge, and Forge. Pick whichever

‎docs/en/client/settings/advanced.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,11 @@ The **bold** toggle settings below are enabled by default.
1919
| **Announce Mod** | Announces in the chat window that JourneyMap is ready |
2020
| **Check for Mod Updates** | Turning this off means you won't be notified when there's a new version of JourneyMap available |
2121
| **Chunk Data Caching** | Enables or disables chunk caching - when disabled, teleporting or creating waypoints outside of your render range will default to sea level y=64 |
22-
| GL Error Checking | Enables OpenGL error checking - enabling can decrease performance, and a restart is required after changing this value |
22+
| GL Error Checking | Enables OpenGL error checking - enabling can decrease performance, and a restart is required after changing this value. Applies to the OpenGL builds only; the Minecraft 26.2 build uses Vulkan |
2323
| **Hide Sneaking Entities** | Whether to hide creatures that are trying to sneak (crouch) |
2424
| Hide Spectators | Whether to hide spectators on the radar |
2525
| **LOD Tiles** | Enable LOD (level-of-detail) tile rendering when zoomed out on the map - disabling and saving will delete LOD cache files from disk |
26+
| **Minimap Map Type Overlay** | Show or hide the map type icon that briefly appears when you switch the minimap's map type (Day, Night, Cave, Topo, Biome) |
2627
| **Minimap Preset Number Overlay** | Show or hide the number overlay displayed when switching minimap presets |
2728
| **Mob Icon Fade** | Enable or disable mob icons fading based on vertical distance from the player |
2829
| Multi World Support | Experimental: prevents map overwriting in multi-world server setups - only takes effect after rejoining the server |
@@ -40,11 +41,11 @@ The default option for each setting below is marked with **bold text.**
4041
|------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
4142
| Logging Level | <ul><li>**INFO**</li><li>ALL</li><li>DEBUG</li><li>ERROR</li><li>FATAL</li><li>OFF</li><li>TRACE</li><li>WARN</li></ul> | Set how verbose JourneyMap's logs are - caution, some logging levels will hurt performance, keep the default unless instructed |
4243
| AutoMap Poll Frequency | Range: 500 - 10000 (in ms) <br>Default is **2000** | Delay between AutoMap region tasks - lower values will decrease time to AutoMap, but can hurt performance |
43-
| Cache Animals | Range: 1000 - 10000 (in ms) <br>Default is **3100** | Duration radar data is cached before checking for new animals - lower values can hurt performance |
44-
| Cache Mobs | Range: 1000 - 10000 (in ms) <br>Default is **3000** | Duration radar data is cached before checking for new mobs - lower values can hurt performance |
45-
| Cache Player | Range: 500 - 2000 (in ms) <br>Default is **1000** | Duration status data about you is cached before being rechecked - lower values can hurt performance |
46-
| Cache Players | Range: 1000 - 10000 (in ms) <br>Default is **2000** | Duration radar data is cached before checking for new players - lower values can hurt performance |
47-
| Cache Villagers | Range: 1000 - 10000 (in ms) <br>Default is **2200** | Duration radar data is cached before checking for new villagers - lower values can hurt performance |
44+
| Cache Animals | Range: 100 - 10000 (in ms) <br>Default is **3100** | Duration radar data is cached before checking for new animals - lower values can hurt performance |
45+
| Cache Mobs | Range: 100 - 10000 (in ms) <br>Default is **3000** | Duration radar data is cached before checking for new mobs - lower values can hurt performance |
46+
| Cache Player | Range: 100 - 2000 (in ms) <br>Default is **1000** | Duration status data about you is cached before being rechecked - lower values can hurt performance |
47+
| Cache Players | Range: 100 - 10000 (in ms) <br>Default is **2000** | Duration radar data is cached before checking for new players - lower values can hurt performance |
48+
| Cache Villagers | Range: 100 - 10000 (in ms) <br>Default is **2200** | Duration radar data is cached before checking for new villagers - lower values can hurt performance |
4849
| Maximum Animals | Range: 1 - 128 <br>Default is **32** | The maximum number of passive mobs displayed on the radar - larger numbers may cause lag |
4950
| Maximum Ambient Creatures | Range: 1 - 128 <br>Default is **32** | The maximum number of ambient mobs displayed on the radar - larger numbers may cause lag |
5051
| Maximum Mobs | Range: 1 - 128 <br>Default is **32** | The maximum number of hostile mobs displayed on the radar - larger numbers may cause lag |

‎docs/en/client/settings/overview.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,10 @@ Folders**.
3535

3636
This is handy for moving your explored map and waypoints between
3737
computers, or for restoring them after reinstalling.
38+
39+
## **Open Folder**
40+
41+
The settings manager also has an **Open Folder** button, which opens
42+
JourneyMap's folder in your system file browser. This is the quickest
43+
way to reach `journeymap.log`, the `config` folder, or your waypoint
44+
files when backing them up or troubleshooting.

‎docs/en/client/settings/waypoint.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,13 @@ The **bold** toggle settings below are enabled by default.
2424
| **Display Death Waypoint Label <br>on map overlay** | Whether to show the name for death waypoints on your minimap and <br>full-screen map. |
2525
| **Double Click to Create** | Double clicking on the fullscreen map will create a waypoint at the location. |
2626

27-
!!! info "26.1 only"
27+
!!! info "26.1 and newer"
2828

2929
This category also has a **Show on Locator Bar** toggle, which shows
3030
waypoints on the vanilla locator bar above the hotbar. The locator
3131
bar is a Minecraft 1.21.6+ feature, so this option is only present in
32-
JourneyMap for Minecraft 26.1, not on the 1.21.1 line.
32+
JourneyMap for Minecraft 26.1 and newer (the 26.x line), not on the
33+
1.21.1 line.
3334

3435
## **Other Settings**
3536

‎docs/en/client/waypoint-groups.md‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,24 +62,31 @@ and provides these options:
6262
The **Settings** button opens the same
6363
[Waypoint Settings popup](waypoints.md#the-waypoint-settings-popup) used
6464
for individual waypoints - the Icon/Beacon/Label color table and the
65-
visibility toggles - applied to the group. In group mode it adds two
66-
extra checkboxes:
67-
68-
- **Override Colors** - when enabled, every waypoint in the group uses
69-
the group's colors and icon instead of its own.
65+
visibility toggles - applied to the group. In group mode it adds an
66+
**Override** checkbox to each color row, plus an **Override Settings**
67+
checkbox below the table:
68+
69+
- **Override** (one per color row - Icon, Icon Color, Beacon, Label) -
70+
when a row's Override is checked, every waypoint in the group uses the
71+
group's value for that row instead of its own. The **Icon** row covers
72+
the group's icon image, **Icon Color** the icon's color, and **Beacon**
73+
and **Label** those colors. Rows left unchecked let each waypoint keep
74+
its own, so you can override just the icon, just a color, or any
75+
combination.
7076
- **Override Settings** - when enabled, every waypoint in the group uses
7177
the group's visibility toggles instead of its own.
7278

73-
With both left off, each waypoint keeps its own colors and settings and
74-
the group's are ignored.
79+
With every override left off, each waypoint keeps its own colors and
80+
settings and the group's are ignored.
7581

7682
### Show on Locator Bar
7783

78-
!!! info "26.1 only"
84+
!!! info "26.1 and newer"
7985

8086
The locator bar is a Minecraft 1.21.6+ feature, so this option is
81-
only present in JourneyMap for Minecraft 26.1. It is not available
82-
on the 1.21.1 line.
87+
only present in JourneyMap for Minecraft 26.1 and newer (the 26.x
88+
line, including 26.2). It is not available on the 1.21.1 line
89+
(1.21.1 / 1.21.11).
8390

8491
**Show on Locator Bar** is one of the visibility toggles in the group's
8592
Settings popup. It shows the group's waypoints on the vanilla locator bar

‎docs/en/client/waypoints.md‎

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,15 @@ filters the list as you type.
5050
| New Group | Create a new waypoint group. |
5151
| Options | Open the [settings manager](settings/overview.md). |
5252
| Dimension | Filter the shown waypoints by dimension. |
53-
| Import | Import waypoints from a `.dat` file. |
54-
| Import External | Import waypoints from Xaero's Minimap, if detected. |
53+
| Import External | Import waypoints from Xaero's Minimap. **Only appears when Xaero's waypoints are detected** for your current world - see [Importing from Xaero's Minimap](#importing-from-xaeros-minimap). |
5554
| Export | Export your waypoints to a file (you choose the format). |
5655
| Pending | Review waypoints other players have shared with you. |
5756
| Close | Close the Waypoint Manager. |
5857

58+
To import or restore JourneyMap's own waypoint files (a dropped-in
59+
`.dat`, or a backup), see [Backups and Importing](#backups-and-importing)
60+
below - that is separate from the Import External button.
61+
5962
### Per-waypoint actions
6063

6164
Each waypoint in the list has these actions:
@@ -84,7 +87,10 @@ The editor provides these fields:
8487
- **Name** - the display name for the waypoint.
8588
- **Location** - the X, Y, and Z coordinates. You can switch between
8689
separate X / Y / Z fields and a single combined `X, Y, Z` field using
87-
the Coordinate Layout option (see below).
90+
the Coordinate Layout option (see below). A **Sync** checkbox next to
91+
the Y field, when enabled, fills the Y value from the cached surface
92+
height for that X/Z (if that chunk has been mapped), so the waypoint
93+
sits on the surface.
8894
- **Dimensions** - toggles for the dimensions the waypoint is shown in.
8995
- **Group** - the [group](#waypoint-groups) this waypoint belongs to.
9096
You can also create a new group from here.
@@ -121,16 +127,18 @@ which controls the waypoint's colors and where it is shown.
121127

122128
![Waypoint-Settings](../img/client/waypoint-settings.png){: .center}
123129

124-
**Colors.** The popup has a three-row color table - **Icon**, **Beacon**,
125-
and **Label**:
130+
**Colors.** The popup has a four-row color table - **Icon**,
131+
**Icon Color**, **Beacon**, and **Label**:
126132

127-
- Each row has a color picker. The Icon row also has an icon button for
128-
choosing the [icon](#waypoint-icons).
129-
- The Beacon and Label colors follow the Icon color until you set them
130-
individually, so by default all three match.
133+
- The **Icon** row has an icon button for choosing the
134+
[icon](#waypoint-icons), along with a color picker.
135+
- The **Icon Color**, **Beacon**, and **Label** rows each have a color
136+
picker for that element.
137+
- The Icon Color, Beacon, and Label colors follow the icon's color until
138+
you set them individually, so by default they match.
131139
- Each row's **Clear** button removes that color, drawing the element
132140
with no tint.
133-
- **Reset Colors** returns all three rows to the icon's color.
141+
- **Reset Colors** returns all rows to the icon's color.
134142

135143
**Visibility.** A column of checkboxes controls where the waypoint is
136144
shown:
@@ -146,7 +154,7 @@ shown:
146154
| Show on Locator Bar | Show the waypoint on the vanilla locator bar. |
147155

148156
The **Show on Locator Bar** toggle is only present in JourneyMap for
149-
Minecraft 26.1 (see [Show On Locator Bar](#show-on-locator-bar)).
157+
Minecraft 26.1 and newer (see [Show On Locator Bar](#show-on-locator-bar)).
150158

151159
## **Waypoint Groups**
152160

@@ -281,16 +289,40 @@ JourneyMap protects your waypoint data in several ways:
281289
- **Drop-in merge** - drop a waypoint `.dat` file into the waypoint
282290
folder and JourneyMap merges its waypoints into your existing data.
283291
Run `/jm reload`, or reconnect, to pick up files added while playing.
284-
- **Import from Xaero's** - if Xaero's Minimap waypoints are detected,
285-
the **Import External** button imports them.
292+
- **Import from Xaero's** - if Xaero's Minimap waypoints are detected for
293+
your current world, an **Import External** button appears in the
294+
Waypoint Manager. See [Importing from Xaero's Minimap](#importing-from-xaeros-minimap).
295+
296+
### Importing from Xaero's Minimap
297+
298+
JourneyMap can import waypoints from **Xaero's Minimap**, currently the
299+
only supported external source. The **Import External** button appears in
300+
the Waypoint Manager toolbar **only when** JourneyMap detects Xaero's
301+
waypoints for the world or server you are on; if there are none for the
302+
current world, the button is hidden.
303+
304+
![Import-Button](../img/client/waypoint-import.png){: .center}
305+
306+
Clicking it opens the **Import External Waypoints** screen, where you can
307+
review the detected waypoints and import them. JourneyMap reads Xaero's
308+
own data folder, matching by singleplayer world, server address, or
309+
Realm.
310+
311+
![Import-External-Waypoints](../img/client/waypoint-import-external.png){: .center}
312+
313+
This is separate from the
314+
[Import / Export data tools](settings/overview.md#import-export) and from
315+
the drop-in `.dat` merge above: those handle JourneyMap's own files,
316+
while this reads Xaero's.
286317

287318
## **Show On Locator Bar**
288319

289-
!!! info "26.1 only"
320+
!!! info "26.1 and newer"
290321

291322
The locator bar is a Minecraft 1.21.6+ feature, so this option is
292-
only present in JourneyMap for Minecraft 26.1. It is not available
293-
on the 1.21.1 line.
323+
only present in JourneyMap for Minecraft 26.1 and newer (the 26.x
324+
line, including 26.2). It is not available on the 1.21.1 line
325+
(1.21.1 / 1.21.11).
294326

295327
Waypoints can be shown on Minecraft's locator bar. This is controlled by
296328
a **Show On Locator Bar** option, available both globally and per

‎docs/en/img/client/automap.png‎

20 KB
Loading

0 commit comments

Comments
 (0)