quantum-space-buddies/README.md
2022-02-21 04:51:37 -08:00

8.2 KiB

logo

GitHub GitHub release (latest by date) GitHub Release Date GitHub all releases GitHub release (latest by date) GitHub last commit (branch)

Quantum Space Buddies (QSB) is a multiplayer mod for Outer Wilds. The mod uses the OWML mod loader and Mirror for networking.

Spoilers within!

License

Copyright (C) 2020 - 2022 :

  • Henry Pointer (_nebula or misternebula)
  • Will Corby (JohnCorby)
  • Aleksander Waage (AmazingAlek)
  • Ricardo Lopes (Raicuparta)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Installation

  • Install the Outer Wilds Mod Manager;
  • Install Quantum Space Buddies from the mod list displayed in the application;
  • If you can't get the mod manager to work, follow the instructions for manual installation.

Manual installation

Hosting / Connecting

Connecting to a server

  • On the title screen, click the option CONNECT TO MULTIPLAYER.
  • Enter the SteamID of the person you are trying to connect to.
  • Enjoy!

Hosting a server

  • Enter a game. This can be a new expedition or an existing save file.
  • On the pause screen, click the option OPEN TO MULTIPLAYER.
  • Share your Product User ID with the people who want to connect.
  • Enjoy!

Frequently Asked Questions

Requirements

  • Latest version of OWML.
  • Latest version of Mod Manager. (If using)
  • Latest version of Outer Wilds. We cannot guarantee QSB, or OWML, will work on cracked/pirated versions of Outer Wilds. Do not come asking us for help when using pirated versions.
  • Fast and stable internet connection, upload and download.
  • Above minimum Outer Wilds system requirements.

How complete is this mod? How far through the game can I play?

Area of the game Working
Base game ✔️
Echoes of the Eye

Compatibility with other mods

TL;DR - Don't use any mods with QSB that aren't marked as QSB compatible.

QSB relies on object hierarchy to sync objects, so any mod that changes that risks breaking QSB. Also, QSB relies on certain game events being called when things happen in-game. Any mod that makes these things happen without calling the correct events will break QSB. Some mods will work fine and have been tested, like CrouchMod. Others may only work partly, like EnableDebugMode and TAICheat.

Will you make this compatible with NomaiVR?

Short answer : No.

Long answer : Pay me enough money, and maybe I'll consider it.

Why do I keep getting thrown around the ship?

Boring boring physics stuff. The velocity of the ship is synced, as well as the angular velocity. However, this velocity is not also applied to the player. (Or it is sometimes. I don't 100% know.) This means the ship will accelerate, leaving the player "behind". Which makes you fly into the walls alot.

Update: you can attach/detach yourself to/from the ship using the prompt in the upper right corner of the screen.

What's the difference between QSB and Outer Wilds Online?

TL;DR - QSB is multiplayer co-op, Outer Wilds Online is multiplayer not co-op.

QSB is a fully synced game. The other players are actually there in the world, and can affect things. The loop starts/ends at the same time for everyone, and you share ship logs / signal discoveries.

Outer Wilds Online is easier to set up, but much more basic in its features. The other players cannot affect your game, and do not contribute to anything in your save. The loop is entirely per-player.

Why would someone make this mod? Seems like a lot of effort for no reward.

Good question.

Let me know if you find an answer.

Update: a plausible answer is the enjoyment you get seeing/hearing about others playing with their friends :)

Development Setup

  • Download the Outer Wilds Mod Manager and install it anywhere you like;
  • Install OWML using the Mod Manager
  • Clone QSB's source
  • Open the file DevEnv.targets in your favorite text editor
  • (optional if copying built dlls manually) Edit the entry <OwmlDir> to point to your OWML directory (it is installed inside the Mod Manager directory)
  • (optional if no unity project) Edit the entry <GameDir> to point to the directory where Outer Wilds is installed
  • (optional if no unity project) Edit the entry <UnityAssetsDir> to point to the Assets folder of the QSB unity project
  • Open the project solution file QSB.sln in Visual Studio

It is recommended to use the Epic version of Outer Wilds, as you cannot run multiple versions of the Steam version.

A powerful PC is needed for development, due to the high amount of RAM and CPU needed to run 2 or 3 instances of modded Outer Wilds.

It is also recommended to lower all graphics settings to minimum, be in windowed mode, and lower resolution to roughly a quarter of your monitor space. This lets you run multiple instances of Outer Wilds to quickly test QSB.

Warning : Mod development can lead to unexpected errors in your computer system.

  • When editing the networking code, mistakes can lead to QSB overwhelming your network connection with excess packets.
  • Too high RAM usage will lead to Outer Wilds sticking at ~31% loading, then crashing.
  • There have been instances of graphics cards crashing, and needing to be disabled/re-enabled from Device Manager.

Authors and Special Thanks

Authors

Contributers

Special Thanks

  • Thanks to Logan Ver Hoef for help with the game code, and for helping make the damn game in the first place.
  • Thanks to all the people who helped in public tests.

Dependencies

Help / Discuss development / Whatever

Join the Outer Wilds Modding Discord, we have a nice #qsb-bugs-and-questions channel for support, and other channels to discuss modding!