Skip to content

Noctivag/basic-plugin-fabric-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Enhanced Fabric Plugin

A comprehensive, professional-grade Fabric Minecraft plugin with extensive features, full configurability, and seamless LuckPerms integration. Every feature can be toggled on/off independently.

✨ Features

🏠 Teleportation System

  • Multiple homes per player - Configurable limit
  • Home management - Set, delete, and list homes
  • Spawn teleportation - Return to world spawn
  • Back command - Return to previous location
  • TPA system - Request teleports to other players
  • Cooldown system - Configurable with bypass permissions
  • Multi-world support - Works across all dimensions

πŸ’° Economy System

  • Virtual currency - Fully customizable
  • Player balances - Persistent storage
  • Money transfers - Send money between players
  • Balance leaderboard - Top richest players
  • Daily rewards - Configurable daily login bonuses
  • Starting balance - New players start with configurable amount
  • Custom currency - Configure name and symbol

πŸ’¬ Chat Management

  • Custom chat formatting - LuckPerms prefix/suffix integration
  • Anti-spam protection - Configurable message threshold
  • Anti-caps filter - Auto-lowercase excessive caps
  • Profanity filter - Blacklist inappropriate words
  • Mention system - Tag other players
  • Mute system - Temporary and permanent mutes

πŸ‘₯ Player Events

  • Welcome messages - Customizable join messages
  • Farewell messages - Customizable leave messages
  • First join rewards - Special treatment for new players
  • Broadcast toggle - Server-wide or personal messages
  • Playtime tracking - Track player session times

πŸ› οΈ Utility Commands

  • /heal - Restore health and hunger
  • /feed - Restore hunger
  • /repair - Repair items (planned)
  • /rename - Rename items (planned)
  • /enchant - Custom enchantments (planned)
  • /craft - Open crafting table
  • /enderchest - Access enderchest

πŸ”¨ Moderation Tools

  • Kick - Remove players from server
  • Ban - Permanently ban players
  • Mute - Silence players in chat
  • Warn - Issue warnings to players
  • Clear chat - Clear server chat
  • Freeze - Prevent player movement (planned)
  • Vanish - Become invisible (planned)
  • God mode - Invincibility (planned)
  • Fly - Enable flight (planned)

🎨 GUI Menu System (Deluxe Menus Style)

  • Customizable GUI menus - JSON-based configuration
  • Velocity server switcher - Switch between proxy servers seamlessly
  • Command execution - Player and console commands from menu items
  • Menu navigation - Link menus together for complex interfaces
  • Rich customization - Full control over items, lore, enchantments
  • Permission support - Control menu and item visibility
  • Hot reload - Update menus without server restart
  • Multiple click types - Left, right, and middle click actions

πŸ” LuckPerms Integration

  • Full permission support - All commands use permissions
  • Prefix/Suffix display - Show ranks in chat
  • Group synchronization - Sync with LuckPerms groups
  • Fallback system - Works without LuckPerms using vanilla permissions

πŸ’Ύ Data Persistence

  • SQLite support - Default local storage
  • MySQL support - For multi-server setups
  • Async operations - Non-blocking database access
  • Data caching - Performance optimized
  • Player data tracking - Join times, playtime, etc.

βš™οΈ Advanced Configuration

  • Every feature toggleable - Enable/disable any feature
  • Hot reload - /efreload command
  • JSON configuration - Easy to read and edit
  • Per-feature settings - Detailed customization
  • Performance tuning - Cache and batch settings

πŸ“¦ Installation

  1. Download the plugin JAR file
  2. Place it in your server's mods folder
  3. Install dependencies:
    • Fabric API (required)
    • LuckPerms (optional but recommended)
  4. Start your server
  5. Configure in config/enhanced-fabric.json

πŸ”§ Configuration

The plugin creates config/enhancedfabric/config.json on first run. Every feature can be individually configured and toggled. See the configuration file for complete options.

GUI Menu System

For detailed information about creating and customizing GUI menus, see GUI_MENU_SYSTEM.md.

Quick example menu configuration:

{
  "name": "main",
  "title": "&6&lMain Menu",
  "size": 27,
  "items": [
    {
      "slot": 13,
      "material": "COMPASS",
      "displayName": "&b&lServer Selector",
      "lore": ["&7Click to switch servers"],
      "leftClickActions": [
        {
          "type": "SERVER",
          "action": "survival"
        }
      ]
    }
  ]
}

