Skip to content

Commit 5980811

Browse files
committed
Add maven info to readme
1 parent de3f259 commit 5980811

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,37 @@ A [Hex Casting](https://github.com/FallingColors/HexMod) addon that runs a debug
1717
- **Breakpoints**: Set breakpoints on specific patterns, or use the Uncaught Mishaps option to pause the debugger when a mishap occurs and see what went wrong.
1818
- **Multiplayer**: Debug your hexes in multiplayer! The debug client connects to a port opened by the game client (configurable, defaults to 4444), and each player can have up to one active debugger instance at a time.
1919

20+
## Maven
21+
22+
Build artifacts are published to the [BlameJared repository](https://maven.blamejared.com/gay/object/hexdebug/) via [Jenkins](https://ci.blamejared.com/job/object-Object/job/HexDebug/).
23+
24+
To depend on HexDebug, add something like this to your build script:
25+
26+
```groovy
27+
repositories {
28+
maven { url = uri("https://maven.blamejared.com") }
29+
}
30+
dependencies {
31+
modImplementation("gay.object.hexdebug:hexdebug-$platform:$hexdebugVersion")
32+
}
33+
```
34+
35+
Full examples:
36+
37+
```groovy
38+
// released versions
39+
modImplementation("gay.object.hexdebug:hexdebug-common:0.1.2+1.20.1")
40+
modImplementation("gay.object.hexdebug:hexdebug-fabric:0.1.2+1.20.1")
41+
modImplementation("gay.object.hexdebug:hexdebug-forge:0.1.2+1.20.1")
42+
43+
// bleeding edge builds
44+
modImplementation("gay.object.hexdebug:hexdebug-common:0.1.2+1.20.1-SNAPSHOT")
45+
modImplementation("gay.object.hexdebug:hexdebug-fabric:0.1.2+1.20.1-SNAPSHOT")
46+
modImplementation("gay.object.hexdebug:hexdebug-forge:0.1.2+1.20.1-SNAPSHOT")
47+
```
48+
49+
Try to avoid using things outside of the `gay.object.hexdebug.api` package, since they may change at any time.
50+
2051
## Attribution
2152

2253
* Textures: SamsTheNerd! ([GitHub](https://github.com/SamsTheNerd), [Modrinth](https://modrinth.com/user/SamsTheNerd))

0 commit comments

Comments
 (0)