Getting Started
Welcome to Santa Says! This plugin brings the classic “Simon Says” minigame to your Minecraft server with a festive twist, featuring automated tasks, competitive scoring, and full customization.
Prerequisites
Section titled “Prerequisites”Before installing the plugin, ensure your server environment meets the following requirements:
- Java Version: Java 21 or newer is required.
- Minecraft Version: 1.20.6 or 1.21.11 (Latest versions recommended).
- Permissions Plugin Optional : A plugin like LuckPerms to manage user access.
Installation
Section titled “Installation”Setting up Santa Says is straightforward. Follow these steps to get started:
- Download the Plugin: Get the latest version of Santa Says from the official distribution page.
- Upload to Server: Place the
santa-says-x.x.x.jarfile into your server’splugins/directory. - NoteBlockAPI (Optional): If you want background music, also place NoteBlockAPI in the same folder.
- Restart Server: Restart your server to generate the default configuration files.
- Verify Installation: Type
/santasays(or your configured alias) in-game to ensure the plugin is loaded correctly.
First-Run Configuration
Section titled “First-Run Configuration”After the first restart, a new folder will be created at /plugins/SantaSays/. This folder contains everything you need to customize your game:
config.yml: Main plugin settings, database connection, and general game rules.tasks/: A directory containing sub-folders for Participation and Placement tasks.song/: Place your.nbsfiles here for the in-game radio.messages.yml: Full control over every string and translation shown to players.
Basic Command Structure
Section titled “Basic Command Structure”While you’ll spend most of your time in the config files, here are the essential commands:
| Command | Permission | Description |
|---|---|---|
/ss create <arena> | santasays.arena.create | Creates a new game arena with the specified name. |
/ss edit <arena> | santasays.arena.create | Opens the configuration menu to set up spawns, regions, and settings for an arena. |
/ss help | santasays.admin.help | Displays a comprehensive list of all available commands and their usage. |
/ss join <arena> | None | Allows a player to join the specified game arena’s lobby. |
/ss leave | None | Allows a player to exit their current game and return to the global spawn point. |
Next Steps
Section titled “Next Steps”Now that the plugin is installed, it’s time to dive deeper:
- Arena Setup Guide: Learn how to create your first game arena.
- Placeholders: Hook into PlaceholderAPI for your scoreboards.
- Developer API: Start building custom integrations.