πŸ“œ Commands

General

  • /efreload - Reload configuration (Permission: enhancedfabric.admin.reload)

Teleportation

  • /sethome <name> - Set a home location
  • /home <name> - Teleport to home
  • /delhome <name> - Delete a home
  • /homes - List your homes
  • /spawn - Teleport to spawn
  • /back - Return to previous location

Economy

  • /balance [player] - Check balance
  • /bal - Alias for balance
  • /pay <player> <amount> - Send money
  • /baltop - View leaderboard

Utility

  • /heal [player] - Restore health
  • /feed [player] - Restore hunger

GUI Menus

  • /menu [menuId] - Open a GUI menu
  • /menureload - Reload menu configurations

Moderation

  • /kick <player> [reason] - Kick a player

πŸ” Permissions

All commands use the permission format: enhancedfabric.<category>.<action>

If LuckPerms is not installed, the plugin uses Minecraft's permission level system:

  • Level 0: Basic player commands
  • Level 2: VIP/Helper commands
  • Level 3: Moderator commands
  • Level 4: Administrator commands

πŸ”„ LuckPerms Integration

The plugin seamlessly integrates with LuckPerms for:

  • Permission management
  • Prefix/suffix display in chat
  • Group-based features
  • Rank display

Example Permission Setup

# Give default group access to basic features
/lp group default permission set enhancedfabric.home.set true
/lp group default permission set enhancedfabric.home.use true
/lp group default permission set enhancedfabric.spawn true

# Give moderators access to moderation commands
/lp group mod permission set enhancedfabric.mod.kick true
/lp group mod permission set enhancedfabric.mod.mute true

# Give admins all permissions
/lp group admin permission set enhancedfabric.* true

🎨 Color Codes

Use & color codes in configuration and messages:

  • &0-9, a-f - Colors
  • &l - Bold
  • &m - Strikethrough
  • &n - Underline
  • &o - Italic
  • &r - Reset

πŸ“Š Database

Supported Databases

  • SQLite - Default, no setup required
  • MySQL - For multi-server networks

Tables

  • ef_players - Player data
  • ef_homes - Home locations
  • ef_warps - Server warps
  • ef_economy - Balances
  • ef_warnings - Warnings
  • ef_mutes - Mutes

πŸš€ Performance

The plugin includes several performance optimizations:

  • Async database operations
  • Player data caching
  • Batch database writes
  • Configurable cache expiry

🀝 Compatibility

Compatible With

  • βœ… LuckPerms - Full integration
  • βœ… Fabric API - Required
  • βœ… Vanilla Minecraft - No conflicts
  • βœ… Most Fabric mods

Version Support

  • Minecraft: 1.20.4
  • Fabric Loader: 0.15.0+
  • Java: 17+

πŸ› Troubleshooting

Plugin not loading

  • Ensure Fabric API is installed
  • Check server logs for errors
  • Verify Java 17+ is being used

Permission issues

  • Install LuckPerms for full permission support
  • Verify permission nodes are correct
  • Check player group memberships

Commands not working

  • Verify feature is enabled in config
  • Check player has required permission
  • Use /efreload after config changes

πŸ“ License

MIT License - See LICENSE file for details

🎯 What Makes This Plugin "Next Level"

  1. βœ… Full Configurability - Every feature can be toggled independently
  2. βœ… LuckPerms Integration - Seamless compatibility with the industry standard
  3. βœ… Professional Architecture - Clean, maintainable, well-documented code
  4. βœ… Persistent Data - SQLite and MySQL support for data storage
  5. βœ… Performance Optimized - Caching, async operations, batch processing
  6. βœ… Comprehensive Features - Teleports, economy, chat, moderation, GUI menus, and more
  7. βœ… Fallback Systems - Works with or without optional dependencies
  8. βœ… Hot Reload - Configuration changes without server restart
  9. βœ… Multi-world Support - Works across all dimensions
  10. βœ… GUI Menu System - Deluxe Menus style with Velocity server switching
  11. βœ… Extensive Documentation - Clear setup and usage guides

Made with ❀️ for the Fabric community

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages