Skip to content

README.md

Latest commit

 

History

History
85 lines (59 loc) · 3.49 KB

README.md

File metadata and controls

85 lines (59 loc) · 3.49 KB
Raw

Gradeway

A Minecraft permission gateway.

Changelog – Security Policy – Code of Conduct – Discord – API Reference

modrinth

Features

  • Player, role, and group management with inheritance, weighted priority, and effective permission resolution
  • Permission management with presets via templates
  • Integrated messaging service to refresh data on every connected server
  • Backup export/import, plus a migration path for bringing over existing permission data
  • Confirmation prompts before destructive commands
  • Pluggable database and messaging backends, loaded as separate driver jars at runtime
  • Pausing and setting an expired date for individual player roles
  • Relational database layout to support efficient querying and in-database cleanups
  • Built-in attribute types and extendable attributes with custom serializers

Installation

For server admins

See the installation guide for downloading and configuring Gradeway on your server.

For developers

See the installation guide for depending on Gradeway from your own plugin.

Supported platforms and databases

Platforms: Bukkit, Paper, BungeeCord, and Velocity.
Drivers: Postgres, MySQL, MariaDB, SQLite, SQL Server, Oracle, H2, and Redis as pluggable backends.
See COMPATIBILITY.md for the full overview.

Architecture

See ARCHITECTURE.md for how the Player, Role, and Group model works – especially relevant if you're coming from LuckPerms, where "group" means something different.

Database Schema

See DATABASE.md for an interactive diagram of the schema.

Building from Source

Requires a JDK 17+ to run Gradle itself.
The actual JDK 21/25 toolchains used to compile each module are auto-provisioned by Gradle on first build (via the Foojay resolver).

git clone https://github.com/GradientTim/gradeway.git
cd gradeway
./gradlew build

Build a single module instead, e.g. ./gradlew :core-common:build.

Contributing

See CONTRIBUTING.md for the development setup, project layout, and PR expectations.
The Discord server is the fastest way to discuss a change before you start.

License

This project is licensed under the MIT License.