Add milestones list
This commit is contained in:
parent
47de022bb7
commit
4f40b57d34
1 changed files with 23 additions and 1 deletions
24
README.md
24
README.md
|
@ -1,10 +1,32 @@
|
|||
# Uranos
|
||||
|
||||
## Milestones
|
||||
|
||||
- Players can see entities
|
||||
- Players can see other players
|
||||
- Players can send and receive chat messages
|
||||
- Players can see Titles
|
||||
- Weather and time
|
||||
- Players can hear sounds
|
||||
- Players can see particles
|
||||
- Players can have items (with metadata) in their inventory
|
||||
- Inventories
|
||||
- World modifications are sent to players
|
||||
- Crafting
|
||||
- PlayerInteract events are emitted when blocks are clicked
|
||||
- Command framework + permissions
|
||||
- Commands can be sent from the console
|
||||
- Players can be teleported between worlds
|
||||
- Entity AI framework
|
||||
- Scoreboards + Teams
|
||||
|
||||
## Conventions
|
||||
|
||||
### KDoc
|
||||
|
||||
1. If the name of the target is already sufficient for understanding what it does/represents, you should **not** add a comment. But if you want to provide additional information, you should start the comment with a short description nevertheless.
|
||||
1. If the name of the target is already sufficient for understanding what it does or what it's value represents, you
|
||||
should **not** add a comment. If you want to provide additional information however, you should start the comment
|
||||
with a short description nevertheless.
|
||||
2. The name of the return type, property type or type of the enclosing class should **not** be wrapped in square
|
||||
brackets.
|
||||
3. If a comment only consists of the `@returns` block tag, the latter should be replaced with a sentence starting with
|
||||
|
|
Reference in a new issue