Installation

Work in Progress

Reverie is currently in a WIP beta state. Features may be incomplete, change significantly, or contain bugs. Documentation may not reflect the latest state of the mod.

Installation

Requirements

Requirement	Version
Minecraft	1.21.1
Fabric Loader	0.16.0+
Fabric API	0.116.6+1.21.1
Cobblemon	1.7.0+
Java	21

Optional Dependencies

Reverie bundles all other required libraries in its jar. These optional mods add extra functionality:

Mod	Purpose
Impactor Economy	Currency rewards and entry fees
LuckPerms	Granular permission management

Server Installation

1. Place the Reverie jar (Reverie-fabric-1.21.1-X.X.X.jar) into your server’s mods/ folder
2. Ensure Cobblemon and Fabric API are already installed in mods/
3. Start the server once to generate default configuration files
4. Configuration files will appear in config/reverie/
5. Edit configs to your needs, then run /reverie reload or restart

File Structure

After the first launch, Reverie creates the following file structure:

config/reverie/
  config.conf              # Global settings (debug mode)
  contest.conf             # Contest module settings
  tournament.conf          # Tournament settings
  cosmetics.conf           # Pokemon poses and cosmetics
  display.conf             # UI/display settings
  seasons.conf             # Season/leaderboard settings
  achievements.conf        # Achievement definitions
  halls/                   # Hall venue configurations
    standard_hall/
      hall.conf
  contesttypes/            # Custom contest type definitions
  music/                   # NBS music files (.nbs)
  contest_results/         # Persisted contest results (auto-generated)
  player_stats/            # Player statistics (auto-generated)
  player_states/           # Player lifecycle state (auto-generated)

Note

All data is stored as flat JSON files — no database setup is required. See Storage & Data for details on data persistence.

Client-Side

Reverie is server-side only. Players do not need to install anything. All GUIs are server-managed and all items appear as vanilla Minecraft items. No resource pack is required.

Reloading Configuration

You can reload configs without restarting:

/reverie reload        # Reload all configs
/hallbuilder reload    # Reload hall configs
/contesttype reload    # Reload contest types

Next Steps

1. Your First Contest — Set up a hall and run your first contest
2. Configuration Overview — Learn how the config system works