A | Getting Started & Plugin Overview

Getting Started & Plugin Overview

Welcome to FXItems, the developer's toolkit for creating custom items, foods, commands, and more on Spigot/PaperMC.
This page will walk you through setup, core concepts, and show you where to find everything.

---

What is FXItems?

• A plugin for Spigot/PaperMC (Java 17+) that lets you code custom items, foods, commands, and abilities in Java.
• You do NOT use configs or GUIs to create content. Instead, you write classes and register them.
• You get robust utility libraries for cooldowns, mana, effects, projectiles, and much more.

---

Requirements

• Java 17+ (FXItems cannot run on Java 8!)
• Spigot or PaperMC (any recent Minecraft version supported by these APIs)
• (Optional) EntitySize and ModelEngine plugins for advanced visual features

---

Installation

1. Download the FXItems jar and drop it into your server’s /plugins folder.
2. Start your server once to generate default folders and configs.
3. For custom development, clone the repo or add FXItems as a dependency.

---

Directory & Package Structure

• com.noctify.Main — Core plugin logic
• com.noctify.Main.Utils — Utility classes (cooldowns, mana, projectiles, etc.)
• com.noctify.Custom — Your custom items, foods, commands, and event listeners
• com.noctify.API — Public API for addons

---

How does it work?

• You create a Java class for each custom item, food, command, or event.
• You register these in the appropriate Registry class (see Registry Deep Dive).
• You can define custom recipes, abilities, and behaviors in your classes.
• Utility classes help you with everything from cooldowns to projectiles.

---

Next: FXItems Registry System: Deep Dive