2. Configuration

If you are a server owner and want to learn more about the plugin's configuration, this guide is for you! Here you will find a detailed explanation of every config option.

[language]
# Here you can configure the plugin's language (default)
# Available language files can be found in the DreamDisplays/lang/ directory
default_language = "en"

[display]
# Material settings
# It is recommended to keep the default values unless necessary
selection_material = "DIAMOND_AXE" # Item used by players to select the `base_material` area for creating displays
base_material = "BLACK_CONCRETE" # Block used as the actual display surface

# Display size limits
# All values are measured in blocks
# For rendering reasons, it is highly recommended to keep the render distance within 96 blocks
# Otherwise, you may experience visual artifacts at long distances
max_render_distance = 96.0
min_width = 1
min_height = 1
max_width = 32
max_height = 24

# Particle effects for selection visualization
# Note: This feature does not work on Folia
particles = true
particles_color = "#00FFFF" # Color in HEX format

# Mod detection notifications
# Players without Dream Displays will be asked to install it
mod_detection_enabled = true

# Update notifications
updates = true

[reports]
# Report settings
# webhook_url — Discord webhook address for sending reports
# cooldown — cooldown between reports, in seconds
webhook_url = "" # Reports are disabled by default, so this field is empty
cooldown = 30

[storage]
# Storage type: SQLITE or MYSQL
# If using MYSQL, fill in the connection details below
type = "SQLITE"
host = "localhost"
port = "3306"
database = "database"
username = "username"
password = "password"
table_prefix = "" # Optional: leave empty if not needed

[permissions]
# Permission nodes
create = "dreamdisplays.create"      # Create a display. Default: everyone
video = "dreamdisplays.video"        # Set up a video. Default: everyone
help = "dreamdisplays.help"          # Help. Default: everyone
list = "dreamdisplays.list"          # List of all displays. Default: op
stats = "dreamdisplays.stats"        # Stats. Default: op
premium = "dreamdisplays.premium"    # Allows placing displays with 1080p+ resolutions. Default: op
delete = "dreamdisplays.delete"      # Allows deleting any display. Default: op
reload = "dreamdisplays.reload"      # Reloads the plugin. Default: op
updates = "dreamdisplays.updates"    # Receives plugin update notifications (not mod updates!). Default: op

[config]
# Don't touch this
version = 1