Skip to content

Latest commit

 

History

History
54 lines (44 loc) · 3.87 KB

Setting-up-a-development-environment-for-Nitrox.md

File metadata and controls

54 lines (44 loc) · 3.87 KB
Raw

Please be aware that this mod is in it's early stages of development, and that the steps below are to set up a development environment for Nitrox. These steps are not for a regular install of this mod. We discourage the use of this mod for casual play until a stable public release has been made.

Development Setup

Repository setup

  1. Fork the repository to your own Github account (use the fork button top-right).
  2. Pull git repository locally (pass --recursive to git clone to init and clone submodules).
    • e.g. git clone https://github.com/your-github-name/Nitrox.git --recursive
  3. Initialize git submodule(s) by running the following command:
    • git submodule update --init --recursive. This command can also be used to fetch and update changes.

Nitrox setup

  1. Load Nitrox.sln inside Visual Studio

  2. If you have Subnautica installed via Steam in the default install location, skip this step.

    1. Open DevVars.targets.example
    2. Adjust the line <SubnauticaDir>C:\Program Files\Epic Games\Subnautica</SubnauticaDir> to match the location of your Subnautica install directory.
    3. Save the file as DevVars.targets
      • NOTE: If you have this file, it will always use this directory and never use the default steam directory.

  3. Build entire solution to generate binaries

  4. Inject NitroxPatcher into Assembly-CSharp:

    1. Load up dnSpy
    2. Inject before the first line of GameInput.Awake()
    3. Add a reference to NitroxPatcher. This should be in the same directory as Assembly-CSharp. If not, follow step 3 more carefully.
    4. Inject startup code: NitroxPatcher.Main.Execute().
    5. If you get compile errors like in issue 221 you should be able to remove the offending lines without repercussions.

Verify setup

  1. Start Subnautica
  2. If you see a multiplayer button Nitrox is correctly loaded.
  3. Verify Subnautica logs at Subnautica/Subnautica_Data/output_log.txt (Search for nitrox, verify no errors)
    • NOTE: There will always be some errors, but nothing substantial in the first part regarding loading of Nitrox.
  4. Run NitroxServer project and verify that there are no errors in the console Window
  5. In the client, join a new game by connecting through the multiplayer button in the UI.

Debugging Subnautica

  1. Make sure you have the latest version of dnSpy installed.
  2. Swap Subnautica's release build mono.dll with dnSpy's patched version that can be debugged:
    1. In the dnSpy releases, download the latest Unity-debugging-5.x.zip file.
    2. After unzipping the file, navigate to Unity-debugging/unity-5.6.2/win64 and pull out the mono.dll file.
    3. Navigate to Subnautica's directory and swap out Subnautica_Data/Mono/mono.dll with the mono.dll you downloaded from GitHub.
  3. Start up Subnautica and dnSpy.
  4. While on the main menu, go to Debug > Start Debugging (or press F5) in dnSpy.
  5. Select Unity (Connect) as the Debug engine, and press OK.
  6. Once the bottom of dnSpy says "Running..." in orange, the debugger is now connected to Subnautica.

To view the game's code:

  1. Go to Debug > Windows > Modules, find Assembly-CSharp.dll and double click it.
    • NOTE: You can also debug through Nitrox's code by finding Nitrox modules after the patcher loads them in.

You can place breakpoints anywhere in any of the modules and the game will pause and show all local variables when the breakpoint is hit.

NOTE: It might take a few seconds for the debugger to connect to your game. Be careful when setting breakpoints and pausing the game for long periods of time when it's in multiplayer, because you will be disconnected from the server after you resume execution due to timeout. It's recommended to attach the debugger before you join a multiplayer server.