Middle-Earth Additions: Factions

# Middle-Earth Additions: Factions (https://img.shields.io/badge/Minecraft-1.21.1-brightgreen.svg)](https://minecraft.net/) (https://img.shields.io/badge/Mod%20Loader-Fabric-blue.svg)](https://fabricmc.net/) (https://img.shields.io/badge/License-See%20LICENSE-green.svg)](LICENSE) ## 📖 Overview Middle-Earth Additions: Factions is a powerful addon for the Middle-Earth mod that automatically tracks player faction affiliations and provides seamless integration with PlaceholderAPI-compatible mods. Perfect for servers wanting to display faction information in chat, prefixes, and other UI elements. !(https://i.imgur.com/U6UufKx.png) ## ✨ Features ### 🏰 Automatic Faction Tracking - Real-time Detection: Automatically detects when players join factions in the Middle-Earth mod - Persistent Storage: Stores faction data as JSON files in your world save directory - Zero Configuration: Works out of the box with no additional setup required ### 🔗 PlaceholderAPI Integration - Universal Compatibility: Works with StyledChat, LuckPerms, and any mod supporting PlaceholderAPI - Multiple Placeholders: Provides various placeholder formats for different use cases - Optional Dependency: Functions independently but enhances with PlaceholderAPI present ### 🧭 Title Menu (New) - How to Open: Press the default keybinding O to open the Faction Title Menu while in-game. You can rebind this in Controls under category “Middle Earth Additions”. - Faction Panel: A compact panel shows your current faction icon and five title nodes. - Good/Evil Variants: The menu adapts to your disposition (good/evil), changing button icons and rank names (e.g., Soldier→Knight→Captain→Baron→Lord vs Warrior→Uruk→Chieftain→General→Overlord). - Linear Progression: Unlocks must be earned in order. Attempting to preview or unlock a later node shows a prerequisite message. - Requirements & Feedback: Tooltips display Silver Coin, Gold Coin, and EXP level requirements with color-coded status. Insufficient resources or missing prerequisites are shown via action bar messages. - Faction Icon: The top-left faction button displays a faction-appropriate item (e.g., Gondorian Shield, Mordor Wooden Shield, etc.). - Unlocked Perks List: Perks for unlocked ranks are listed in the panel (examples: 10% Speed Boost, +0.5 Arrow Damage, +1 Heart, Resistance aura). ### 🎮 Player Commands - Toggle Display: Players can control whether their faction appears in chat - Testing Tools: Built-in commands for debugging and testing placeholder functionality ### 🛠️ Developer API - Public API: Clean interface for other mods to access faction data - Type Safety: Proper null handling and error management - Documentation: Comprehensive JavaDoc and usage examples ## 📋 Requirements ### Required Dependencies - Minecraft: 1.21.1 - Fabric Loader: 0.16.14+ - Fabric API: Latest version - Middle-Earth Mod: 1.5.3-1.21.1-alpha or compatible ### Optional Dependencies - PlaceholderAPI: 2.4.0+ (for enhanced placeholder support) - StyledChat: For chat formatting integration - LuckPerms: For permission-based prefix/suffix integration ## 🚀 Installation 1. Install Fabric Loader and Fabric API 2. Install the Middle-Earth mod 3. Download and place this mod in your mods folder 4. (Optional) Install PlaceholderAPI for enhanced compatibility 5. Start your server/world ## 📝 Available Placeholders ### Basic Placeholders | Placeholder | Description | Example Output | |-------------|-------------|----------------| | %mefaction% | Formatted faction name | Gondor | | %mefaction_full% | Full faction identifier | me:gondor | | %mefaction_display% | Name with faction (if enabled) | PlayerName | | %metitle% | Player title name | Soldier | ### Supported Factions All Middle-Earth mod factions are supported with proper formatting: | Faction ID | Display Name | |------------|--------------| | me:gondor | Gondor | | me:rohan | Rohan | | me:dale | Dale | | me:longbeards | Longbeards | | me:longbeards.erebor | Erebor | | me:lothlorien | Lothlórien | | me:mordor | Mordor | | me:misty_mountains_goblins | Misty Mountains | | me:isengard | Isengard | | me:shire | Shire | | me:bandit | Bandit | ## 🎯 Usage Examples ### StyledChat Integration ```json { "chat": { "format": "<%mefaction% {player_name}> {message}" } } ``` Result: <Gondor PlayerName> Hello everyone! ### LuckPerms Prefix ```bash /lp user PlayerName meta setprefix 100 "%mefaction% " ``` Result: Player appears as Gondor PlayerName ### Custom Chat Formatting ```json { "style": { "chat": " %player% » %message%" } } ``` Result: PlayerName » Hello Middle-earth! ## 🎮 Commands ### Player Commands - /togglefaction - Toggle faction display in your name - Shows your current faction status - Provides preview of how your name will appear ### Administrator Commands - /viewfactiondata - View all stored faction data - List