mirror of
https://github.com/PretendoNetwork/minecraft-wiiu.git
synced 2026-08-02 16:03:26 -05:00
71c04cbfd3
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
78 lines
4.4 KiB
Markdown
78 lines
4.4 KiB
Markdown
# Minecraft Wii U Edition (Wii U) replacement server
|
|
Includes both the authentication and secure servers
|
|
|
|
## Compiling
|
|
|
|
### Setup
|
|
Install [Go](https://go.dev/doc/install) and [git](https://git-scm.com/downloads), then clone and enter the repository
|
|
|
|
```bash
|
|
$ git clone https://github.com/PretendoNetwork/minecraft-wiiu
|
|
$ cd minecraft
|
|
```
|
|
|
|
### Compiling using `go`
|
|
To compile using Go, `go get` the required modules and then `go build` to your desired location. You may also want to tidy the go modules, though this is optional
|
|
|
|
```bash
|
|
$ go get -u
|
|
$ go mod tidy
|
|
$ go build -o build/minecraft
|
|
```
|
|
|
|
The server is now built to `build/minecraft`
|
|
|
|
When compiling with only Go, the authentication servers build string is not automatically set. This should not cause any issues with gameplay, but it means that the server build will not be visible in any packet dumps or logs a title may produce
|
|
|
|
To compile the servers with the authentication server build string, add `-ldflags "-X 'main.serverBuildString=BUILD_STRING_HERE'"` to the build command, or use `make` to compile the server
|
|
|
|
### Compiling using `make`
|
|
Compiling using `make` will read the local `.git` directory to create a dynamic authentication server build string, based on your repositories remote origin and current commit. It will also use the current folders name as the executables name
|
|
|
|
Install `make` onto your system (this varies by OS), and run `make` while inside the repository
|
|
|
|
```bash
|
|
$ make
|
|
```
|
|
|
|
The server is now built to `build/minecraft` with the authentication server build string already set
|
|
|
|
### Developing core libraries
|
|
This server depends on [nex-protocols-common-go](https://github.com/PretendoNetwork/nex-protocols-common-go),
|
|
[nex-protocols-go](https://github.com/PretendoNetwork/nex-protocols-go), and
|
|
[nex-go](https://github.com/PretendoNetwork/nex-go) to implement the bulk of its functionality. Sometimes features or
|
|
bugfixes depend on unreleased development versions of these libraries; or changes have to be made at the library level
|
|
to work on this server.
|
|
|
|
To use these unreleased libraries, add a `go.work` file with something like the following content:
|
|
```go
|
|
go 1.21
|
|
|
|
use (
|
|
.
|
|
)
|
|
|
|
replace (
|
|
github.com/PretendoNetwork/nex-go/v2 => ../nex-go
|
|
github.com/PretendoNetwork/nex-protocols-go/v2 => ../nex-protocols-go
|
|
github.com/PretendoNetwork/nex-protocols-common-go/v2 => ../nex-protocols-common-go
|
|
)
|
|
```
|
|
|
|
The build will then build these libraries out of the folders specified instead of pulling the released versions.
|
|
|
|
## Configuration
|
|
All configuration options are handled via environment variables
|
|
|
|
`.env` files are supported
|
|
|
|
| Name | Description | Required |
|
|
|-------------------------------------------|-------------------------------------------------------------------------------------------------|-----------------------------------------------|
|
|
| `PN_MINECRAFT_KERBEROS_PASSWORD` | Password used as part of the internal server data in Kerberos tickets | No (Default password `password` will be used) |
|
|
| `PN_MINECRAFT_AUTHENTICATION_SERVER_PORT` | Port for the authentication server | Yes |
|
|
| `PN_MINECRAFT_SECURE_SERVER_HOST` | Host name for the secure server (should point to the same address as the authentication server) | Yes |
|
|
| `PN_MINECRAFT_SECURE_SERVER_PORT` | Port for the secure server | Yes |
|
|
| `PN_MINECRAFT_ACCOUNT_GRPC_HOST` | Host name for your account server gRPC service | Yes |
|
|
| `PN_MINECRAFT_ACCOUNT_GRPC_PORT` | Port for your account server gRPC service | Yes |
|
|
| `PN_MINECRAFT_ACCOUNT_GRPC_API_KEY` | API key for your account server gRPC service | No (Assumed to be an open gRPC API) |
|
|
| `PN_MINECRAFT_ALLOW_PUBLIC_MATCHMAKING` | Set to "1" to enable public matchmaking (unsafe - game has 0 anticheat) | No (Assumed 0) | |