Journey Client

Journey Client

Journey Client is an optional companion mod that enhances the player experience with HUDs, rendering features, and visual enhancements. Journey works perfectly without it, but installing Journey Client provides players with a richer visual experience.

Client-Side Only

Journey Client is completely optional and only needs to be installed on player clients. The server does not require it.

---

Installation

1. Download Journey Client from the same source as Journey Server
2. Place the .jar file in your client’s mods/ folder
3. Launch Minecraft with Fabric/Forge (matching your server)
4. Join your Journey server

Requirements:

• Same Minecraft version as the server
• Same mod loader (Fabric/Forge) as the server
• Journey Client version must match Journey Server version

---

Features Overview

Party HUD

Real-time party member display with health, armor, hunger, and Pokémon teams

Global Task HUD

Server-wide task progress tracking with contributor counts

Zone Rendering

Visual zone boundaries rendered in-world with configurable colors

Path Rendering

Visualize NPC patrol paths and edit them in real-time

Levelable XP HUD

XP progress ribbon with level-up animations

Buff Display

Buff icons with duration timers and tooltips

Notifications

Toast notifications and announcement banners

Objective Rendering

Quest markers as beacons and HUD indicators

---

Party HUD

Display real-time information about your party members.

Features

• Player Faces - Rendered from player skins
• Health Display - Hearts, bars, or both with status effects
• Armor & Hunger - Optional display toggles
• Dimension Indicators - Shows which dimension members are in
• Distance Display - How far away party members are
• Pokémon Teams - See party members’ Pokémon
• Offline Members - Shown in grey when disconnected
• Status Effects - Poisoned, withered, frozen, absorbing hearts
• Compact Display - Health over 20 shown as 10 hearts + bonus

Configuration Commands

# Toggle Features
/journeyclient party toggle                   # Enable/disable party HUD
/journeyclient party armor                    # Toggle armor display
/journeyclient party hunger                   # Toggle hunger display
/journeyclient party distance                 # Toggle distance display
/journeyclient party dimension                # Toggle dimension indicator

# Appearance
/journeyclient party healthstyle <mode>       # hearts/bar/both
/journeyclient party anchor <position>        # top-left/top-right/bottom-left/bottom-right
/journeyclient party scale <value>            # 0.1-3.0
/journeyclient party offset <x> <y>           # Position offset

# Info
/journeyclient party info                     # Show current settings

Health Display Modes

Hearts Mode:

• Classic heart display
• Shows all status types (poison, wither, frozen, absorption)
• Absorption hearts shown as yellow hearts
• Compact display for health over 20

Bar Mode:

• Horizontal health bar
• Color-coded based on health percentage
• Shows exact HP numbers

Both Mode:

• Hearts above health bar
• Best of both display styles

---

Global Task HUD

Track server-wide task progress in real-time.

Features

• Server-wide task progress tracking
• Real-time updates when players contribute
• Contributor count display
• Personal contribution tracking
• Compact mode option
• Configurable position and scale

Configuration Commands

/journeyclient globaltask toggle              # Enable/disable
/journeyclient globaltask compact             # Compact mode
/journeyclient globaltask position <x> <y>    # Set position
/journeyclient globaltask scale <scale>       # Adjust scale

Display Information

Normal Mode:

• Task name and description
• Progress bar with percentage
• Current progress / target progress
• Active contributor count
• Your personal contribution
• Top contributors leaderboard

Compact Mode:

• Task name only
• Minimal progress bar
• Contributor count
• Takes up less screen space

---

Zone Rendering

Visualize zone boundaries in-world.

Features

• Visual zone boundaries rendered in 3D
• Different colors based on zone type
• Configurable opacity and fade distances
• Toggle zones on/off
• Distance-based fading
• No FPS impact when far away

Configuration Commands

/journeyclient zone toggle                    # Enable/disable
/journeyclient zone opacity <value>           # Base opacity (0.0-1.0)
/journeyclient zone fadestart <distance>      # Fade start distance
/journeyclient zone fadeend <distance>        # Fade end distance

Performance

• Distance culling - Zones far away aren’t rendered
• Frustum culling - Off-screen zones aren’t rendered
• Configurable render distance - Adjust based on your PC
• Minimal FPS impact - Optimized rendering

---

Path Rendering

Visualize and edit NPC patrol paths.

Features

• Preview NPC patrol paths before assigning
• Real-time path editor (press Z to toggle)
• See waypoints and wait points
• Path visualization with Journey Client
• Edit paths in-game with GUI

Configuration Commands

/journeyclient editmode path                  # Toggle path edit mode

Path Editor Controls

When path edit mode is enabled:

1. Look at an NPC to see its assigned path
2. Waypoints shown as glowing markers
3. Wait points shown with timer indicators
4. Click waypoints to edit properties
5. Press Z to exit edit mode

---

Levelable XP HUD

XP progress display replacing boss bars.

Features

• XP progress ribbon at top of screen
• Level-up animations with particles
• XP gain popups with fade effects
• Configurable position
• Shows current level and progress to next

Configuration Commands

/journeyclient levelable position <x> <y>     # Set ribbon position
/journeyclient levelable scale <scale>        # Adjust scale
/journeyclient levelable toggle               # Enable/disable

Display Information

• Current levelable name
• Current level
• XP bar showing progress to next level
• XP gain notifications (“+50 XP” popups)
• Level-up celebration animations

---

