Skip to content

Commit 71c04cb

Browse files
committed
readme: Add note about core library development versions
We have hard dependencies on a lot of unreleased fixes, and a prospective contributor will probably need to make more fixes - so be explicit about how to get set up for that
1 parent 49ffa38 commit 71c04cb

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,30 @@ $ make
3737

3838
The server is now built to `build/minecraft` with the authentication server build string already set
3939

40+
### Developing core libraries
41+
This server depends on [nex-protocols-common-go](https://github.com/PretendoNetwork/nex-protocols-common-go),
42+
[nex-protocols-go](https://github.com/PretendoNetwork/nex-protocols-go), and
43+
[nex-go](https://github.com/PretendoNetwork/nex-go) to implement the bulk of its functionality. Sometimes features or
44+
bugfixes depend on unreleased development versions of these libraries; or changes have to be made at the library level
45+
to work on this server.
46+
47+
To use these unreleased libraries, add a `go.work` file with something like the following content:
48+
```go
49+
go 1.21
50+
51+
use (
52+
.
53+
)
54+
55+
replace (
56+
github.com/PretendoNetwork/nex-go/v2 => ../nex-go
57+
github.com/PretendoNetwork/nex-protocols-go/v2 => ../nex-protocols-go
58+
github.com/PretendoNetwork/nex-protocols-common-go/v2 => ../nex-protocols-common-go
59+
)
60+
```
61+
62+
The build will then build these libraries out of the folders specified instead of pulling the released versions.
63+
4064
## Configuration
4165
All configuration options are handled via environment variables
4266

0 commit comments

Comments
 (0)