Skip to content

Commit 175fb55

Browse files
Update README
Might need more changes
1 parent 5c9ddad commit 175fb55

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
[![discord-singular](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-singular_vector.svg)](https://discord.offsetmonkey538.top/)
33
[![modrinth](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg)](https://modrinth.com/mod/mesh-lib)
44

5-
Easy to use library for running your HTTP server on the same port as the Minecraft server.
5+
Easy to use library for running your HTTP server on the same port as the Minecraft server.
6+
Available for both fabric and paper.
67

78
Javadoc is available [here](https://maven.offsetmonkey538.top/javadoc/releases/top/offsetmonkey538/meshlib/mesh-lib/latest)
89

@@ -32,12 +33,15 @@ repositories {
3233
}
3334
```
3435

35-
Then include the library in your dependencies block:
36+
This library is meant to be used as a JIJ (Jar-In-Jar), meaning you include it inside your mod/plugin.
37+
To do that you can use `include` for fabric and the shadow gradle plugin for paper:
3638
```groovy
3739
dependencies {
38-
// Others
40+
// For fabric
41+
include modImplementation("top.offsetmonkey538.meshlib:mesh-lib-fabric:1.0.3+1.21.4")
3942
40-
include modImplementation("top.offsetmonkey538.meshlib:mesh-lib:1.0.0+1.21")
43+
// For paper
44+
implementation "top.offsetmonkey538.meshlib:mesh-lib-paper:1.0.3+1.21.4"
4145
}
4246
```
4347
Make sure to use the latest version.
@@ -75,7 +79,7 @@ public void handleRequest(@NotNull ChannelHandlerContext ctx, @NotNull FullHttpR
7579
}
7680
```
7781

78-
Finally, you'll need to actually register your handler. Put this in your mod initializer:
82+
Finally, you'll need to actually register your handler. Put this in your mod or plugin initializer:
7983
```java
8084
@Override
8185
public void onInitializeServer() {

0 commit comments

Comments
 (0)