funkemunky/commands
1
0
Fork 0
mirror of https://github.com/aikar/commands.git synced 2026-05-31 06:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Miscellaneous grammar improvements

Browse Source
This commit is contained in:
chickeneer
2021-12-21 20:46:53 -06:00
parent 3295b82df6
commit 4d3b0192fc
10 changed files with 80 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+44 -26
View File
@@ -1,21 +1,27 @@
# Annotation Command Framework (ACF)
## Purpose
This is the Framework created for [Empire Minecraft](https://ref.emc.gs/Aikar?gac=commands.github).
ACF Started as a Bukkit Command Framework, but has shifted to be platform agnostic and can be used on any Java based application.
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 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.
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.
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.
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.
@@ -23,8 +29,8 @@ v1.0.0 will be the signal that ACF features are more complete and the API will r
## Documentation / Using ACF
[Documentation Wiki](https://github.com/aikar/commands/wiki) - All of ACF's documentation is currently on the GitHub Wiki.
Please review every page to learn about each feature.
[Documentation Wiki](https://github.com/aikar/commands/wiki) - All of ACF's documentation is currently on the GitHub
Wiki. Please review every page to learn about each feature.
See [Using ACF](https://github.com/aikar/commands/wiki/Using-ACF) on how to add ACF to your plugin and getting started.
@@ -33,29 +39,36 @@ See [Examples](https://github.com/aikar/commands/wiki/Real-World-Examples) for s
## Targeted Platforms / Current Version
We are on version:
- GROUP: co.aikar
- VERSION `0.5.1-SNAPSHOT`
- GROUP: co.aikar
- VERSION `0.5.1-SNAPSHOT`
ARTIFACTID varies by platform target:
* [Bukkit](https://spigotmc.org): ***acf-bukkit*** (For targetting Bukkit/Spigot)
* [Paper](https://paper.emc.gs): ***acf-paper*** (Recommended over Bukkit, will gradually enhance when ran on Paper, but still runs on Spigot)
* [Sponge](https://www.spongepowered.org/): ***acf-sponge***
* [BungeeCord](https://www.spigotmc.org/wiki/bungeecord/): ***acf-bungee***
* [JDA](https://github.com/DV8FromTheWorld/JDA): ***acf-jda*** - IN PROGRESS - NOT READY
Setup Guides (Repo and Requirements): [Maven](https://github.com/aikar/commands/wiki/Maven-Setup), [Gradle](https://github.com/aikar/commands/wiki/Gradle-Setup)
* [Bukkit](https://spigotmc.org): ***acf-bukkit*** (For targetting Bukkit/Spigot)
* [Paper](https://paper.emc.gs): ***acf-paper*** (Recommended over Bukkit, will gradually enhance when ran on Paper, but
still runs on Spigot)
* [Sponge](https://www.spongepowered.org/): ***acf-sponge***
* [BungeeCord](https://www.spigotmc.org/wiki/bungeecord/): ***acf-bungee***
* [JDA](https://github.com/DV8FromTheWorld/JDA): ***acf-jda*** - IN PROGRESS - NOT READY
Setup Guides (Repo and Requirements): [Maven](https://github.com/aikar/commands/wiki/Maven-Setup)
, [Gradle](https://github.com/aikar/commands/wiki/Gradle-Setup)
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](CHANGELOG.md) for information on migration guides for API breaks.
Any bump in version implies an API break. See [CHANGELOG](CHANGELOG.md) 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](https://aikar.co/donate.png "Donate with PayPal")](https://paypal.me/empireminecraft)
## 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.
@@ -63,26 +76,31 @@ Dinosaurs have been dead for a long time, so get off it before you start to smel
[Download Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
# Java Docs
- [ACF (Core)](https://aikar.github.io/commands/acf-core)
- [ACF (Bukkit)](https://aikar.github.io/commands/acf-bukkit)
- [ACF (Sponge)](https://aikar.github.io/commands/acf-sponge)
- [ACF (Bungee)](https://aikar.github.io/commands/acf-bungee)
- [ACF (JDA)](https://aikar.github.io/commands/acf-jda)
## Contributing
See Issues section.
Join [#aikar on Spigot IRC - irc.spi.gt](https://aikarchat.emc.gs) to discuss.
See Issues section.
Join [#aikar on Spigot IRC - irc.spi.gt](https://aikarchat.emc.gs) to discuss.
Or [Code With Aikar](https://aikardiscord.emc.gs) Discord.
## Other projects by Aikar / Empire Minecraft
- [TaskChain](https://taskchain.emc.gs) - Powerful context control to dispatch tasks Async, then access the result sync for API usage. Concurrency controls too.
- [IDB](https://idb.emc.gs) - Simple and Intuitive JDBC Wrapper for Java
- [Minecraft Timings](https://github.com/aikar/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)
- [TaskChain](https://taskchain.emc.gs) - Powerful context control to dispatch tasks Async, then access the result sync
for API usage. Concurrency controls too.
- [IDB](https://idb.emc.gs) - Simple and Intuitive JDBC Wrapper for Java
- [Minecraft Timings](https://github.com/aikar/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.