Skip to content

Latest commit

 

History

History
59 lines (47 loc) · 3.8 KB

README.md

File metadata and controls

59 lines (47 loc) · 3.8 KB
Raw

Solasta Community Expansion

This is a collection of work from the Solasta modding community. It includes feats, subclasses, items, crafting recipes, gameplay options, UI improvements, and more. The general philosophy is everything is optional to enable, so you can install the mod and then enable the pieces you want. There are some minor bug fixes that are enabled by default.

The goal with the modifications provided here is to minimize code patches. Minimizing code patches means compatibility with other mods is easier as well as makes maintenance easier. Any code patches should be as targeted and minimal as possible to reduce the chance of unintended side effects. There are a lot of interesting things that can be done with just edits to the database.

How to contribute

Do you have a mod you want to see included here? We are happy to take new contributions! The best way to get involved is to:

  1. Make a branch off of the Dev branch, name it something related to the changes you are making.
  2. Commit your edits to your branch.
  3. Make sure to test your changes. This is a good opportunity to take screen shots so you can show off the changes.
  4. Make a pull request to merge your branch into Dev. You can help this process by sharing screen shots to show off the change as well as including an english description of what the change does.
  5. Wait for a review. We try to stay on top of this, but it's a hobby. If you haven't heard anything in 3 days you can message ChrisJohnDigital#9182 on Discord or email [email protected].
  6. Once the review is done, the changes will get merged in to the Dev branch. The Dev branch will periodically be tested and merged in to master to build releases.

How to Compile

  1. Install all required development pre-requisites:
  2. Download and install Unity Mod Manager (UMM)
  3. Execute UMM, Select Solasta, and Install
  4. Download and install SolastaModApi using UMM
  5. Create the environment variable SolastaInstallDir and point it to your Solasta game home folder
    • tip: search for "edit the system environment variables" on windows search bar
  6. Use "Install Release" or "Install Debug" to have the Mod installed directly to your Game Mods folder

NOTE Unity Mod Manager and this mod template make use of Harmony

How to Debug

  1. Open Solasta game folder
    • Rename Solasta.exe to Solasta.exe.original
    • Rename UnityPlayer.dll to UnityPlayer.dll.original
    • Add below entries to Solasta_Data\boot.config: 
       wait-for-managed-debugger=1
 player-connection-debug=1
  2. Download and install 7zip
  3. Download Unity Editor 2019.4.19
  4. Open Downloads folder
    • Right-click UnitySetup64-2019.4.1f1.exe, 7Zip -> Extract Here
    • Navigate to Editor\Data\PlaybackEngines\windowsstandalonesupport\Variations\win64_development_mono
      • Copy UnityPlayer.dll and WinPixEventRuntime.dll to clipboard
    • Navigate to the Solasta game folder
      • Rename UnityPlayer.dll to UnityPlayer.dll.original
      • Paste UnityPlayer.dll and WinPixEventRuntime.dll from clipboard
  5. You can now attach the Unity Debugger from Visual Studio 2019, Debug -> Attach Unity Debug

How to publish (update)

  1. Develop / Test the Mod
  2. Edit version entries on CSPROJ, Info.json, and Repository.json
  3. Update DownloadURL on Repository.json
  4. Release Mod on GitHub using Vx.y.z as TAG/RELEASE convention
  5. Update Nexus page with new release