JWaypoints - Advanced Minecraft Waypoint Plugin

Plugin Overview

JWaypoints revolutionizes Minecraft navigation with stunning 3D arrows, intelligent guidance systems, and seamless user experience across all server types.

🎯

3D Arrow Navigation

Beautiful floating arrow art with multiple design patterns including spiral, zigzag, and static modes that guide you directly to your destination.

🧭

Smart Guidance System

Automatically switches to action bar compass when arrows are blocked, ensuring uninterrupted navigation in any terrain.

🎨

Customizable Experience

Choose from multiple arrow designs, arrival sounds, particle effects, and personalize every aspect of your navigation.

📊

Real-time Distance

Live distance display using your XP bar with visual progress indicators showing your journey to the destination.

🔄

Waypoint Sharing

Share your favorite locations with friends and teammates for collaborative exploration and building projects.

🎮

Intuitive GUI

User-friendly graphical interface for managing waypoints, settings, and preferences without complex commands.

💡 Pro Tip: JWaypoints works seamlessly in both single-player and multiplayer environments, with extensive server-wide configuration options for administrators.

🚀
Key Highlights

Minecraft 1.21+ Compatible: Fully updated for the latest Minecraft versions with modern features
Performance Optimized: Lightweight design with minimal server impact and efficient resource usage
Highly Configurable: Extensive customization options for server administrators and players
Multi-World Support: Works seamlessly across different dimensions and custom worlds
Permission-Based: Granular permission system for different player groups and roles
Database Integration: Persistent waypoint storage with automatic backups and data protection

Installation & Setup

Get JWaypoints up and running on your server in just a few simple steps.

📋
System Requirements

Minecraft Server 1.21 or higher
Bukkit/Spigot/Paper server software
Java 17 or higher
At least 50MB free RAM
Write permissions for plugin directory

🔧
Installation Steps

1. Download: Get the latest JWaypoints.jar from our official releases page

📦

GitHub

Official Releases

⬇️

Modrinth

Plugin Repository

2. Install: Place the JAR file in your server's plugins/ folder

3. Start: Start or restart your Minecraft server to initialize the plugin

4. Configure: Edit plugins/JWaypoints/config.yml if needed

5. Test: Join the server and try /waypoint help to verify installation

✅ Installation Complete! If you see the JWaypoints help menu, the plugin is successfully installed and ready to use.

🎯
Quick Start Tutorial

Create your first waypoint and start navigating:

/waypoint set home

This creates your first waypoint at your current location!

/waypoint activate home

This displays a beautiful 3D arrow pointing to your home waypoint.

/waypoint gui

Opens the user-friendly interface for managing all your waypoints and settings.

💡 New Player Tip: Use the GUI interface for the most intuitive waypoint management experience. All features are accessible through both commands and the graphical interface.

Commands Reference

Complete reference for all JWaypoints commands and their usage.

🎯
Basic Waypoint Commands

/waypoint set <name> [x y z]

Create a new waypoint at your current location or specified coordinates.

Examples:

/waypoint set home - Creates waypoint at current location
/waypoint set mine 100 64 -200 - Creates waypoint at specific coordinates

/waypoint remove <name>

Delete a waypoint (requires confirmation for safety).

/waypoint activate <name>

Start following a waypoint with 3D arrow guidance.

/waypoint deactivate

Stop following the current waypoint and hide guidance.

🖥️
Interface Commands

/waypoint gui

Open the main waypoint management interface.

/waypoint list

Display all your waypoints in a formatted list.

/waypoint current

Show information about your currently active waypoint.

⚙️
Customization Commands

/waypoint design <name>

Change your arrow design: standard, diamond, gold, emerald, redstone

/waypoint sound <name>

Change arrival sound effect: levelup, bell, firework, portal

/waypoint particle <name>

Change arrival particle effect: FIREWORK, FLAME, HEART, SOUL

/waypoint distance

Toggle distance display in your XP bar while navigating.

🤝
Sharing Commands

/waypoint share <waypoint> <player>

Share a waypoint with another player.

Example: /waypoint share home Steve

💡 Command Aliases: You can use /wp instead of /waypoint for faster typing! All commands support tab completion for easier usage.

📚
Complete Command Reference

Quick reference for all available commands:

/waypoint set <name> [x y z] - Create waypoints
/waypoint remove <name> - Delete waypoints (with confirmation)
/waypoint activate <name> - Start navigation
/waypoint deactivate - Stop navigation
/waypoint list or /waypoint gui - Open interface
/waypoint current - Show active waypoint details
/waypoint share <waypoint> <player> - Share waypoints
/waypoint design <name> - Change arrow appearance
/waypoint sound <name> - Change arrival sounds
/waypoint particle <name> - Change arrival particles
/waypoint distance - Toggle XP bar distance display
/waypoint guidance - Toggle guidance switch messages
/waypoint silent - Toggle complete silent mode
/waypoint nosound - Toggle sounds only
/waypoint noparticles - Toggle particles only
/waypoint confirm - Confirm pending deletions
/waypoint cancel - Cancel pending operations
/waypoint updatecheck - Check for updates (admin)

