Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.24 KB

README.md

File metadata and controls

57 lines (43 loc) · 2.24 KB

commands

Latest Release Build Status CodeFactor Grade

Simple, no non-sense command framework for Paper servers.

Brigadier is not currently supported, nor is it guaranteed to be supported in the future. Contributions are welcome.


Requirements

Requires Java 17 (or higher) and Paper 1.20.1 (or higher).


Getting Started

Library is published to the GitHub Packages Registry and may require additional configuration. You can find more details here.

repositories {
    maven { url = "https://maven.pkg.github.com/grabsky/commands"
        credentials {
            username = findProperty("gpr.actor") ?: System.getenv("GITHUB_ACTOR")
            password = findProperty("gpr.token") ?: System.getenv("GITHUB_TOKEN")
        }
    }
}
dependencies {
    implementation 'cloud.grabsky:commands:[_VERSION_]'
}

Documentation

Documentation and examples are available here.


Building

# Cloning the repository.
$ git clone https://github.com/Grabsky/commands.git
# Entering the cloned repository.
$ cd commands
# Compiling and publishing to maven local.
$ gradlew clean publishToMavenLocal

Contributing

This project is open for contributions. I'm currently looking for help in implementing presence and parameter flags for commands.