https://github.com/bgmp/commandframework
Command Framework for Bukkit & Bungee 1.8+
https://github.com/bgmp/commandframework
bukkit bungee command-framework
Last synced: 3 months ago
JSON representation
Command Framework for Bukkit & Bungee 1.8+
- Host: GitHub
- URL: https://github.com/bgmp/commandframework
- Owner: BGMP
- License: other
- Created: 2020-08-31T22:39:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-13T04:20:49.000Z (3 months ago)
- Last Synced: 2025-04-13T04:31:42.218Z (3 months ago)
- Topics: bukkit, bungee, command-framework
- Language: Java
- Homepage:
- Size: 288 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CommandFramework
---
The simplest command framework for Bukkit & Bungee 1.8+.
This is the old command framework from sk89q's WorldEdit. It has been factored out and modified, so it may be used in
other projects without having to include WorldEdit as a dependency.
The groupId of the project has been changed to prevent clashes with WorldEdit's command utility classes, given that
it is usually present in upstream Minecraft servers.
## Usage
This project is available for anyone to use. In order to include this project as a dependency, you must
[authenticate to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages)
via your Maven `settings.xml`.
After you accomplish that, simply add the repository and dependencies as follows:
**Maven Repository**
```xml
github
https://maven.pkg.github.com/BGMP/CommandFramework
```
**Bukkit**
```xml
cl.bgm
command-framework-bukkit
1.0.4-SNAPSHOT
```
**Bungee**
```xml
cl.bgm
command-framework-bungee
1.0.4-SNAPSHOT
```
Documentation is still being worked on, but for a hands-on example I have taken care of arranging a
[simple plugin](https://github.com/BGMP/CommandFramework/tree/master/example-commands-bukkit) to illustrate
the framework's features and usage.
## Prerequisites
* Java 8 or above
* [Maven](http://maven.apache.org/) (Dependency Management)
## Compiling
Clone the repository, and launch your command prompt within it to run the following Maven command:
> `mvn clean package`
## Contributing
Your submissions have to be licenced under the GNU General Public Licence v3.