Feature Showcase

Explore the advanced features that make JWaypoints the ultimate navigation solution.

🎯
3D Arrow Navigation System

JWaypoints features a sophisticated 3D arrow guidance system with multiple visual patterns:

🔺

Standard Pattern

Clean, professional arrow design perfect for everyday navigation with pointed arrowhead and stabilizing fins.

🌀

Spiral Pattern

Mesmerizing rotating spiral effect that catches the eye, perfect for marking important destinations.

⚡

Zigzag Pattern

Dynamic zigzag motion creating an energetic, eye-catching navigation experience.

💎

Static Arrow

Elegant, non-animated arrow for players who prefer minimal distractions while navigating.

🧭
Intelligent Guidance Switching

When your 3D arrow becomes blocked by terrain or structures, JWaypoints automatically switches to action bar compass guidance:

Example Action Bar: ➡ Right | ⬆ Up | 🎯 45.2m

Directional Arrows: ⬆ ⬇ ⬅ ➡ show horizontal direction
Vertical Guidance: Shows "Up" or "Down" for elevation changes
Real-time Distance: Precise distance measurement in meters
Automatic Switching: Seamlessly returns to 3D arrows when clear

🎨
Customization Options

Arrow Designs

Standard: Lime concrete with yellow/red accents
Diamond: Diamond blocks with blue accents and glowing effect
Gold: Gold blocks with flame particles and spiral pattern
Emerald: Emerald blocks with villager particles and static design
Redstone: Redstone blocks with redstone particles and zigzag motion

🔔

Arrival Sounds

Choose from level up chimes, bell sounds, firework explosions, portal sounds, and many more!

✨

Particle Effects

Fireworks, flames, hearts, souls, enchantment effects, and dozens of other visual celebrations!

⚠️ Server Setting: Waypoint sharing can be disabled by server administrators in the configuration file for security purposes.

Changelog

Track the latest updates, features, and improvements to JWaypoints.

🧭
Version 1.7 — Icons Update!

✨ New Features Released! This update brings custom icon support and hex color formatting to make your waypoints truly unique.

🎨 Custom Waypoint Icons

Set custom icons for your waypoints to easily identify them at a glance.

Use /waypoint seticon to assign any icon you like
Permission: jwaypoints.icon
Explore a wide range of icon suggestions organized by category using: /waypoint icons
Categories include: 🏠 Home ⛏️ Mining 🌾 Farming ⚔️ Combat 💰 Trading 🧭 Exploration …and more!
Icons now appear directly in the waypoint GUI for quick visual recognition

🏠

Home Base

RED_BED

⛏️

Mining Area

DIAMOND_PICKAXE

🧭

Exploration

COMPASS

🌈 Hex Color Support

Bring your creativity to life with full RGB hex color support for all text formatting!

Use the &#RRGGBB format anywhere you could use legacy color codes.

# Customize your message prefix
&#FF5733[Waypoints]:

# Create stunning GUI titles with gradients
�FF00⭐ &#FFFFFFWaypoints �FF00⭐

# Mix legacy & hex colors freely
                        

💡 Pro Tip: Mix legacy and hex colors freely for maximum customization potential!

🔧
Fixes & Improvements

⚙️ Configuration System Overhaul

A complete revamp to make configuration smoother and more reliable.

✅

Reload Command

Fixed: /waypoint reload now correctly reloads all configuration values

✅

Message Prefix

Fixed: Message prefix now reads properly from config.yml

✅

Performance Settings

Fixed: Performance settings (arrow_update_ticks, distance_update_ticks) are now configurable

✅

GUI Customization

Fixed: GUI title customization now applies correctly

✅

Arrow Appearance

Fixed: Arrow appearance settings update properly on reload

GUI User Guide

Master the intuitive graphical interface for effortless waypoint management.

📋
Main Waypoint Interface

Access with /waypoint gui or /waypoint list

🧭

Waypoint Items

Left-click: Activate navigation
Right-click: Delete with confirmation
Shift-click: Edit properties

⚙️

Settings Menu

Comparator icon opens the settings menu for customizing your entire navigation experience.

❌

Interface Controls

Barrier block closes the interface, with intuitive navigation throughout all menus.

✏️
Waypoint Editor

Access by shift-clicking any waypoint in the main GUI.

