Skip to content

Commit abf16e2

Browse files
committed
add readme
1 parent f8806c9 commit abf16e2

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Official LabyMod 4 Server API Integrations
2+
3+
## Overview
4+
5+
This is the repository for official Integrations for the LabyMod 4 Server API. Integrations are modules that provide
6+
additional functionality to the Server API and are most commonly used to provide the protocol of addons.
7+
8+
## Project Structure
9+
10+
Each Integration is a separate module:
11+
12+
- `betterperspective` - The Integration for the BetterPerspective addon. This Integration does not contain a Protocol
13+
but instead provides a Permission.
14+
- `voicechat` - The Integration for the VoiceChat addon. This Integration provides the Protocol that VoiceChat uses to
15+
communicate with the server.
16+
17+
## Usage
18+
19+
An extensive guide on how to use the LabyMod 4 Server API can be found on
20+
the [LabyMod Developer Portal](https://wiki.labymod.net). Alternatively, feel free to ask for help on
21+
our [Discord Server for Developers](https://labymod.net/dc/dev).
22+
23+
## Building
24+
25+
### Prerequisites
26+
27+
- Java Development Kit (JDK) 17 or higher
28+
29+
### Steps
30+
31+
1. Clone the repository:
32+
```sh
33+
git clone https://github.com/LabyMod/labymod4-server-api-integrations.git
34+
cd labymod4-server-api-integrations
35+
```
36+
37+
2. Build the project using Gradle:
38+
```sh
39+
./gradlew build
40+
```
41+
42+
3. All compiled JAR files are in the `build/commonOutput` directory.
43+
44+
## License
45+
46+
This project is licensed under
47+
the [MIT License](https://github.com/LabyMod/labymod4-server-api-integrations/blob/master/LICENSE).

0 commit comments

Comments
 (0)