Buff Display

Show active buffs with icons and timers.

Features

• Buff icons with duration timers
• Scrollable buff list
• Tooltip with buff details on hover
• Shows in-game and in inventory
• Color-coded based on buff type
• Hidden buffs not displayed

Display Information

Buff Icon:

• Custom icon from buff configuration
• Stack count (if stackable)
• Duration remaining (MM:SS format)
• Permanent buffs show ”∞”

Tooltip:

• Buff name
• Buff description
• Amplifier level
• Duration remaining
• Source (if applicable)

---

Notification System

Toast notifications and announcement banners.

Features

• Toast Notifications - Small notifications in corner
• Announcement Banners - Large center-screen announcements
• Action Buttons - Click to accept/decline actions
• Multiple Notifications - Display several at once
• Auto-dismiss - Fade out after duration

Notification Types

Toast Notifications:

• Quest completion
• Task progress
• Party invites (with Accept/Decline buttons)
• Global task updates
• Levelable level-ups

Announcement Banners:

• Major achievements
• Server-wide events
• Global task completions
• Special announcements

---

Objective Rendering

Quest markers and objective indicators.

Features

• Beacons - Vertical beams marking quest locations
• HUD Markers - On-screen indicators showing direction
• Distance Display - How far away objectives are
• Color Coding - Different colors for different quest types
• Toggle Options - Enable/disable beacons and markers separately

Configuration Commands

/journeyclient objective beacons              # Toggle beacons
/journeyclient objective markers              # Toggle HUD markers

Marker Types

Active Objective:

• Yellow beacon
• ”!” icon on HUD
• Shows distance and direction

Optional Objective:

• Blue beacon
• ”?” icon on HUD
• Can be ignored

Quest Turn-In:

• Green beacon
• ”✓” icon on HUD
• Quest ready to complete

---

Performance

Journey Client is optimized for minimal performance impact:

Optimizations

• Distance Culling - Far objects not rendered
• Frustum Culling - Off-screen objects not rendered
• Configurable Render Distances - Adjust per feature
• Efficient Change Detection - Only updates when needed
• Reduced Network Traffic - Batched updates
• Fast Update Interval - 0.25 second sync for responsive feel

Performance Tips

If experiencing FPS drops:

1. Reduce zone render distance
2. Disable zone rendering in crowded areas
3. Use compact mode for Global Task HUD
4. Lower particle counts in buff displays
5. Disable path rendering when not editing

Recommended Settings:

• Zone opacity: 0.3-0.5
• Zone fade start: 32 blocks
• Zone fade end: 64 blocks
• HUD scale: 1.0 (default)
• Objective render distance: 128 blocks

---

Configuration Files

Journey Client stores configuration client-side:

Location: .minecraft/config/journey-client/

Files:

• party_hud.json - Party HUD settings
• global_task_hud.json - Global task HUD settings
• zone_rendering.json - Zone render settings
• objective_rendering.json - Objective render settings
• levelable_hud.json - Levelable XP HUD settings
• buff_display.json - Buff display settings

Manual Editing

While you can manually edit these files, it’s recommended to use in-game commands to avoid syntax errors.

---

Complete Command Reference

Party HUD

/journeyclient party toggle
/journeyclient party healthstyle <hearts|bar|both>
/journeyclient party anchor <top-left|top-right|bottom-left|bottom-right>
/journeyclient party scale <0.1-3.0>
/journeyclient party offset <x> <y>
/journeyclient party armor
/journeyclient party hunger
/journeyclient party distance
/journeyclient party dimension
/journeyclient party info

Global Task HUD

/journeyclient globaltask toggle
/journeyclient globaltask compact
/journeyclient globaltask position <x> <y>
/journeyclient globaltask scale <scale>

Zone Rendering

/journeyclient zone toggle
/journeyclient zone opacity <0.0-1.0>
/journeyclient zone fadestart <distance>
/journeyclient zone fadeend <distance>

Objective Rendering

/journeyclient objective beacons
/journeyclient objective markers

Edit Modes

/journeyclient editmode path
/journeyclient editmode zone

---

Troubleshooting

Journey Client Not Loading

Check:

1. Journey Client version matches Journey Server version
2. Mod is in the correct mods/ folder
3. Mod loader (Fabric/Forge) matches server
4. No conflicting mods installed
5. Check logs for errors

HUDs Not Showing

Check:

1. Feature is enabled (/journeyclient <feature> toggle)
2. You’re in a party (for Party HUD)
3. Global task is active (for Global Task HUD)
4. HUD position is on-screen (not off-screen)
5. Scale is not set to 0

Party HUD Shows ”???”

Causes:

• Party member is offline
• Party member is on different server (dimension shown instead)
• Network sync delay (wait 0.25 seconds)

Performance Issues

Solutions:

1. Reduce render distances
2. Disable unused features
3. Lower opacity values
4. Use compact modes
5. Allocate more RAM to Minecraft

Zone Rendering Not Working

Check:

1. Zone rendering is enabled
2. You’re inside or near a zone
3. Zone opacity is not 0.0
4. Server has Journey zones configured

---

Related Systems

• Party System - Create parties to use Party HUD
• Global Tasks - Activate global tasks to use Global Task HUD
• Zones - Create zones to visualize
• NPC Paths - Create NPC paths to edit
• Buffs - Buffs display in Buff HUD
• Levelables - Track XP in Levelable HUD