NPCorePlugin

# NorrionProjectCorePlugin > **The core of the NorrionProject ecosystem — Required for all NorrionProject plugins** --- ## 🎯 What is this? **NorrionProjectCorePlugin** is the **shared technical foundation** for all plugins in the NorrionProject ecosystem. It is **not a standalone gameplay plugin** — it is **mandatory** for **NPEnderChestPlugin**, **NPDiscordPlugin**, **NPPartiesPlugin**, and **NPProjectPlugin** (the main gameplay plugin) to function. As a server admin, you **don't configure this directly** — it auto-configures through the plugins that depend on it. --- ## ✨ What it brings to your server | Feature | Benefit for you | |---------|------------------------------------------------------------------------------| | **Unified configuration** | Single `plugins/NorrionProject/` folder for all configs | | **YAML/SQL storage** | Persistent data, choose file or database backend | | **Multilingual (EN/FR)** | Translated messages, extensible to more languages | | **Paginated commands** | Clean `/help` with page navigation | | **Server ↔ Client relay** | Communication with Fabric client mod (HUD, map, etc.) **teasing feature :3** | | **Vault Economy API** | Auto-detects your economy plugin | --- ## 📦 Installation 1. Download `NorrionProjectCorePlugin-<version>.jar` 2. Place it in `plugins/` 3. **Restart** the server (not `/reload`) 4. A `plugins/NorrionProject/` folder is created automatically ### Generated files ``` plugins/NorrionProject/ ├── core-config.yml # Global config (language, SQL, etc.) ├── language/ # Translation files └── <other norrion project plugins files>/ # Each dependent plugin creates its subfolder ``` --- ## ⚙️ Configuration (`config.yml`) All documentation is provided in `plugins/NorrionProject/core-config.yml` > **Tip**: On small/medium servers, keep `use-sql: false` (YAML files = zero config, auto-save). --- ## 📋 Dependencies | Plugin | Type | Why? | |--------|------|------| | **Vault** | Optional | Economy (auto-detected if present) | | **NPCore (included)** | Internal | Shared data models | --- ## ❓ FAQ **Q: I installed it but nothing happens?** A: Normal! It's a **library**. Install a plugin that depends on it (e.g. `NPEnderChestPlugin`) to see gameplay features. **Q: Can I use it for my own plugins?** A: This is not recommended, it's built specifically for the NorrionProject ecosystem and can change drastically, making code maintenance difficult. At least for now. **Q: How do I change the language?** A: Edit `locale: "en"` in `config.yml` then restart. --- ## 🔗 Useful Links - **Website & Wiki**: (https://norrion.eu) - **Support / Bugs**: (https://discord.gg/WHUZNQe) --- *Part of the (https://modrinth.com/server/norrion) ecosystem.*