Skip to content

Latest commit

 

History

History
140 lines (118 loc) · 6.03 KB

README.md

File metadata and controls

140 lines (118 loc) · 6.03 KB
Raw

docker-yuzu-room logo

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

Docker Tag Version Platform Description
latest 1.4 amd64, arm64 Latest release (Mainline 1734)
1.4 1.4 amd64, arm64 Latest release (Mainline 1734)
1.3 1.3 amd64 v1.3 (Legacy) (Mainline 1734)

Environment variables • Password protection • Usage • Using Compose • Manual build • License

Environment variables

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

Click to expand
Variable Default value Description
YUZU_BINDADDR 0.0.0.0 Host to bind to.
YUZU_PORT 24872 Port to listen on (TCP/UDP).
YUZU_ROOMNAME yuzu Room Name of the room.
YUZU_PREFGAME Any Name of the preferred game.
YUZU_MAXMEMBERS 4 Maximum number of members (2-16).
YUZU_BANLISTFILE bannedlist.ybl File which yuzu will store ban records in.
YUZU_LOGFILE yuzu-room.log File path to store the logs.
YUZU_ROOMDESC (Optional) Description of the room.
YUZU_PREFGAMEID 0 (Optional) Preferred game title identifier. You can find the Title ID with the game list of yuzu (right-click on a game -> Properties).
YUZU_PASSWORD (Optional) Room password (NOT recommended, see the section below).
YUZU_ISPUBLIC 0 (Optional) Make the room public. Valid User Token and Web API URL are required.
YUZU_TOKEN (Optional) The user token to use for the room. Required to make the room public.
YUZU_WEBAPIURL (Optional) URL to the custom web API. Required to make the room public.

Password protection

The server can be protected with a (clear, unencrypted) password by:

— Bind mounting a text file containing the password into the container.
The mount point path must be /run/secrets/yuzuroom.
This is the recommended method. See the second example in the section below.

— Using the YUZU_PASSWORD environment variable when creating the container.
This method is NOT recommended for production, as all environment variables are visible via docker inspect to any user that can use the docker command.

Usage

Example 1:
Run a public server for SSB. Ultimate on default port 24872 with a maximum of 16 members:
— You need a valid User Token to make the server reachable via the public room browser.

docker run -d \
  --name yuzu-room \
  -p 24872:24872/tcp \
  -p 24872:24872/udp \
  -e YUZU_ROOMNAME="USA East - SSB. Ultimate" \
  -e YUZU_ROOMDESC="Fight On!" \
  -e YUZU_PREFGAME="SSB. Ultimate" \
  -e YUZU_PREFGAMEID="01006A800016E000" \
  -e YUZU_MAXMEMBERS=16 \
  -e YUZU_ISPUBLIC=1 \
  -e YUZU_TOKEN="<USER_TOKEN>" \
  -e YUZU_WEBAPIURL="<CUSTOM_API_URL>" \
  -i k4rian/yuzu-room

Example 2:
Run a password-protected server with default settings on port 51267:
— In this example, the password is stored in the secret.txt file located in the current working directory.

docker run -d \
  --name yuzu-room \
  -p 51267:51267/tcp \
  -p 51267:51267/udp \
  -e YUZU_PORT=51267 \
  -v "$(pwd)"/secret.txt:/run/secrets/yuzuroom:ro \
  -i k4rian/yuzu-room

Example 3:
Run a password-protected testing server on port 5555:

docker run -d \
  --name yuzu-room-test \
  -p 5555:5555/tcp \
  -p 5555:5555/udp \
  -e YUZU_PORT=5555 \
  -e YUZU_PASSWORD="testing" \
  -i k4rian/yuzu-room

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-yuzu-room.git .
  • Then run the following command inside the newly created folder:
docker build --no-cache -t k4rian/yuzu-room .

The building process can take up to 10 minutes depending on your hardware specs.
A quad-core CPU with at least 1 GB of RAM and 3 GB of disk space is recommended for the compilation.

License

GPL-3.0