mirror of
https://github.com/misternebula/quantum-space-buddies.git
synced 2025-01-29 18:32:45 +00:00
make development file
This commit is contained in:
_nebula
parent
b4b48c97b6
commit
8b23b7bfd4
98
DEVELOPMENT.md
Normal file
98
DEVELOPMENT.md
Normal file
@ -0,0 +1,98 @@
|
||||
> :warning: Warning! :warning:
|
||||
Mod development needs a powerful PC!
|
||||
Unexpected errors and issues may occur when editing networking code.
|
||||
Running multiple instances of the game can be very taxing on your computer.
|
||||
We're not responsible if you push your PC too hard.
|
||||
|
||||
## Prerequisites
|
||||
- Visual Studio 2022.
|
||||
- Epic or Steam version of Outer Wilds.
|
||||
- Keyboard with numpad for in-game debug actions.
|
||||
|
||||
We recommend using the Outer Wilds Mod Manager, but you can use OWML on its own if you want.
|
||||
|
||||
## Cloning and configuration
|
||||
- Clone QSB's source code.
|
||||
- Copy the file `DevEnv.template.targets` and rename it to `DevEnv.targets`.
|
||||
- In `DevEnv.targets`, edit the entry for `<OwmlDir>` to point to your installation of OWML. This should be the folder named `OWML`. If using the manager, you can find this directory by :
|
||||
- Legacy Manager : Press the "Mods Directory" button and go up a folder.
|
||||
- New Manager : Press the "..." button at the top, and select "Show OWML Folder".
|
||||
- `QSB.sln` should now be ready to open. ***This solution needs to be opened with Visual Studio 2022 or higher!***
|
||||
|
||||
## Steam
|
||||
If using the Steam version of Outer Wilds, you will need to create a file to allow you to run multiple instances of the game.
|
||||
- Navigate to your game install folder. You can find this by right-clicking on the game in Steam, and going `Manage > Browse local files`.
|
||||
- Create a file named `steam_appid.txt`.
|
||||
- In this file, write `753640` and save.
|
||||
This file will override some Steam DRM features and allow the game to be ran multiple times at once.
|
||||
|
||||
## Building
|
||||
Simply build the solution normally. (`Build > Build Solution` or CTRL-SHIFT-B)
|
||||
|
||||
The files will automatically be copied over to your OWML installation and be ready to play - no DLL copying needed.
|
||||
|
||||
For documentation reasons, here is the build flow :
|
||||
|
||||
- MirrorWeaver is built.
|
||||
- EpicOnlineTransport is built.
|
||||
- EpicRerouter is built.
|
||||
- QSB is built.
|
||||
- Any `.exe.config` files are removed from the build.
|
||||
- QSB.dll is processed ("weaved") by MirrorWeaver. This injects all the boilerplate code that Mirror needs to function.
|
||||
- If needed/possible, any `.dll` or `.exe` files are copied to the Unity project.
|
||||
|
||||
## Debugging
|
||||
### Debug Actions :
|
||||
|
||||
Hold Q and press :
|
||||
|
||||
- Numpad 1 - Teleport to nearest player.
|
||||
- Numpad 2 - If holding LeftShift, warp to the dreamworld Vault fire. If not, warp to the Endless Canyon.
|
||||
- Numpad 3 - Unlock the Sealed Vault.
|
||||
- Numpad 4 - Damage the ship's electrical system.
|
||||
- Numpad 5 - Trigger the supernova.
|
||||
- Numpad 6 - Set the flags for having met Solanum and the Prisoner.
|
||||
- Numpad 7 - Warp to the Vessel.
|
||||
- Numpad 8 - Insert the Advanced Warp Core into the Vessel.
|
||||
- Numpad 9 - If holding LeftShift, load the SolarSystem scene. If not, load the EyeOfTheUniverse scene.
|
||||
- Numpad 0 - Revive a random dead player.
|
||||
|
||||
### Debug Settings :
|
||||
|
||||
Create a file called `debugsettings.json` in the mod folder.
|
||||
The template for this file is this :
|
||||
|
||||
```json
|
||||
{
|
||||
"dumpWorldObjects": false,
|
||||
"instanceIdInLogs": false,
|
||||
"hookDebugLogs": false,
|
||||
"avoidTimeSync": false,
|
||||
"autoStart": false,
|
||||
"kickEveryone": false,
|
||||
"disableLoopDeath": false,
|
||||
"debugMode": false,
|
||||
"drawGui": false,
|
||||
"drawLines": false,
|
||||
"drawLabels": false,
|
||||
"drawQuantumVisibilityObjects": false,
|
||||
"drawGhostAI": false,
|
||||
"greySkybox": false
|
||||
}
|
||||
```
|
||||
|
||||
- dumpWorldObjects - Creates a file with information about the WorldObjects that were created.
|
||||
- instanceIdInLogs - Appends the game instance id to every log message sent.
|
||||
- hookDebugLogs - Print Unity logs and warnings.
|
||||
- avoidTimeSync - Disables the syncing of time.
|
||||
- autoStart - Host/connect automatically for faster testing.
|
||||
- kickEveryone - Kick anyone who joins a game.
|
||||
- disableLoopDeath - Make it so the loop doesn't end when everyone is dead.
|
||||
- debugMode - Enables debug mode. If this is set to `false`, none of the following settings do anything.
|
||||
- drawGui - Draws a GUI at the top of the screen that gives information on many things.
|
||||
- drawLines - Draws gizmo-esque lines around things. Indicates reference sectors/transforms, triggers, etc. LAGGY.
|
||||
- drawLabels - Draws GUI labels attached to some objects. LAGGY.
|
||||
- drawQuantumVisibilityObjects - Indicates visibility objects with an orange shape.
|
||||
- drawGhostAI - Draws debug lines and labels just for the ghosts.
|
||||
- greySkybox - Turns the skybox grey. Useful in the Eye, where it's pretty dark.
|
||||
|
||||
5
QSB.sln
5
QSB.sln
@ -8,6 +8,7 @@ EndProject
|
||||
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{2569F98D-F671-42AA-82DE-505B05CDCEF2}"
|
||||
ProjectSection(SolutionItems) = preProject
|
||||
.gitignore = .gitignore
|
||||
DEVELOPMENT.md = DEVELOPMENT.md
|
||||
LICENSE = LICENSE
|
||||
README.md = README.md
|
||||
TRANSLATING.md = TRANSLATING.md
|
||||
@ -15,9 +16,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
|
||||
EndProject
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MirrorWeaver", "MirrorWeaver\MirrorWeaver.csproj", "{DA8A467E-15BA-456C-9034-6EB80BAF1FF9}"
|
||||
EndProject
|
||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EpicOnlineTransport", "EpicOnlineTransport\EpicOnlineTransport.csproj", "{971AA4A1-6729-40DE-AADF-2754F1E8783A}"
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EpicOnlineTransport", "EpicOnlineTransport\EpicOnlineTransport.csproj", "{971AA4A1-6729-40DE-AADF-2754F1E8783A}"
|
||||
EndProject
|
||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EpicRerouter", "EpicRerouter\EpicRerouter.csproj", "{639EFAEE-C4A1-4DA2-8457-D0472A9F6343}"
|
||||
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EpicRerouter", "EpicRerouter\EpicRerouter.csproj", "{639EFAEE-C4A1-4DA2-8457-D0472A9F6343}"
|
||||
EndProject
|
||||
Global
|
||||
GlobalSection(SolutionConfigurationPlatforms) = preSolution
|
||||
|
||||
90
README.md
90
README.md
@ -19,13 +19,13 @@ Spoilers within!
|
||||
|
||||
### Easy installation (recommended)
|
||||
|
||||
- [Install the Outer Wilds Mod Manager](https://github.com/Raicuparta/ow-mod-manager#how-do-i-use-this);
|
||||
- [Install the Outer Wilds Mod Manager](https://outerwildsmods.com/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
|
||||
|
||||
- [Install OWML](https://github.com/amazingalek/owml#installation);
|
||||
- [Install OWML](https://github.com/ow-mods/owml#installation);
|
||||
- [Download the latest Quantum Space Buddies release](https://github.com/misternebula/quantum-space-buddies/releases/latest);
|
||||
- Extract the `QSB` directory to the `OWML/Mods` directory;
|
||||
- Run `OWML.Launcher.exe` to start the game.
|
||||
@ -47,7 +47,7 @@ Spoilers within!
|
||||
## Frequently Asked Questions
|
||||
|
||||
### I keep timing out when trying to connect!
|
||||
Check the mod settings for "Use KCP Transport". You have to forward port 7777 as TCP/UDP, or use Hamachi. ALL PLAYERS MUST HAVE THIS AS THE SAME VALUE.
|
||||
Check the mod settings for "Use KCP Transport". You have to forward port 7777 as TCP/UDP, or use Hamachi. ***All players must either be using KCP, or not using KCP.***
|
||||
|
||||
### Requirements
|
||||
- Latest version of OWML.
|
||||
@ -89,93 +89,13 @@ QSB is a fully synced game. The other players are actually there in the world, a
|
||||
|
||||
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 :)
|
||||
|
||||
## Translating
|
||||
|
||||
See [TRANSLATING.md](TRANSLATING.md)
|
||||
|
||||
## Development Setup
|
||||
## Development Setup / Contributing
|
||||
|
||||
- [Download the Outer Wilds Mod Manager](https://github.com/raicuparta/ow-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 `<UnityAssetsDir>` to point to the Assets folder of the QSB unity project
|
||||
- Open the project solution file `QSB.sln` in Visual Studio 2022
|
||||
|
||||
If developing with the Steam version of Outer Wilds you can't run multiple instances of the game by default. To do so, create a file called `steam_appid.txt` in your Outer Wilds directory and write `753640` inside it, then run the exe directly.
|
||||
|
||||
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.
|
||||
|
||||
Some debugging options exist to make things easier. These come in the form of actions and settings.
|
||||
### Debug Actions :
|
||||
|
||||
Hold Q and press :
|
||||
|
||||
- Numpad 1 - Teleport to nearest player.
|
||||
- Numpad 2 - If holding LeftShift, warp to the dreamworld Vault fire. If not, warp to the Endless Canyon.
|
||||
- Numpad 3 - Unlock the Sealed Vault.
|
||||
- Numpad 4 - Damage the ship's electrical system.
|
||||
- Numpad 5 - Trigger the supernova.
|
||||
- Numpad 6 - Set the flags for having met Solanum and the Prisoner.
|
||||
- Numpad 7 - Warp to the Vessel.
|
||||
- Numpad 8 - Insert the Advanced Warp Core into the Vessel.
|
||||
- Numpad 9 - If holding LeftShift, load the SolarSystem scene. If not, load the EyeOfTheUniverse scene.
|
||||
- Numpad 0 - Revive a random dead player.
|
||||
|
||||
### Debug Settings :
|
||||
|
||||
Create a file called `debugsettings.json` in the mod folder.
|
||||
The template for this file is this :
|
||||
|
||||
```
|
||||
{
|
||||
"dumpWorldObjects": false,
|
||||
"instanceIdInLogs": false,
|
||||
"hookDebugLogs": false,
|
||||
"avoidTimeSync": false,
|
||||
"autoStart": false,
|
||||
"kickEveryone": false,
|
||||
"disableLoopDeath": false,
|
||||
"debugMode": false,
|
||||
"drawGui": false,
|
||||
"drawLines": false,
|
||||
"drawLabels": false,
|
||||
"drawQuantumVisibilityObjects": false,
|
||||
"drawGhostAI": false,
|
||||
"greySkybox": false
|
||||
}
|
||||
```
|
||||
|
||||
- dumpWorldObjects - Creates a file with information about the WorldObjects that were created.
|
||||
- instanceIdInLogs - Appends the game instance id to every log message sent.
|
||||
- hookDebugLogs - Print Unity logs and warnings.
|
||||
- avoidTimeSync - Disables the syncing of time.
|
||||
- autoStart - Host/connect automatically for faster testing.
|
||||
- kickEveryone - Kick anyone who joins a game.
|
||||
- disableLoopDeath - Make it so the loop doesn't end when everyone is dead.
|
||||
- debugMode - Enables debug mode. If this is set to `false`, none of the following settings do anything.
|
||||
- drawGui - Draws a GUI at the top of the screen that gives information on many things.
|
||||
- drawLines - Draws gizmo-esque lines around things. Indicates reference sectors/transforms, triggers, etc. LAGGY.
|
||||
- drawLabels - Draws GUI labels attached to some objects. LAGGY.
|
||||
- drawQuantumVisibilityObjects - Indicates visibility objects with an orange shape.
|
||||
- drawGhostAI - Draws debug lines and labels just for the ghosts.
|
||||
- greySkybox - Turns the skybox grey. Useful in the Eye, where it's pretty dark.
|
||||
|
||||
**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.**
|
||||
See [DEVELOPMENT.md](DEVELOPMENT.md)
|
||||
|
||||
## Authors and Special Thanks
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user