# FlyCraft – Official Documentation<\/p>\n
## Overview<\/p>\n
FlyCraft is a lightweight and powerful flight management plugin for Minecraft servers. It allows players to toggle flight mode, adjust flight speed, and integrate with Discord for remote management. With built-in metrics, update checking, and LuckPerms integration, it provides a complete flight control solution for your server.<\/p>\n
—<\/p>\n
## 1. Core Features<\/p>\n
– **Toggle Flight Mode** \u2013 Enable or disable flight for players
\n– **Configurable Flight Duration** \u2013 Set limits on flight time
\n– **Customizable Cooldown System** \u2013 Prevents excessive flight toggling
\n– **Adjustable Fly Speed** \u2013 Speed levels from 1 (slowest) to 10 (fastest)
\n– **Group-Based Permissions** \u2013 Group system with LuckPerms integration
\n – Automatic group detection
\n – Group-specific settings
\n – Inherited permissions support
\n– **Speed Restrictions** \u2013 Set maximum allowed speed per group
\n– **Welcome Messages** \u2013 Display a message to new players
\n– **Full Discord Integration** \u2013 Manage flights via Discord commands
\n– **Update Checker** \u2013 Automatic version checking
\n– **Discord Notifications** \u2013 Real-time flight activity tracking
\n– **Multi-Language Support** \u2013 Dedicated language files in `lang\/` folder
\n– **Next-Gen Config Engine** \u2013 Comment-preserving automated updates and migrations
\n– **LuckPerms Integration** \u2013 Seamless group-based permission management
\n– **Folia Support** \u2013 Full support for Folia and modern server architectures<\/p>\n
—<\/p>\n
## 2. Commands<\/p>\n
### 2.1 In-Game Commands<\/p>\n
| Command | Description | Permission | Aliases |
\n| —————— | ——————————- | ——————- | —————— |
\n| `\/fly [player]` | Toggle flying mode | `flycraft.use` | `flymode` |
\n| `\/flyspeed <1-10>` | Adjust flying speed | `flycraft.flyspeed` | N\/A |
\n| `\/flycraftreload` | Reload the plugin configuration | `flycraft.reload` | `fcr`, `flyreload` |<\/p>\n
**Notes:**<\/p>\n
– Using `\/fly [player]` requires additional `flycraft.others` permission
\n– `\/flyspeed` requires both `flycraft.flyspeed` and appropriate `flycraft.maxflyspeed.<1-10>` permission
\n– Fly speed is adjustable from **1 (slowest) to 10 (fastest)**
\n– Players can only set speeds up to their maximum allowed speed permission<\/p>\n
### 2.2 Discord Commands<\/p>\n
| Command | Description | Requirements | —<\/p>\n ## 3. Permissions<\/p>\n ### 3.1 Basic Permissions<\/p>\n | Permission | Description | Default | ### 3.2 Speed Control Permissions<\/p>\n | Permission | Description | Default | ### 3.3 Permission Groups<\/p>\n | Permission | Description | Includes | —<\/p>\n ## 4. Permission Systems<\/p>\n ### 4.1 Basic Permissions (All Permission Plugins)<\/p>\n If you’re using any permission plugin other than LuckPerms (like PermissionsEx, GroupManager, etc.), use these basic permissions to control access:<\/p>\n – `flycraft.use` – Allow flight ### 4.2 Group System (LuckPerms Only)<\/p>\n FlyCraft includes a powerful group-based permission system that works exclusively with LuckPerms. When LuckPerms is installed, the plugin will automatically use group settings from `groups.yml` based on the player’s LuckPerms groups. If LuckPerms is not installed, the plugin will fall back to using the basic permission system.<\/p>\n ### 4.1 Group Configuration (`groups.yml`)<\/p>\n “`yaml vip: mvp: admin: ### 4.2 Group Settings<\/p>\n | Setting | Description | Default | ### 4.3 Group System Features (LuckPerms Only)<\/p>\n – **LuckPerms Integration**: Automatically detects player groups **Important Note**: The group system requires LuckPerms to be installed and enabled on your server. If you’re using a different permission plugin, please use the basic permissions system described in section 4.1.<\/p>\n —<\/p>\n ## 5. Configuration (`config.yml`)<\/p>\n ### 4.1 General Settings<\/p>\n “`yaml # Language Settings # Flight Settings ### 4.2 Discord Integration<\/p>\n “`yaml ### 4.3 Bot Activity Settings<\/p>\n “`yaml —<\/p>\n ## 8. Discord Features<\/p>\n ### 5.1 Notifications<\/p>\n – Flight start\/stop alerts ### 5.2 Message Formatting<\/p>\n – Supports **custom emojis** —<\/p>\n ## 6. Time Formatting<\/p>\n FlyCraft automatically formats time periods for maximum clarity:<\/p>\n – `25 seconds` —<\/p>\n ## 7. Multi-Language System<\/p>\n FlyCraft now supports a robust multi-language system. All user-facing strings are handled via dedicated files in the `plugins\/FlyCraft\/lang\/` directory.<\/p>\n ### 7.1 Key Features<\/p>\n – **Official Languages**: Official files (like `en_us.yml`) are automatically updated with new keys when the plugin evolves. ### 7.2 Changing Language<\/p>\n To change the plugin’s language, edit the `language` option in `config.yml`:<\/p>\n “`yaml —<\/p>\n ## 9. Dependencies<\/p>\n ### Required<\/p>\n – **Minecraft Server:** Spigot\/Paper **1.16+** ### Optional (For Enhanced Features)<\/p>\n – **PlaceholderAPI** \u2013 Dynamic placeholders support ## 10. PlaceholderAPI Support<\/p>\n FlyCraft fully supports PlaceholderAPI, allowing you to display flight information in scoreboards, chat, tab lists, and menus.<\/p>\n ### 8.1 Global Placeholders<\/p>\n | Placeholder | Description | ### 8.2 Player Placeholders<\/p>\n | Placeholder | Description | ### 8.3 Specific Player Placeholders<\/p>\n Replace ` —<\/p>\n ## 11. Technical Features<\/p>\n – **Next-Gen Migration Engine** \u2013 Comment-preserving automated updates —<\/p>\n ## 12. Messages<\/p>\n All messages are customizable in the relevant language file within the `lang\/` folder:<\/p>\n – **Default file**: `lang\/en_us.yml` —<\/p>\n ## 13. Safety Features<\/p>\n – **Permission Checks** \u2013 Ensures players have the correct permissions —<\/p>\n ## 14. Development Information<\/p>\n – **API Version:** 1.16 —<\/p>\n ## Installation Guide<\/p>\n 1. **Download FlyCraft v1.4** from the official repository. —<\/p>\n ## Support<\/p>\n For help, feature requests, or bug reports:<\/p>\n – **GitHub Issues** \u2013 [[Link to Repository]](https:\/\/github.com\/qborhani\/FlyCraft) —<\/p>\n ## License<\/p>\n License – Proper credit is given to the original author (Borhani). For full license details, see: GNU GPL v3.<\/p>\n —<\/p>\n ## Credits<\/p>\n Developed by **Aevorin Studios**.<\/p>\n —<\/p>\n","protected":false},"excerpt":{"rendered":" Advanced \/fly plugin for your minecraft server!<\/p>\n","protected":false},"featured_media":71503,"template":"","meta":{"_minecraft_slug":"flycraft","_minecraft_project_id":"CWMrVT99","_minecraft_author":"aiversity","_minecraft_license":"GPL-3.0-only","_minecraft_downloads":1897,"_minecraft_follows":3,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"flycraft.zip","_minecraft_size_bytes":4596626,"_minecraft_version_count":16,"_minecraft_updated_at":"2026-05-16T06:30:07.157126Z","_minecraft_date_created":"2024-07-27T20:27:30.045716Z","_minecraft_date_modified":"2026-03-14T18:12:00.616710Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/flycraft","_minecraft_icon_attachment_id":71503,"_minecraft_imported_at":"2026-06-04T01:30:44+00:00","_minecraft_import_hash":"0b57bb204d17dba71f78142ac5783789","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,125,127,128,129,92],"mod_loader":[130,131,132,133,134],"minecraft_version":[438,446,449,110,111,112,113,114,115,116,117,118,119,120,46,47,48,49,50,51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-71502","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-folia","mod_category-paper","mod_category-purpur","mod_category-spigot","mod_category-utility","mod_loader-bukkit","mod_loader-folia","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-13","minecraft_version-1-13-1","minecraft_version-1-13-2","minecraft_version-1-14","minecraft_version-1-14-1","minecraft_version-1-14-2","minecraft_version-1-14-3","minecraft_version-1-14-4","minecraft_version-1-15","minecraft_version-1-15-1","minecraft_version-1-15-2","minecraft_version-1-16","minecraft_version-1-16-1","minecraft_version-1-16-2","minecraft_version-1-16-3","minecraft_version-1-16-4","minecraft_version-1-16-5","minecraft_version-1-17","minecraft_version-1-17-1","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\n| ————————— | —————————————- | ——————————– |
\n| `!startfly
\n| `!stopfly
\n| `!flyspeed
\n| ——————- | —————————————- | ——- |
\n| `flycraft.use` | Allows toggling flight mode | `op` |
\n| `flycraft.flyspeed` | Allows changing flight speed | `op` |
\n| `flycraft.flytime` | Allows using flight time commands | `op` |
\n| `flycraft.reload` | Allows reloading the configuration | `op` |
\n| `flycraft.others` | Allows managing flight for other players | `op` |<\/p>\n
\n| ————————- | ——————————— | ——- |
\n| `flycraft.maxflyspeed.1` | Allows setting fly speed up to 1 | `op` |
\n| `flycraft.maxflyspeed.2` | Allows setting fly speed up to 2 | `op` |
\n| `flycraft.maxflyspeed.3` | Allows setting fly speed up to 3 | `op` |
\n| `flycraft.maxflyspeed.4` | Allows setting fly speed up to 4 | `op` |
\n| `flycraft.maxflyspeed.5` | Allows setting fly speed up to 5 | `op` |
\n| `flycraft.maxflyspeed.6` | Allows setting fly speed up to 6 | `op` |
\n| `flycraft.maxflyspeed.7` | Allows setting fly speed up to 7 | `op` |
\n| `flycraft.maxflyspeed.8` | Allows setting fly speed up to 8 | `op` |
\n| `flycraft.maxflyspeed.9` | Allows setting fly speed up to 9 | `op` |
\n| `flycraft.maxflyspeed.10` | Allows setting fly speed up to 10 | `op` |<\/p>\n
\n| ———— | ——————————- | —————————- |
\n| `flycraft.*` | Grants all FlyCraft permissions | All permissions listed above |<\/p>\n
\n– `flycraft.flyspeed` – Allow speed changes
\n– `flycraft.maxflyspeed.<1-10>` – Set maximum allowed speed
\n– `flycraft.others` – Manage other players
\n– `flycraft.reload` – Reload configuration<\/p>\n
\ngroups:
\n default:
\n can-fly: false
\n max-fly-speed: 1
\n flight-duration: 300
\n flight-cooldown: 60<\/p>\n
\n can-fly: true
\n max-fly-speed: 3
\n flight-duration: 600
\n flight-cooldown: 30<\/p>\n
\n can-fly: true
\n max-fly-speed: 5
\n flight-duration: 1200
\n flight-cooldown: 15<\/p>\n
\n can-fly: true
\n max-fly-speed: 10
\n flight-duration: -1
\n flight-cooldown: 0
\n“`<\/p>\n
\n| —————– | ——————————————— | ——- |
\n| `can-fly` | Whether the group can use flight | `false` |
\n| `max-fly-speed` | Maximum flight speed (1-10) | `1` |
\n| `flight-duration` | Flight duration in seconds (-1 for unlimited) | `300` |
\n| `flight-cooldown` | Cooldown between flights in seconds | `60` |<\/p>\n
\n– **Inherited Permissions**: Support for LuckPerms inheritance system
\n– **Group Priorities**: Uses primary group with fallback to inherited groups
\n– **Default Group**: Fallback settings for players without a specific group<\/p>\n
\n# Update Checker Settings
\nupdate-checker:
\n enabled: true
\n notify-ops: true
\n debug: false<\/p>\n
\n# The file name in the lang\/ folder (e.g., en_us for en_us.yml)
\nlanguage: “en_us”<\/p>\n
\nflight-duration: 300 # Duration of flight in seconds (default: 300)
\nflight-cooldown: 60 # Cooldown time between flights (default: 60)
\nwelcome-message-enabled: true # Enable welcome messages
\n“`<\/p>\n
\ndiscord:
\n enabled: true
\n channel-id: “YOUR_CHANNEL_ID”
\n bot-token: “YOUR_BOT_TOKEN”
\n bot-settings:
\n status: “ONLINE” # ONLINE, IDLE, DO_NOT_DISTURB, INVISIBLE
\n activity:
\n type: “PLAYING” # PLAYING, WATCHING, LISTENING, COMPETING
\n message: “with %online_players% players”
\n commands:
\n enabled: true
\n prefix: “!”
\n allowed-roles:
\n – “ROLE_ID_1”
\n – “ROLE_ID_2”
\n embed:
\n enabled: true
\n color:
\n start: “#3498db”
\n end: “#e74c3c”
\n speed: “#f1c40f”
\n thumbnail:
\n enabled: true
\n url: “https:\/\/minotar.net\/avatar\/%player%\/64”
\n footer:
\n text: “FlyCraft \u2022 %server_name%”
\n“`<\/p>\n
\nbot-activity:
\n type: PLAYING # Options: PLAYING, WATCHING, LISTENING, COMPETING
\n message: “Flying on %server_name% with %online_players%\/%max_players% online!”
\n“`<\/p>\n
\n– Speed change updates
\n– Total flight time tracking
\n– Player avatars included in embeds<\/p>\n
\n– Displays **player names** and **server info**
\n– Tracks **flight duration**<\/p>\n
\n– `1 minute 30 seconds`
\n– `2 hours 15 minutes 45 seconds`<\/p>\n
\n– **Custom Languages**: You can create your own language files (e.g., `fr_fr.yml`). These files are protected and will never be overwritten or modified by the plugin’s auto-updater.
\n– **Auto-Correction**: If a required key is missing from a custom file, the plugin will fall back to the default English value to prevent errors.<\/p>\n
\nlanguage: “es_es” # This will look for lang\/es_es.yml
\n“`<\/p>\n
\n– **JDA (Discord API):** `5.0.0-beta.13`<\/p>\n
\n– **Vault** \u2013 Economy and permissions support
\n– **DiscordSRV** \u2013 Alternative Discord integration<\/p>\n
\n| ————————- | ———————————- |
\n| `%flycraft_flying_count%` | Number of players currently flying |<\/p>\n
\n| ———————- | ———————————————————— |
\n| `%flycraft_is_flying%` | Returns `true` or `false` |
\n| `%flycraft_status%` | Returns “Flying” or “Not Flying” |
\n| `%flycraft_time_left%` | Remaining flight time (e.g., “5m 30s”) or “Unlimited” |
\n| `%flycraft_can_fly%` | Returns `true` if player has permission to fly |
\n| `%flycraft_speed%` | Current flight speed (e.g., “1”, “2”) |
\n| `%flycraft_max_speed%` | Player’s maximum allowed flight speed |
\n| `%flycraft_cooldown%` | Remaining cooldown time (e.g., “30s”) or “Ready” |
\n| `%flycraft_group%` | Returns “Authorized” or “Unauthorized” based on group access |<\/p>\n
\n| Placeholder | Description |
\n|————-|————-|
\n| `%flycraft_status_
\n| `%flycraft_cooldown_
\n| `%flycraft_max_speed_
\n– **Custom Data Protection** \u2013 Preserves user-added groups and entries during migration
\n– **Automated Backups** \u2013 Creates `.old` files before performing file updates
\n– **Async Discord Messaging** \u2013 Improves performance
\n– **Safe Reload Handling** \u2013 Prevents crashes during reloads
\n– **Automatic Cooldown Management** \u2013 Ensures fair gameplay
\n– **Flight Time Tracking** \u2013 Monitors player flight duration
\n– **Speed Conversion Handling** \u2013 Converts between Minecraft speed units
\n– **Error Logging & Handling** \u2013 Logs issues for troubleshooting
\n– **Event-Based Architecture** \u2013 Efficient and modular<\/p>\n
\n– **Permissions**: Error messages for missing access
\n– **Flight Status**: Toggling and expiration alerts
\n– **Discord**: Commands and admin alerts
\n– **Welcome**: Joining messages<\/p>\n
\n– **Input Validation** \u2013 Prevents invalid command arguments
\n– **Error Handling** \u2013 Captures and logs issues gracefully
\n– **Safe Discord Reconnection** \u2013 Prevents bot disconnection issues
\n– **Cooldown Enforcement** \u2013 Prevents spam abuse
\n– **Flight Duration Limits** \u2013 Ensures balanced gameplay
\n– **Speed Range Limits (1-10)** \u2013 Prevents unintended behavior<\/p>\n
\n– **Java Version:** 21
\n– **Build System:** Maven-based
\n– **Open Source:** Yes
\n– **Extendable Architecture:** Designed for future expansions<\/p>\n
\n2. **Place the .jar file** in your server\u2019s `\/plugins\/` folder.
\n3. **Restart your server** to generate configuration files.
\n4. **Edit `config.yml`** to customize settings.
\n5. **(Optional) Configure Discord Bot** for remote flight control.
\n6. **Reload the plugin** using `\/flycraftreload` or restart the server.<\/p>\n
\n– **Discord Support** \u2013 [[Invite Link]](https:\/\/discord.gg\/5KWpEux3KN)<\/p>\n
\nFlyCraft is an open-source project licensed under the GNU General Public License v3.0 (GPL-3.0). You are free to use, modify, and distribute it, provided that:<\/p>\n
\n– Any modifications or redistributed versions are also licensed under GPL-3.0.
\n– The original license is included in all copies or substantial portions of the project.<\/p>\n