Skip to content

Configuration

Technofied edited this page Apr 4, 2026 · 1 revision

← Home

Configuration

Most Realty files sit in plugins/Realty/ on the server.


What each file is for

File Purpose
database.yml Database connection for Realty. Details in Database.
settings.yml Default authorities, date display, subregion limits, and offer payment timing.
profiles.yml Maps Realty states to WorldGuard flags and optional sign layouts.
messages.yml Chat text (errors, help, notifications) in MiniMessage format.
defaults/ Default configuration files for your reference.

Reloading

/realty reload applies changes in settings.yml, profiles.yml, and messages.yml without restarting the server. It requires realty.command.reload. Changing database.yml means restarting the whole server.


settings.yml

The table below lists common keys.

Setting Purpose
default-freehold-authority-uuid Default authority when creating or registering a freehold without --authority.
default-leasehold-authority-uuid Default landlord when creating or registering a leasehold without --landlord.
default-freehold-titleholder-uuid Optional default title holder (most leave this blank).
date-format How dates appear in messages (Java date-time pattern syntax).
profile-reapply-per-tick How many region profiles are reapplied per server tick after startup or reload (lower reduces lag spikes, higher finishes sooner).
subregion-min-volume Minimum block count for /realty subregion quickcreate.
offer-payment-duration-seconds How long a buyer has to finish paying after an offer is accepted (86400 is twenty-four hours).

Use valid player UUIDs for every *-uuid field.


profiles.yml

This file maps each Realty state (ALL, FOR_SALE, SOLD, FOR_LEASE, LEASED) to WorldGuard flags, optional priority, and optional sign templates (MiniMessage lines and click commands).

The global section applies to all Realty regions. The grouped section overrides global for specific WorldGuard region names.


messages.yml

This file contains the messages players read in chat. It covers command feedback, /realty help text, and notifications. Formatting uses MiniMessage, including placeholders for things like region names and prices.


Permissions

Permission nodes live in paper-plugin.yml in the JAR, not in these YAML files. The full list is on Permissions.


Related pages: Installation · Database

Clone this wiki locally