🏷️ Name Tag: Rename your waypoint with custom titles
🧭 Compass: Change coordinates manually with precision
🔮 Ender Pearl: Move waypoint to your current location instantly
💣 TNT: Delete waypoint with safety confirmation
⬅️ Arrow: Return to main waypoint list seamlessly

💡 Pro Tip: All GUI actions have command equivalents, so you can use whichever method feels most comfortable for your playstyle!

Permission System

Granular permission control for server administrators and different player groups.

Permission Node	Description	Default
`jwaypoints.use`	Access to basic waypoint commands	true
`jwaypoints.set`	Create new waypoints	true
`jwaypoints.remove`	Delete existing waypoints	true
`jwaypoints.activate`	Activate waypoint navigation	true
`jwaypoints.gui`	Access waypoint GUI interface	true
`jwaypoints.share`	Share waypoints with other players	true
`jwaypoints.design`	Change arrow designs and effects	true
`jwaypoints.bypass.limit`	Bypass waypoint count limits	op

🆕

New Players

Basic permissions for newcomers:

jwaypoints.use
jwaypoints.set
jwaypoints.activate
jwaypoints.gui

👤

Regular Members

Full access except admin features:

All basic permissions
jwaypoints.share
jwaypoints.design
jwaypoints.sound
jwaypoints.particles

👑

VIP/Donors

Premium features and bypass limits:

All member permissions
jwaypoints.bypass.limit
Unlimited waypoints

⚠️ Important: The jwaypoints.bypass.limit permission is only for operators by default. Grant it carefully to avoid database bloat.

Server Configuration

Comprehensive configuration options for server administrators and advanced users.

🎯
Arrow Appearance Settings

arrow:
  height: 3.0              # Height above player (blocks)
  spacing: 0.4             # Space between arrow parts
  forward_offset: 2.0      # Distance in front of player
  default_material: "LIME_CONCRETE"
  head_material: "YELLOW_CONCRETE"
  tail_material: "RED_CONCRETE"
                        

🎮
Plugin Settings

settings:
  allow_sharing: true      # Enable waypoint sharing
  waypoint_limit: 10       # Max waypoints per player
  distance_display_default: true  # Default distance display
                        

🎨
Custom Arrow Designs

Create custom arrow designs by adding new sections:

designs:
  custom_design:
    main_material: "NETHERITE_BLOCK"
    head_material: "DIAMOND_BLOCK"
    tail_material: "GOLD_BLOCK"
    glowing: true
    particle_effect: "ENCHANT"
    pattern_type: 1
                        

💡 Reload Tip: After changing the config, restart the server or use a plugin manager to reload JWaypoints for changes to take effect.

API Documentation

Developer resources and API reference for integrating JWaypoints into your plugins.

🚧

Coming Soon

We're working hard to bring you comprehensive API documentation for JWaypoints. This will include detailed integration guides, code examples, and everything you need to build amazing waypoint features into your own plugins.

⏳ In Development

📖

JavaDoc Reference

Complete method documentation with examples and best practices

🔧

Integration Guide

Step-by-step tutorials for adding JWaypoints to your projects

💻

Code Examples

Ready-to-use code snippets and implementation patterns

🎯

Event System

Listen to waypoint events and create custom behaviors

🔬
Stay Updated

Want to be notified when the API documentation is ready? Here's how to stay in the loop:

⭐ Star our GitHub repository to get notified about new releases
👀 Watch the repository for development updates and announcements
💬 Join our Discord for real-time updates and developer discussions
📧 Follow our releases for immediate notifications when API docs are published

📢 Developer Preview: If you're interested in early access to the API documentation, please reach out to J2D on GitHub or Discord. We're happy to work with developers who want to integrate JWaypoints into their projects.

Support & Troubleshooting

Solutions for common issues and guidance for getting help when you need it.

🚫

Permission Errors

Solution: Ensure players have jwaypoints.use permission. Check your permission plugin configuration.

/lp user <player> permission set jwaypoints.use true

👻

Invisible Arrows

Solution: Arrows may be blocked by terrain. Move to open area and reactivate, or adjust arrow height in config.

💾

Data Not Saving

Solution: Check file permissions, disk space, and server console for I/O errors in the plugin directory.

📞
Getting Additional Help

📖

Documentation

Check this wiki first for comprehensive answers and configuration guidance.

🛠️

Bug Reports

Report issues on GitHub with detailed reproduction steps and system information.

💡

Feature Requests

Suggest improvements and new features through our GitHub repository.

✅ Quick Troubleshooting Checklist:

Verify player permissions are correctly configured
Check that plugin is enabled and running latest version
Review server console for any error messages
Test with minimal plugin setup to isolate conflicts
Validate config.yml syntax and structure