You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-14Lines changed: 44 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,50 @@
1
1
# Quantum Space Buddies - Outer Wilds Online Multiplayer Mod
2
2
3
+
Quantum Space Buddies (QSB) is a multiplayer mod for Outer Wilds. The mod uses the OWML mod loader and customized UNET code (internally referred to as "QuantumUNET") for networking.
4
+
5
+
**Disclamer - The mod authors (misternebula, AmazingAlek and Raicuparta) take no responsibility for any damages that are caused through opening ports on your network, or connecting to servers. Do not attempt to change your router settings without prior knowledge of what you are doing. Only share your public IP with people you trust, and don't connect to IPs that you do not know the source of. It is good practice to close ports/firewall exceptions after you have finished playing.**
6
+
3
7
<!-- TOC -->
4
8
9
+
-[FAQs](#frequently-asked-questions)
10
+
-[What is synced?](#what-is-currently-synced)
11
+
-[Why can't I connect?](#why-cant-i-connect-to-a-server)
-[Help / Discuss development / Whatever](#help--discuss-development--whatever)
14
20
15
21
<!-- /TOC -->
16
22
23
+
## Frequently Asked Questions
24
+
25
+
### What is currently synced?
26
+
QSB does not operate on a strict server-client relationship. Each player's game is left as a completely seperate game, and individual elemets are synced or patched so they can be controlled though network messages. Right now, the list of synced objects are :
27
+
- Geysers
28
+
- Elevators
29
+
- Nomai interface orbs
30
+
- Player animations
31
+
- Player tools
32
+
- Player ships
33
+
- Player probes
34
+
- NPC heads in conversations
35
+
36
+
### Why can't I connect to a server?
37
+
#### For the host :
38
+
- Open port 7777 TCP and UDP on your router. If access the internet through multiple layers of routers, the port will need to be opened on every router.
39
+
- Open port 7777 TCP and UDP in and out on your firewall. Some AVs might block you editing firewall settings, so check with your specific software.
40
+
- Make sure you are giving your public IPv4 address to your clients.
41
+
#### For the client :
42
+
- Open port 7777 TCP and UDP in and out on your firewall. Some AVs might block you editing firewall settings, so check with your specific software.
43
+
- Sometimes, it has helped to change your network profile to "private".
44
+
- Make sure you are putting the right address into the address box.
45
+
46
+
If nothing here works, many people have got QSB working through programs such as Hamachi. Also make sure you are not running through a VPN while trying to connect.
-[Download the latest Quantum Space Buddies release](https://github.com/Raicuparta/quantum-space-buddies/releases/latest);
59
+
-[Download the latest Quantum Space Buddies release](https://github.com/misternebula/quantum-space-buddies/releases/latest);
29
60
- Extract the `QSB` directory to the `OWML/Mods` directory;
30
61
- Run `OWML.Launcher.exe` to start the game.
31
62
32
63
## Playing as a client
33
64
34
65
- Run the game;
35
66
- You'll see some new buttons on the top left;
36
-
- Replace `localhost` with the server's IP address;
37
-
- Press "LAN Client(C). You can join servers in the menu or in-game, but it is recommended to join in the main menu.";
38
-
- If you see "Stop (X)", you are connected.
67
+
- Replace `localhost` with the server's public IP address;
68
+
- Press "Connect". You can join servers in the menu or in-game, but it is recommended to join in the main menu.";
69
+
- If you see "Stop", you are connected.
70
+
- If it stops at "Connecting to..." then you or the host has issues with their firewall/router/other.
39
71
40
72
## Playing as a host
41
73
42
-
- Open port `7777` on your router;
43
-
- Run the game;
44
-
- You'll see some new buttons on the top left;
45
-
- Press "LAN Host(H)". This can be done in-game or in the menu, but it is recommened to start servers in the menu.;
46
-
- If you now see the "Stop (X)" button, you are serving;
74
+
- Open port `7777` on your router.;
75
+
- Run the game.;
76
+
- You'll see some new buttons on the top left.;
77
+
- Press "Host". This can be done in-game or in the menu, but it is recommened to start servers in the menu.;
78
+
- If you now see the "Stop" button, you are hosting.;
47
79
- Give your external IPv4 address to your clients ([like what you see here](http://whatismyip.host/)).
48
80
49
81
## Development Setup
50
82
51
-
-[Download the Outer Wilds Mod Manager](https://github.com/Raicuparta/ow*mod*manager) and install it anywhere you like;
83
+
-[Download the Outer Wilds Mod Manager](https://github.com/misternebula/ow*mod*manager) and install it anywhere you like;
52
84
- Install OWML using the Mod Manager;
53
85
- Clone QSB's source;
54
86
- Open the file `QSB/QSB.csproj.user` in your favorite text editor;
@@ -65,11 +97,9 @@ If for some reason none of this is working, you might have to set everything man
65
97
- To fix the references, right*click "References" in the Solution Explorer > "Add Reference", and add all the missing DLLs (references with yellow warning icon). You can find these DLLs in the game's directory (`OuterWilds\OuterWilds_Data\Managed`);
66
98
- If Visual Studio isn't able to automatically copy the files, you'll have to copy the built dlls manually to OWML.
67
99
68
-
Refer to this repo's wiki for documentation on core QSB design specifications and mechanics.
69
-
70
100
## Authors
71
101
72
-
-[Mister_Nebula](https://github.com/misternebula) - Developer of v0.3 onwards
102
+
-[\_nebula](https://github.com/misternebula) - Developer of v0.3 onwards
73
103
-[AmazingAlek](https://github.com/amazingalek) - On-and-off developer and sometimes code tidyer
74
104
-[Raicuparta](https://github.com/Raicuparta) - Developer of v0.1 - v0.2
0 commit comments