Getting Started

Welcome to Carousel! This guide provides a quick and easy walkthrough of the system requirements and step-by-step installation process needed to get the plugin running on your Minecraft server.

Prerequisites

Before installing the plugin, ensure your server environment meets the following requirements:

Java Version: Java 21 or newer is required.
Server Software: Spigot, Paper, or any compatible fork (e.g., Purpur).
Minecraft Version: 1.8 - 1.21+ (Latest versions recommended).
Permissions Plugin Optional : A plugin like LuckPerms to manage user access.

Installation

Setting up Carousel is straightforward. Follow these simple steps to get started:

Download the Plugin: Visit our Resource Page to download the latest version.
Upload to Server: Stop your server and place the carousel-x.x.x.jar file into your server’s plugins/ directory.
Restart Server: Start your server. The plugin will automatically generate the default configuration files.
Verify Installation: Check your console to ensure the plugin is loaded correctly:

[INFO]: [Carousel] Loading Carousel vX.X.X
[INFO]: [Carousel] Enabling Carousel vX.X.X.
[INFO]: [Carousel] Initialization finished in XXXms.
[INFO]: [Carousel] Join our Discord server: [https://discord.gg/uXVU8jmtpU](https://discord.gg/uXVU8jmtpU)

First-Run Configuration

After the first restart, a new folder will be created at /plugins/Carousel/. This folder contains everything you need to customize your plugin:

config.yml: Main plugin settings and general behaviors.
messages.yml: Full control over every string and translation shown to players.

Basic Command Structure

While you’ll spend most of your time using the interactive GUI, here are the essential commands to get you started:

Command	Permission	Description
`/carousel create <id>`	`carousel.create`	Creates a new carousel instance with the specified ID.
`/carousel edit <id>`	`carousel.edit`	Opens the interactive GUI editor to visually customize your carousel.
`/carousel list`	`carousel.list`	Displays a list of all created carousel instances currently on the server.
`/carousel help`	`carousel.help`	Displays a comprehensive list of all available commands and their usage.

Next Steps

Now that the plugin is installed and running, it’s time to dive deeper:

Creating Carousels: Learn how to spawn, configure, and manage your carousels.
Carousel Behavior: Fine-tune the physics, rotation speed, and vertical motion.
Commands: Review the complete list of administrative commands and permissions.
Developer API: Hook into custom events to build your own integrations.