Skip to content

Commit

Permalink
Mention module structure in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Andre601 committed May 18, 2021
1 parent 1a0bab1 commit 4810048
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@ You should find the plugin jars in `bungeecord/target`, `velocity-legacy/target`
Any contribution is welcome when it helps improving the plugin's performance.
Just make sure the code is readable and easy to understand for others.

### Modules
The project is split into 4 different modules which all have their own purpose.

#### `core`
The `core` module contains platform-independent code that will be used by the other modules.
Whenever you add a new feature that should be used on BungeeCord AND Velocity should you first try to make it platform-independent by adding it to this module.

#### `bungeecord`
The `bungeecord` module contains code specific to BungeeCord and maybe also some Waterfall-specific code.

#### `velocity`
The `velocity` module contains code specific to Velocity 2.0.0 or higher.
The generated jar from this module is incompatible with Velocity 1.x!

#### `velocity-legacy`
The `velocity-legacy` module contains the original code for Velocity 1.x.
The generated jar from this module is incompatible with Velocity 2.0.0 or newer.

## Links
- [Spigot]
- [Wiki]
Expand Down

0 comments on commit 4810048

Please sign in to comment.