PathFinderGPS

# 🧭 PathFinder GPS - Navigation Plugin for Minecraft **PathFinder GPS** is an intuitive navigation plugin that allows you to create destinations and custom visual routes using particles to guide players through your Minecraft world. --- ## ✨ Key Features - 🗺️ **Destination Creation** - Mark important locations in your world - 🛤️ **Custom Routes** - Create visual paths with waypoints - 🎨 **Customizable Particles** - Configure colors, types, and density - 🌍 **Multi-World Support** - Works across multiple worlds simultaneously - 🌐 **Multi-Language** - 5 languages included (EN, ES, PT, FR, IT) - 🔧 **Highly Configurable** - Customize every aspect of the plugin - 🎮 **Easy to Use** - Intuitive command system - 🔗 **Integration** - Compatible with DeluxeMenus, Citizens, ChestCommands, and more --- **Basic Tutorial** [Tutorial](https://www.youtube.com/watch?v=Nc2t7h-MOEg) --- ## 📦 Installation 1. Download the `PathFinder.jar` file 2. Place it in your server's `plugins/` folder 3. Restart the server 4. Done! The plugin is active **Requirements:** - Spigot, Paper, or Purpur server (1.21.8+) - Java 8 or higher --- ## 🚀 Quick Start ### Create a Destination ``` /path set # Get the tool (Diamond Shovel) [Right-click on a block] # Mark the location /path create Spawn # Create the destination ``` ### Navigate to a Destination ``` /path go Spawn # Navigate to the destination /path list # List all destinations ``` ### Create a Custom Route ``` /path ways create Spawn # Start waypoint session [Right-click to mark points] # Mark waypoints (from start to finish) /path ways Spawn save north_route # Save the route ``` --- ## 🎯 Navigation Modes ### Follow (Follow Route) ``` /path go Spawn follow ``` Follows the waypoint route closest to the player. ### NoFollow (Straight Line) ``` /path go Spawn nofollow ``` Generates a direct straight line ignoring routes. ### Mix (Hybrid) ``` /path go Spawn mix ``` Straight line to the first waypoint, then follows the route. ### Force Specific Route ``` /path go Spawn follow north_route /path go Spawn mix south_route ``` ### For Other Players ``` /path go Spawn follow Steve /path go Spawn mix Alex north_route ``` --- ## 🎨 Visual Customization ### Change Particles ```yaml particles: navigation_line_particle: "FLAME" # Fire effect # DUST, FLAME, HEART, VILLAGER_HAPPY, PORTAL, END_ROD, etc. ``` ### Custom Colors (DUST only) ```yaml colors: distance_colors: close: [255, 0, 0] # Bright red medium: [255, 165, 0] # Orange far: [0, 255, 0] # Green very_far: [0, 100, 255] # Blue ``` --- ## 🔑 Main Commands | Command | Description | |---------|-------------| | `/path set` | Get the tool to mark destinations | | `/path create ` | Create a destination at the marked location | | `/path go ` | Navigate to a destination | | `/path list` | Show all available destinations | | `/path delete ` | Delete a destination and its routes | | `/path ways create ` | Start route creation with waypoints | | `/path ways save ` | Save the created route | | `/path ways undo` | Undo the last waypoint | | `/path reload` | Reload the configuration | | `/path lang ` | Change language (en, es, pt, fr, it) | **Aliases:** `/path`, `/pathfinder`, `/pf` --- ## 🔐 Permissions | Permission | Description | Default | |---------|-------------|---------| | `pathfinder.*` | Full access | OP | | `pathfinder.use` | Navigate to destinations | Everyone | | `pathfinder.list` | View destination list | Everyone | | `pathfinder.set` | Get GPS tool | OP | | `pathfinder.create` | Create destinations and routes | OP | | `pathfinder.delete` | Delete destinations | OP | | `pathfinder.admin` | Management and control other players | OP | --- ## 🔗 Integration with Other Plugins PathFinder supports the `%player%` placeholder for integration: ### DeluxeMenus ```yaml spawn_button: left_click_commands: - '[console] path go Spawn follow %player%' ``` ### Citizens (NPCs) ``` /npc command add path go Spawn follow %player% ``` ### ChestCommands ```yaml spawn-button: COMMAND: 'console: path go Spawn follow %player%' ``` **Compatible with:** DeluxeMenus, Citizens, ChestCommands, CommandPanels, MyCommand, BossShopPro, and more. --- ## 🌐 Available Languages - 🇺🇸 English (`en`) - 🇪🇸 Español (`es`) - 🇧🇷 Português (`pt`) - 🇫🇷 Français (`fr`) - 🇮🇹 Italiano (`it`) Change language with `/path lang ` or edit `config.yml` --- ## 💡 Usage Examples ### Survival Server ``` # Create main destinations /path set [Click] /path create Spawn [Click] /path create CommunityShop [Click] /path create PublicFarm # Create safe route /path ways create Spawn [Mark waypoints] /path ways Spawn save main_route ``` ### Tutorial System with NPCs ``` # Guide NPC /npc create Guide /npc command add path go Spawn follow %player% ``` ### Navigation Menu ```yaml # DeluxeMenus spawn: material: COMPASS left_click_commands: - '[console] path go Spawn follow %player%' - '[message] &aNavigation activated!' ``` --- ## ❓ Frequently Asked Questions **Are routes necessary?** No, destinations work without routes. PathFinder will automatically generate a straight line. **In what direction do I mark waypoints?** From start to finish: From the beginning of the route towards the destination. **How many waypoints can I use?** 30 by default, configurable in `config.yml` (recommended maximum: 100). **Does it work across multiple worlds?** Yes, but you can only navigate to destinations in the same world you're in. **How do I stop navigation?** Navigation stops automatically when reaching the destination, changing worlds, or disconnecting. --- ## 📄 License This project is licensed under the MIT License. --- ## 💬 Support - **Full Documentation**: [GitHub Wiki](https://github.com/GabichiGG-DEV/PathFinder/wiki) - **Report Issues**: [GitHub Issues](https://github.com/GabichiGG-DEV/PathFinder/issues) --- **Made with ❤️ by GabichiGG**