mirror/quantum-space-buddies
1
0
Fork 0
mirror of https://github.com/misternebula/quantum-space-buddies.git synced 2025-01-01 03:32:38 +00:00
Code Issues Projects Releases Wiki Activity

Add instructions to readme (#37)

Browse Source 
* Update README.md

* Add credits and discord link

* Add credits and discord link
This commit is contained in:
Ricardo Lopes 2020-02-29 10:51:05 +01:00 committed by GitHub
parent 7d6f9d0a37
commit 356852706e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,5 +1,31 @@
# Quantum Space Buddies - Outer Wilds Online Multiplayer Mod
## Installation
* [Download OWML](https://github.com/amazingalek/owml/releases);
* [Follow OWML's instalation instructions](https://github.com/amazingalek/owml#installation);
* [Download the latest QSB release](https://github.com/Raicuparta/quantum-space-buddies/releases/latest);
* Extract the `QSB` directory to the `OWML/Mods` directory;
* Run `OWML.Launcher.exe` to start the game.
## Playing as a client
* Run `OWML.Launcher.exe` to start the game;
* You'll see some new buttons on the top left;
* Replace `localhost` with the server's IP address;
* Press "LAN Client(C)";
* If you see "Stop (X)", you are connected.
## Playing as a host
* Open port `7777` on your router;
* Run `OWML.Launcher.exe` to start the game;
* You'll see some new buttons on the top left;
* Don't start the game (expedition) before starting the server;
* Press "LAN Host(H)";
* If you now see the "Stop (X)" button, you are serving;
* Give your external IPv4 address to your clients ([like what you see here](http://whatismyip.host/)).
## Development Setup
To get the project to run on Visual Studio and build correctly, you need to set this all up so the project can find its dependencies:
@ -20,3 +46,16 @@ If for some reason none of this is working, you might have to set everything man
* To fix the build paths and automatically copy the files to OWML, edit the "Build Events" in the properties menu.
* 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`).
## Authors
* [AmazingAlek](https://github.com/amazingalek)
* [Raicuparta](https://github.com/Raicuparta)
## Special thanks
* [Mister_Nebula](https://github.com/misternebula), for research
## Help / Discuss development / Whatever
[Join the unofficial Outer Wilds Discord](https://discord.gg/Sftcc9Z), we have a nice `#modding` channel where you can discuss all types of things.