Update developer notes

This commit is contained in:
Axionize committed 2024-10-25 14:59:23 -04:00
1 parent fb62b8d99d
commit 4a460f28cd
1 file changed
+4 -8
+4 -8
View File
@@ -1,4 +1,4 @@
Project Structure
## Project Structure
- `common` submodule contains shared code for all platforms.
- It contains the interfaces and abstractions for
@@ -6,11 +6,11 @@ Project Structure
- Scheduling
- Players
- Blocks
- World
- Worlds/Levels
- The Server
- In addition to the interfaces, the code also contains the implementations for
- Commands
- Commands use Brigadier with Reflection to handle version differences. Simply call our command code in common by registering KnockBackSyncCommand.build() and implementing CommandOperations
- Commands use incendio's `cloud` command system. All you have to do to add platform support is to create a CommandManager and call register().
- Handling Events
- Gathering Statistics
- `fabric` contains code for latest fabric version (currently 1.21)
@@ -21,6 +21,7 @@ If you want to add support for a new platform, simply make a new submodule and i
- Checking for Permissions
- Listening for events and calling the right handler
- Players + Blocks + World + Server
- Metrics
You will need to handle events when Players:
- join/leave
@@ -32,8 +33,3 @@ If you find your platform is lacking events, take a look at how the PlayerVeloci
## List of version and platform-specific caveats
- Runnable and manual ping does not work on fabric right now due b/c packetevents. Ping measurement will be less accurate
- Command System
- context.getSource().sendSuccess() takes a Supplier<Component> in > 1.19.4
- context.getSource().sendSuccess() takes a Component in <= 1.19.4
- Component.literal() does not exist in <= 1.18.2