Skip to content
Java Command Dispatch Framework - (Bukkit, Spigot, Paper, Sponge, Bungee supported, generically usable anywhere)
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea Add support for CommandPermission annotation as parameter for permiss… ( Mar 9, 2019
bukkit Fix memory leak in unregister command (#208) Apr 15, 2019
bungee More work towards relocating OnlinePlayer context Feb 24, 2019
core Make InvalidCommandArgument a runtime exception Apr 3, 2019
docs (DEPLOYED ACF) Updated JavaDocs Apr 7, 2019
example compute BaseCommand permissions before RegisteredCommands Mar 15, 2019
jda Add unregister method for JDA (#174) Oct 23, 2018
languages Add bulgarian language (#204) Mar 28, 2019
paper Fix Forwarded Commands completion and misc improvements Feb 4, 2019
sponge Fix getFirstElement to not care if there is more than 1 Feb 24, 2019
velocity More work towards relocating OnlinePlayer context Feb 24, 2019
.gitignore Drop trivial Guava usages (#142) Jul 19, 2018
.travis.yml
APACHE_COMMONS_LANG_LICENSE.txt Refactor everything to a modular format - WIP May 20, 2017
CHANGELOG.md Add CHANGELOG, update readme for 0.5.0 release Jun 18, 2017
CONTRIBUTING.md Add contributing doc Mar 30, 2018
CONTRIBUTORS.md Sanitize Bukkit Command Label Before Passing On (#149) Jul 4, 2018
LICENSE Update LICENSE Mar 30, 2018
README.md lets try this Sep 7, 2017
deploy.sh (DEPLOYED ACF) Updated JavaDocs Jan 15, 2018
pom.xml Added basic JUnit5 testing framework. (#202) Mar 23, 2019

README.md

Annotation Command Framework (ACF)

Purpose

This is the Framework created for Empire Minecraft.

ACF Started as a Bukkit Command Framework, but has shifted to be platform agnostic and can be used on any Java based application.

ACF is an extremely powerful command framework that takes nearly every concept of boilerplate code commonly found in command handlers, and abstracts them away behind annotations.

ACF redefines how you build your command handlers, allowing things such as Dependency Injection, Validation, Tab Completion, Help Documentation, Syntax Advice, and Stateful Conditions to all be behind Annotations that you place on methods.

Clean up your command handlers and unleash rich command experiences that would be too burdensome to pull off manually.

Beta Testing

While the 0.x.x series of ACF is "Beta", note that it is very stable. It has been used for years on EMC.

It is labeled Beta as the framework is growing fast and gaining new features, and API's are subject to breakage. The new features also may contain bugs, but we will work to fix them fast.

Please be prepared to keep up with changes, but I try to keep them as least disruptful as possible.

v1.0.0 will be the signal that ACF features are more complete and the API will remain stable for a long time.

Documentation / Using ACF

Documentation Wiki - All of ACF's documentation is currently on the GitHub Wiki. Please review every page to learn about each feature.

See Using ACF on how to add ACF to your plugin and getting started.

See Examples for some real world examples

Targeted Platforms / Current Version

We are on version:

  • GROUP: co.aikar
  • VERSION 0.5.0-SNAPSHOT

ARTIFACTID varies by platform target:

  • Bukkit: acf-bukkit (For targetting Bukkit/Spigot)
  • Paper: acf-paper (Recommended over Bukkit, will gradually enhance when ran on Paper, but still runs on Spigot)
  • Sponge: acf-sponge
  • BungeeCord: acf-bungee
  • JDA: acf-jda - IN PROGRESS - NOT READY

Setup Guides (Repo and Requirements): Maven, Gradle You may include more than 1 platform in your jar if your plugin supports multiple platforms.

Any bump in version implies an API break. See CHANGELOG for information on migration guides for API breaks.

Every change that should not cause any API break will be deployed over the current version.

Say Thanks

If this library has helped you, please consider donating as a way of saying thanks

PayPal Donate

Why does it require Java 8+?

Get off your dinosaur and get on this rocket ship!

Dinosaurs have been dead for a long time, so get off it before you start to smell.

Download Java 8

Java Docs

Contributing

See Issues section.

Join #aikar on Spigot IRC - irc.spi.gt to discuss.

Or Code With Aikar Discord.

Other projects by Aikar / Empire Minecraft

  • TaskChain - Powerful context control to dispatch tasks Async, then access the result sync for API usage. Concurrency controls too.
  • IDB - Simple and Intuitive JDBC Wrapper for Java
  • Minecraft Timings - Add Timings to your plugin in a safe way that works on all Bukkit platforms (CraftBukkit - no timings, Spigot - Timings v1, Paper and Paper forks - Timings v2)

License

As with all my other public projects

Commands (c) Daniel Ennis (Aikar) 2016-2018.

Commands is licensed MIT. See LICENSE

You can’t perform that action at this time.