From 9de6b580baef643dd9e37720c3fc6d201295b41c Mon Sep 17 00:00:00 2001 From: fgsfds Date: Wed, 27 Dec 2023 00:37:19 +0100 Subject: [PATCH] port: net: document netplay status --- docs/netplay.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs/netplay.md diff --git a/docs/netplay.md b/docs/netplay.md new file mode 100644 index 000000000..0500a69d7 --- /dev/null +++ b/docs/netplay.md @@ -0,0 +1,47 @@ +## Experimental netplay branch + +This branch contains a **highly experimental** implementation of network play. + +Currently only Combat Sim is partially working with experimental 8 player support and really bad netcode. +Expect nothing to work right. + +### Hosting + +1. Forward the server port (`27100` by default, can be changed in `pd.ini`). + * You can also use something like ZeroTier or Hamachi if you can't port forward. +3. Choose `Network Game` -> `Host Game`, configure the player cap, press `Start Game`. +4. Configure Combat Sim as desired, but do not start it yet. Keep in mind: + * You can save and load the settings as normal. + * Your player will have the config of Combat Sim player 1. +5. Wait for everyone to join. You can use the console (press `~`) to chat in the meantime. +6. Hit Enter/Start. During the game no more players will be able to join. +7. After game is over, you will be kicked back to Combat Sim settings, at which point people can join again and the process repeats from step 3. + +### Joining + +1. Your player will have the config of Combat Sim player 1, so set that up beforehand in the Combat Sim menu. +2. Choose `Network Game` -> `Join Game`, enter the address (and port if it's not 27100), press `Start Game`. +3. If the message says `Waiting for host`, wait until the host configures the game. You can use the console (press `~`) to chat in the meantime or `ESC` to disconnect. +4. The game will start automatically. +5. After the game is over, press Enter/Start on the stats screen and you will be kicked back to the `Waiting for host` screen, at which point the process repeats from step 3. + +### Misc + +* Press `~` to bring up the console, press `F9` for network stats. +* You can chat at any time during a net game by entering messages in the console and hitting Enter. +* Server port and other network settings can be configured in `pd.ini`. +* For a 4+ player game I would recommend changing `Net.Server.UpdateFrames` to `2` in `pd.ini` on the server to lower the bandwidth usage. +* You can paste stuff into the `Enter Address` prompt by hitting `CTRL+V`. +* Expect nothing to work right. + +### Known issues + +* Clients can't throw laptop guns. +* Clients can't dual wield most of the time. +* Clients see rocket rotation incorrectly. +* Clients can't use Slayer fly-by-wire rockets and they will not correctly sync if the server uses them. +* Cloaking device is not synced. +* Most likely only Combat works properly. +* Sims don't work in netgames. +* Pause is not disabled, but will probably break the game. Do not use it. +* Bandwidth consumption on the server is excessively large on the default settings, probably up to 100kbps with 8 players.