Explain project goals

This commit is contained in:
Alexander Söderberg 2020-09-01 22:42:00 +02:00
parent e6f7d04495
commit b05b428f3c
No known key found for this signature in database
GPG key ID: C0207FF7EA146678

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# commands
This is going to be a general-purpose Java command library. It will allow programmers
to define command chains that users can use to execute pre-defined actions.
The code is based on a paper that can be found [here](https://github.com/Sauilitired/Sauilitired/blob/master/AS_2020_09_Commands.pdf).
## Goals
- Allow for commands to be defined using builder patterns
- Allow for commands to be defined using annotated methods
- Allow for command pre-processing
- Allow for command suggestion outputs
Once the core functionality is present additional goals are:
- Create a Minecraft specific implementation and add appropriate bindings
- Create a Discord implementation
- Create a Java CLI implementation