## 🎮 Description
**FOptions** is a powerful and highly customizable lobby options plugin designed for Minecraft servers. It allows players to customize their lobby experience with options like player visibility, chat toggle, double jump, fly, mount/stacker, join messages, and stunning join effects!
### ✨ Key Features
- 🎯 **Player Visibility** - Toggle between ALL, NONE, or RANKS ONLY
- 💬 **Chat Toggle** - Enable/disable chat messages
- 🦘 **Double Jump** - Fun double jump in lobby
- 🐎 **Mount/Stacker** - Allow/prevent player stacking
- 🕊️ **Fly Mode** - Fly around the lobby
- 📢 **Join Messages** - Custom join announcements
- 🎆 **Join Effects** - 7 stunning effects (Firework, Zeus, VulcanWool, Sheeps, Chickens, Notes, Bats)
- 🎨 **HEX Color Support** - Full RGB colors for 1.16+ (&#RRGGBB format)
- 📊 **MySQL & SQLite** - Optimized for 100,000+ users
- 🔧 **100% Configurable** - Every item, message, and slot is customizable
---
## 📋 Commands
| Command | Description | Permission |
|---------|-------------|------------|
| `/foptions` | Open the main options menu | `foptions.use` |
| `/foptions menu` | Open the main options menu | `foptions.use` |
| `/foptions effects` | Open the join effects menu | `foptions.use` |
| `/foptions reload` | Reload all configurations | `foptions.reload` |
| `/foptions stats` | View plugin statistics | `foptions.admin` |
| `/foptions help` | Show help message | `foptions.use` |
**Aliases:** `/fo`, `/options`, `/lobbyoptions`
---
## 🔐 Permissions
### General Permissions
| Permission | Description | Default |
|------------|-------------|---------|
| `foptions.*` | Access to all features | OP |
| `foptions.use` | Use the /foptions command | Everyone |
| `foptions.admin` | Admin commands access | OP |
| `foptions.reload` | Reload configuration | OP |
### Feature Permissions
| Permission | Description | Default |
|------------|-------------|---------|
| `foptions.visibility` | Toggle player visibility | Everyone |
| `foptions.visibility.ranked` | Visible in RANKS mode | OP |
| `foptions.chat` | Toggle chat visibility | Everyone |
| `foptions.doublejump` | Use double jump | Everyone |
| `foptions.mount` | Mount/stack on players | Everyone |
| `foptions.fly` | Use fly in lobby | OP |
| `foptions.messagejoin` | Custom join messages | OP |
### Effect Permissions
| Permission | Description | Default |
|------------|-------------|---------|
| `foptions.effects.*` | All join effects | OP |
| `foptions.effects.firework` | Firework effect | OP |
| `foptions.effects.zeus` | Lightning effect | OP |
| `foptions.effects.vulcanwool` | Vulcan wool effect | OP |
| `foptions.effects.sheeps` | Sheeps effect | OP |
| `foptions.effects.chickens` | Chickens effect | OP |
| `foptions.effects.notes` | Notes effect | OP |
| `foptions.effects.bats` | Bats effect | OP |
---
## 🏷️ PlaceholderAPI Support
FOptions supports PlaceholderAPI for join messages:
| Placeholder | Description |
|-------------|-------------|
| `%player%` | Player's name |
| `%luckperms_prefix%` | LuckPerms prefix |
| Any PAPI placeholder | Full PlaceholderAPI support |
---
## 💾 Database Support
### SQLite (Default)
- No configuration needed
- Perfect for small to medium servers
- Data stored in `plugins/FOptions/data.db`
### MySQL (Recommended for large servers)
- Connection pooling with HikariCP
- Optimized for 100,000+ users
- Configure in `config.yml`:
```yaml
Settings:
MySQL:
Enabled: true
Host: 'localhost'
Port: 3306
Username: 'your_username'
Password: 'your_password'
Database: 'foptions'
```
---
## 🎨 HEX Color Support
For Minecraft 1.16+, you can use HEX colors in all messages and items!
**Formats supported:**
- `&#RRGGBB` (example: `&#FF5555Hello`)
- `#RRGGBB` (example: `#FF5555Hello`)
**Example in lang.yml:**
```yaml
Prefix: "&#FF6B6B» &#FFD93D"
```
---
## 📁 Configuration Files
### config.yml
- Database settings (MySQL/SQLite)
- Enabled worlds
- Sound effects
- Default player values
- Enable/disable features
### menu.yml
- Complete GUI customization
- Item materials, names, lore
- Slot positions
- Back button configuration
### lang.yml
- All plugin messages
- Full color support including HEX
- PlaceholderAPI support
---
## 🔄 Version Compatibility
| Minecraft Version | Java Version | Status |
|-------------------|--------------|--------|
| 1.8.x - 1.12.x | Java 8+ | ✅ Fully Supported |
| 1.13.x - 1.16.x | Java 11+ | ✅ Fully Supported |
| 1.17.x - 1.20.x | Java 17+ | ✅ Fully Supported |
| 1.21.x+ | Java 21 | ✅ Fully Supported |
---
## 📦 Dependencies
**Required:** None
**Optional:**
- PlaceholderAPI - For placeholder support in messages
- LuckPerms - For prefix support in join messages
---
## 🛠️ Installation
1. Download `FOptions.jar`
2. Place it in your `plugins` folder
3. Restart your server
4. Configure in `plugins/FOptions/`
5. Use `/foptions reload` to apply changes
---
## 💬 Support
Need help? Have suggestions?
- Discord: [Join our Discord](#)
- GitHub: [Report Issues](#)
---
## 📜 Terms of Service
- You may NOT redistribute this plugin
- You may NOT claim this as your own work
- You may NOT decompile or modify the code
- Refunds are NOT available after download
---