K4rian / docker-simple64-netplay-server

A Docker image for the simple64 dedicated multiplayer server based on Alpine Linux.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docker-simple64-netplay-server logo

A Docker image for the simple64 local multiplayer netplay server based on the official Alpine Linux image.
The server allows you to play N64 games via netplay using the simple64 emulator.


Docker Tag Version Description Platform
latest 1.1 Latest release amd64, arm64
2024.03.1 1.1 S64NS v2024.03.1 amd64, arm64
2024.01.1 1.1 S64NS v2024.01.1 amd64, arm64

Environment variablesUsageUsing ComposeManual buildLicense


Environment variables

A few environment variables can be tweaked when creating a container to define the server configuration:

Click to expand
Variable Default value Description
S64NS_NAME simple64 Netplay Server Server name.
S64NS_PORT 45000 Port1 to listen on (TCP/UDP).
S64NS_LOGPATH simple64-netplay-server.log File path to store the logs.
S64NS_MOTD Message of the day to display to clients.
S64NS_MAXGAMES 10 Maximum number of concurrent games.
S64NS_DISABLEBROADCAST false Disable LAN broadcast.
S64NS_ENABLEAUTH false (undocumented) Enable client authentication.

1 The server requires the following extra ports to be opened: 45001-45010 (TCP/UDP).

Usage

Run a public server using default ports configuration with a maximum of 20 concurrents games and a custom MOTD:

docker run -d \
  --name simple64-netplay-server \
  -p 45000-45010:45000-45010/tcp \
  -p 45000-45010:45000-45010/udp \
  -e S64NS_PORT=45000 \
  -e S64NS_MOTD="Don't forget your martini!" \
  -e S64NS_MAXGAMES=20 \
  -i k4rian/simple64-netplay-server:latest

Using Compose

See compose/README.md

Manual build

Requirements:
— Docker >= 18.09.0
— Git (optional)

Like any Docker image the building process is pretty straightforward:

  • Clone (or download) the GitHub repository to an empty folder on your local machine:
git clone https://github.com/K4rian/docker-simple64-netplay-server.git .
  • Then run the following command inside the newly created folder:
docker build --no-cache -t k4rian/simple64-netplay-server .

License

GPL-3.0

About

A Docker image for the simple64 dedicated multiplayer server based on Alpine Linux.

License:GNU General Public License v3.0


Languages

Language:Shell 50.9%Language:Dockerfile 49.1%