Leahnaya/wiiu-chat-secure
1
0
Fork 0
mirror of https://github.com/PretendoNetwork/wiiu-chat-secure.git synced 2026-03-21 17:44:55 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add README.md

Browse Source
This commit is contained in:
SuperMarioDaBom 2025-02-21 09:58:16 -08:00
parent 27832adf17
commit 241997ef9b
1 changed files with 57 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md Normal file
View File

@ -0,0 +1,57 @@
# Wii U Chat 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/wiiu-chat
$ cd wiiu-chat
```
### 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/wiiu-chat
```
The server is now built to `build/wiiu-chat`
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
Install `make` either through your systems package manager or the [official download](https://www.gnu.org/software/make/). We provide a `default` rule which compiles [using `go`](#compiling-using-go)
To build using `go`
```bash
$ make
```
The server is now built to `build/wiiu-chat`
## Configuration
All configuration options are handled via environment variables
`.env` files are supported
| Name | Description | Required |
| ---- | ----------- | -------- |
| `PN_WUC_POSTGRES_URI` | Fully qualified URI to your Postgres server (Example `postgres://username:password@localhost/wiiuchat?sslmode=disable`) | Yes |
| `PN_WUC_AUTHENTICATION_SERVER_PORT` | Port for the authentication server | Yes |
| `PN_WUC_SECURE_SERVER_HOST` | Host name for the secure server (should point to the same address as the authentication server) | Yes |
| `PN_WUC_SECURE_SERVER_PORT` | Port for the secure server | Yes |
| `PN_WUC_ACCOUNT_GRPC_HOST` | Host name for your account server gRPC service | Yes |
| `PN_WUC_ACCOUNT_GRPC_PORT` | Port for your account server gRPC service | Yes |
| `PN_WUC_ACCOUNT_GRPC_API_KEY` | API key for your account server gRPC service | No (Assumed to be an open gRPC API) |
| `PN_WUC_FRIENDS_GRPC_HOST` | Host name for your friends server gRPC service | Yes |
| `PN_WUC_FRIENDS_GRPC_PORT` | Port for your friends server gRPC service | Yes |
| `PN_WUC_FRIENDS_GRPC_API_KEY` | API key for your friends server gRPC service | No (Assumed to be an open gRPC API) |