Sign inSign up

crunch41/citron-room-server

By crunch41

•Updated 8 months ago

Dedicated multiplayer room server for the Citron Nintendo Switch Emulator.

Image
0

1.7K

crunch41/citron-room-server repository overview

⁠Citron Room Server

Dedicated multiplayer server for Citron Nintendo Switch Emulator with critical bug fixes.

⁠Quick Start

⁠Private Room
docker run -d -p 24872:24872/tcp -p 24872:24872/udp \
  -e ROOM_NAME="My Room" \
  -e PREFERRED_GAME="Super Smash Bros" \
  crunch41/citron-room-server
⁠Public Room
docker run -d -p 24872:24872/tcp -p 24872:24872/udp \
  -e ROOM_NAME="My Public Room" \
  -e PREFERRED_GAME="Super Smash Bros" \
  -e USERNAME="your_username" \
  -e TOKEN="your-token" \
  -e WEB_API_URL="https://api.ynet-fun.xyz" \
  crunch41/citron-room-server
⁠Working Example (Unraid)

Real-world public room configuration:

docker run -d -p 24872:24872/tcp -p 24872:24872/udp \
  -e ROOM_NAME="My Awesome Server" \
  -e ROOM_DESCRIPTION="Welcome to my room!" \
  -e PREFERRED_GAME="Mario Kart 8" \
  -e PREFERRED_GAME_ID="0100152000022000" \
  -e USERNAME="YourUsername" \
  -e TOKEN="12345678-1234-1234-1234-123456789abc" \
  -e WEB_API_URL="https://api.ynet-fun.xyz" \
  -v /mnt/cache/appdata/citron-room:/home/citron/.local/share/citron-room \
  crunch41/citron-room-server

⁠Environment Variables

VariableRequiredDefaultDescription
ROOM_NAMEYes-Room name (shown in lobby)
PREFERRED_GAMEYes-Game name (shown in lobby)
ROOM_DESCRIPTIONNo-Room description
USERNAMEFor public-Your username
TOKENFor public-Your token
WEB_API_URLFor public-API URL
PREFERRED_GAME_IDNo0Game ID (hex)
MAX_MEMBERSNo16Max players (2-254)
PASSWORDNo-Room password
ENABLE_CITRON_MODSNofalseAllow mods

Note: ROOM_NAME and PREFERRED_GAME are required. Server will fail to start without them.

⁠Persistent Data

Mount a volume to save ban list and logs:

-v /mnt/cache/appdata/citron-room:/home/citron/.local/share/citron-room

Files stored:

  • ban_list.txt - Banned usernames and IPs
  • citron-room.log - Server logs

Ban list format:

CitronRoom-BanList-1
username1

192.168.1.100

⁠Bug Fixes

This image fixes 5 critical bugs in vanilla Citron that cause instant crashes with public room credentials.

⁠More Information

Auto-builds: Daily when citron-room source files change
Support: https://github.com/Crunch41/citron-room-docker/issues⁠

Tag summary

Content type

Image

Digest

sha256:da6d2d7fd…

Size

142.8 MB

Last updated

8 months ago

docker pull crunch41/citron-room-server