Getting Started
This guide covers the requirements, installation process, generated files, and first command for Particle Text.
Prerequisites
Section titled “Prerequisites”- Java Version: Java 25 or newer.
- Server Software: A Paper-compatible Minecraft 26.2 server.
- PlaceholderAPI Optional: Resolves placeholders inside renderer text and enables the
%particletext_*%expansion. - Permissions Plugin Optional: Use a plugin such as LuckPerms to grant administrative commands to non-operators.
Installation
Section titled “Installation”- Download the latest
particle-text-x.x.x.jarrelease from SpigotMC or BuiltByBit. - Place the JAR in your server’s
plugins/directory. - Install PlaceholderAPI if you want dynamic renderer text or Particle Text placeholders.
- Restart the server. Avoid
/reload, because a full restart safely initializes the renderer task and integrations. - Run
/pt versionto confirm that Particle Text is enabled.
Generated Files
Section titled “Generated Files”The first startup creates /plugins/ParticleText/ with these files:
| File | Purpose |
|---|---|
config.yml | Performance limits, renderer defaults, menu appearance, sounds, and update checks. |
messages.yml | MiniMessage-compatible command responses, help lines, and inventory text. |
renderers.yml | Persistent text, particle, font, transform, state, and location data for every renderer. |
Create Your First Renderer
Section titled “Create Your First Renderer”Stand where the text should appear, then run:
/pt create welcome Welcome to the server!The ID must contain 1 to 32 lowercase letters, numbers, underscores, or hyphens. Continue with the Creating Renderers guide to move and style it.