|
1 | 1 | # Quantum Space Buddies - Outer Wilds Online Multiplayer Mod |
2 | 2 |
|
| 3 | +<!-- TOC --> |
| 4 | + |
| 5 | +- [Installation](#installation) |
| 6 | + - [Easy installation (recommended)](#easy-installation-recommended) |
| 7 | + - [Manual installation](#manual-installation) |
| 8 | +- [Playing as a client](#playing-as-a-client) |
| 9 | +- [Playing as a host](#playing-as-a-host) |
| 10 | +- [Development Setup](#development-setup) |
| 11 | +- [Authors](#authors) |
| 12 | +- [Special thanks](#special-thanks) |
| 13 | +- [Help / Discuss development / Whatever](#help--discuss-development--whatever) |
| 14 | + |
| 15 | +<!-- /TOC --> |
| 16 | + |
3 | 17 | ## Installation |
4 | 18 |
|
5 | | -* [Download OWML](https://github.com/amazingalek/owml/releases); |
6 | | -* [Follow OWML's instalation instructions](https://github.com/amazingalek/owml#installation); |
7 | | -* [Download the latest QSB release](https://github.com/Raicuparta/quantum-space-buddies/releases/latest); |
8 | | -* Extract the `QSB` directory to the `OWML/Mods` directory; |
9 | | -* Run `OWML.Launcher.exe` to start the game. |
| 19 | +### Easy installation (recommended) |
| 20 | + |
| 21 | +- [Install the Outer Wilds Mod Manager](https://github.com/Raicuparta/ow-mod-manager#how-do-i-use-this); |
| 22 | +- Install Quantum Space Buddies from the mod list displayed in the application; |
| 23 | +- If you can't get the mod manager to work, follow the instructions for manual installation. |
| 24 | + |
| 25 | +### Manual installation |
| 26 | + |
| 27 | +- [Install OWML](https://github.com/amazingalek/owml#installation); |
| 28 | +- [Download the latest Quantum Space Buddies release](https://github.com/Raicuparta/quantum-space-buddies/releases/latest); |
| 29 | +- Extract the `QSB` directory to the `OWML/Mods` directory; |
| 30 | +- Run `OWML.Launcher.exe` to start the game. |
10 | 31 |
|
11 | 32 | ## Playing as a client |
12 | 33 |
|
13 | | -* Run `OWML.Launcher.exe` to start the game; |
14 | | -* You'll see some new buttons on the top left; |
15 | | -* Replace `localhost` with the server's IP address; |
16 | | -* Press "LAN Client(C)"; |
17 | | -* If you see "Stop (X)", you are connected. |
| 34 | +- Run `OWML.Launcher.exe` to start the game; |
| 35 | +- You'll see some new buttons on the top left; |
| 36 | +- Replace `localhost` with the server's IP address; |
| 37 | +- Press "LAN Client(C)"; |
| 38 | +- If you see "Stop (X)", you are connected. |
18 | 39 |
|
19 | 40 | ## Playing as a host |
20 | 41 |
|
21 | | -* Open port `7777` on your router; |
22 | | -* Run `OWML.Launcher.exe` to start the game; |
23 | | -* You'll see some new buttons on the top left; |
24 | | -* Don't start the game (expedition) before starting the server; |
25 | | -* Press "LAN Host(H)"; |
26 | | -* If you now see the "Stop (X)" button, you are serving; |
27 | | -* Give your external IPv4 address to your clients ([like what you see here](http://whatismyip.host/)). |
| 42 | +- Open port `7777` on your router; |
| 43 | +- Run `OWML.Launcher.exe` to start the game; |
| 44 | +- You'll see some new buttons on the top left; |
| 45 | +- Don't start the game (expedition) before starting the server; |
| 46 | +- Press "LAN Host(H)"; |
| 47 | +- If you now see the "Stop (X)" button, you are serving; |
| 48 | +- Give your external IPv4 address to your clients ([like what you see here](http://whatismyip.host/)). |
28 | 49 |
|
29 | 50 | ## Development Setup |
30 | 51 |
|
31 | | -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: |
32 | | - |
33 | | -* [Install OWML](https://github.com/amazingalek/owml#installation) in the game's directory (should be something like `C:\Program Files\Epic Games\OuterWilds\OWML`); |
34 | | -* If you already have QSB installed, remove it from the `OWML/Mods` directory; |
35 | | -* Clone QSB's source; |
36 | | -* Open the project solution file `QSB.sln` in Visual Studio; |
37 | | -* On the Solution Explorer (usually the right side panel), under the project-name (NomaiVR), double click "Properties"; |
38 | | -* Go to "Debug" and change "Working Directory" to **OWML's directory**; |
39 | | -* Do the same thing for all the other projects in the QSB solution; |
40 | | -* If needed, right click `References` in the Solution Explorer > Manage NuGet Packages > Update OWML to fix missing references; |
41 | | -* In the top menu go to "Project" > "Unload Project", and then "Project" > "Reload Project". |
| 52 | +- [Download the Outer Wilds Mod Manager](https://github.com/Raicuparta/ow*mod*manager) and install it anywhere you like; |
| 53 | +- Install OWML using the Mod Manager; |
| 54 | +- Clone QSB's source; |
| 55 | +- Open the file `QSB/QSB.csproj.user` in your favorite text editor; |
| 56 | +- Edit the entry `<GameDir>` to point to the directory where Outer Wilds is installed; |
| 57 | +- Edit the entry `<OwmlDir>` to point to your OWML directory (it is installed inside the Mod Manager directory); |
| 58 | +- Open the project solution file `QSB.sln` in Visual Studio; |
| 59 | +- If needed, right click `References` in the Solution Explorer > Manage NuGet Packages > Update OWML to fix missing references; |
42 | 60 |
|
43 | | -After doing this, the project references should be working. When you build the solution, the dll and json files will be copied to `OWML/Mods/QSB`, so you can start the game through OWML and test right away. |
| 61 | +After doing this, the project references should be working. When you build the solution, the dll and json files will be copied to `[Mod Manager directory]/OWML/QSB`. If this process is successful, you should see the mod show up in the Mod Manager. |
44 | 62 |
|
45 | 63 | If for some reason none of this is working, you might have to set everything manually: |
46 | 64 |
|
47 | | -* To fix the build paths and automatically copy the files to OWML, edit the "Build Events" in the properties menu. |
48 | | -* 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`). |
| 65 | +- 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 | +- If Visual Studio isn't able to automatically copy the files, you'll have to copy the built dlls manually to OWML. |
49 | 67 |
|
50 | 68 | ## Authors |
51 | 69 |
|
52 | | -* [AmazingAlek](https://github.com/amazingalek) |
53 | | -* [Raicuparta](https://github.com/Raicuparta) |
| 70 | +- [AmazingAlek](https://github.com/amazingalek) |
| 71 | +- [Raicuparta](https://github.com/Raicuparta) |
54 | 72 |
|
55 | 73 | ## Special thanks |
56 | 74 |
|
57 | | -* [Mister_Nebula](https://github.com/misternebula), for research |
| 75 | +- [Mister_Nebula](https://github.com/misternebula), for research |
58 | 76 |
|
59 | 77 | ## Help / Discuss development / Whatever |
60 | 78 |
|
|
0 commit comments