YouNeedMe

YouNeedMe

YouNeedMe is an all-in-one, Essentials-style administration and utility plugin for Paper/Spigot/Purpur/Folia servers — homes, warps, kits, an economy with a native Vault provider, a shop, an auction house, moderation, a configurable scoreboard, nicknames, Discord notifications and more, in a single modern, actively maintained plugin.

It's directly inspired by EssentialsC's architecture (a public api module, an expansions/ system, commands.yml-style configurability) — rewritten from scratch, not forked, and licensed the same way (Apache-2.0) for the same reason: server owners and expansion authors should be able to build on it without friction.

Features

See the wiki for the full command/permission reference and configuration guide.

Requirements

• Java 21+
• Paper (recommended), Spigot, Purpur, Folia, or a compatible fork (Leaf, Leaves) — Minecraft 26.2, with 26.3 supported as soon as it's stable.
• On Folia, the built-in sidebar scoreboard is disabled because Folia does not support Bukkit's scoreboard API yet. Use a Folia-compatible scoreboard plugin if you need a sidebar there.

Installation

1. Download the latest YouNeedMe.jar from Releases or Modrinth or Hangar.
2. Drop it into your server's plugins/ folder and restart.
3. Edit plugins/YouNeedMe/config.yml and plugins/YouNeedMe/modules/*.yml to taste, then /ynm reload.

By default YouNeedMe runs on an embedded SQLite database with no further setup required. For a multi-server network, set storage.type to mysql, mariadb or postgresql in config.yml.

Building from source

git clone https://github.com/Mathildeuh/YouNeedMe.git
cd YouNeedMe
./gradlew build

The finished plugin jar is written to build/libs/YouNeedMe.jar.

Developing against the API

Third-party plugins and expansions should compileOnly against the api module rather than the core implementation:

repositories {
    maven("https://jitpack.io")
}

dependencies {
    compileOnly("com.github.Mathildeuh.YouNeedMe:api:<version>")
}

YouNeedMeAPI.economy().ifPresent(economy ->
        economy.balance(player.getUniqueId())
                .thenAccept(balance -> player.sendMessage("Balance: " + balance)));

See the API wiki page for the full service list and event catalog, and the Expansions wiki page for writing a loadable expansion instead of a standalone plugin.

Contributing

Issues and pull requests are welcome. Before opening a PR:

• Run ./gradlew spotlessApply (formatting is enforced, not just suggested).
• Run ./gradlew build and make sure it passes.
• Keep the api module free of implementation details — it's what third parties compile against.

Local test server

docker-compose.yml at the repository root spins up Paper + MariaDB + Redis with the freshly built plugin jar mounted in:

./gradlew build
docker compose up -d

See the comments in docker-compose.yml for pointing config.yml at the MariaDB service.

License

Apache License 2.0 — see LICENSE.