# Supporter Perks
Give a persistent server a shared place for player customization, social activities, and everyday conveniences. Supporter Perks combines an Administrator's Book for managing access with player menus for companions, appearances, music, saved homes, and decorative builds.
**Minecraft Java 1.21.1 · NeoForge · Java 21 · Version 0.1.0, in development**
## A ledger for your server
- Find current and former players, including offline players, in the Administrator's Book.
- Assign tiers, review individual feature switches, and see why a feature is available or locked.
- Delegate administration through Viewer, Editor, and Manager roles, with change review and audit history.
- Keep saved selections when access changes. Ineligible looks and profiles become inactive rather than being erased.
Tiers 1–5 provide cumulative access. Tier 6 has the same in-game access as Tier 5; the mod does not provide server hosting, payments, or automatic membership synchronization. Individual switches operate within a player's tier and cannot unlock features above it.
## Companions, character, and roleplay
- Choose from eight decorative companion forms, with color variants, tricks, and placeable habitats.
- Use solo gestures and consent-based paired actions from the **Shift+G** action wheel.
- Select wearable accessories and appearance options for supported mounts.
- Make character portraits at a booth and display them in frames.
- Customize name styles and character appearance. Character appearance editing is disabled when Afterfall is installed, because Afterfall controls the survivor's appearance.
Companions are decorative and do not fight. Roleplay poses and appearance choices do not change the player's hitbox.
## Music and spaces to make your own
- Play six instruments through a 25-note interface, then save and share short performances.
- Write melodies in a step editor and play melodies or recordings through music boxes.
- Place animated furniture, including a rocking chair, pendulum desk clock, shuttered display case, and spinning globe.
Listeners can adjust or mute other players' music. The client also includes reduced-motion and companion-visibility settings.
## Everyday tools
- Save homes and travel with configurable warmups, cooldowns, and destination checks.
- Invite another player to a home with a one-time invitation.
- Keep a private address book and share accepted copies of entries.
- Track shopping lists on a configurable HUD that counts carried items and supported containers.
Home allowances are capped at three. Extra homes remain saved but locked after an allowance reduction.
## Optional integrations
The core mod works without partner mods. The following features need a compatible partner installation and its integration API:
- **Afterfall:** survivor identity presets, clothing and equipment finishes, vehicle customization, computer themes, email access, and an Arcade app with five games across its available collections.
- **Beyond the Overworld:** ship liveries and accessories, explorer and console styling, scanner looks, and cabin displays and themes.
- **Brewhaven:** drink vessels, journal covers, station finishes, tavern signs, and decorative pouring and drinking effects.
- **Civic Frontier:** badges, stationery, pigeon accessories, property decorations, town crests, heraldry, and ambient town residents. The bartender resident also needs Brewhaven.
- **Dynamic Item Lighting:** held-light colors, companion lanterns, and light from selected glowing looks. This lighting is visual and does not change world light levels, crop growth, or mob spawning.
Mail uses Afterfall or Civic Frontier; it is not a separate delivery network. Residents provide ambient presentation rather than workers or automated production. Partner ownership and gameplay rules still apply.
## Installation and compatibility
- Install **Minecraft Java 1.21.1**, **Java 21**, and **NeoForge**. The project targets **NeoForge 21.1.252**; its declared minimum is **21.1.200**.
- Install the same Supporter Perks build on the server and every player's client. It is not a server-only mod.
- No partner mod is required for the core. For integrations, use API-equipped builds: **Afterfall 0.16.1+** (built against 0.17.0), **Beyond the Overworld 0.0.1-p1+**, **Brewhaven 1.5.0+** (built against 1.6.0), **Dynamic Item Lighting 1.4.0+**, or **Civic Frontier with CivicApi 1**.
- A version number alone does not guarantee an integration API is present. Missing or older APIs leave the relevant module unavailable.
Designed for persistent multiplayer servers. Single-player can use the core systems, with operator authority needed for administration. Fabric, Quilt, Forge, Bedrock, and other Minecraft versions are not supported by this build.
## Getting started and configuration
Players open the menu with **I** or `/perks`. Staff with the required authority can use `/supporter adminbook` or `/supporter open`; the book has no crafting recipe.
The server configuration controls administrator authority, partner modules, free-player home allowance, travel timing, invitation limits, list limits, music range, and resident caps. Feature allocation and allowances can be overridden with datapacks. Client settings control reduced motion, list-HUD placement and scale, paired invitations, companion visibility, and music volume.
## Development status
This is an early **0.1.0** build. The project records the planned perk set as implemented, with development-environment tests and screenshots. That does not establish production readiness across every setup.
Two-client checks for shared visuals, paired interactions, and mail, audible checks for instruments and other sounds, and large-roster/performance testing remain incomplete. Direct portrait-to-player sharing is not implemented; other players can view portraits in placed frames. Hosting and external membership automation are outside the mod. No additional release date is promised.

