Author Topic: Modding prerequisites (Visual Studio 2017)  (Read 114 times)

ai_enabled

  • AtomicTorch Founder
  • Hero Member
  • *****
  • Posts: 1029
    • View Profile
Modding prerequisites (Visual Studio 2017)
« on: April 30, 2018, 02:25:36 am »
Currently, we don't officially support modding for CryoFall, however many people are interested in how the game built (as all the gameplay-related code and even UI code are shipped in an open source form with the game) so we've decided to share required files to allow opening the game open source part ("Core") with Visual Studio 2017 (Windows only) - so it's possible to edit C# and XAML (UI) code with auto-complete and other features, debug and even make small mods.

Steps to setup Visual Studio 2017 to open "Core" part of the game:
  • Install Visual Studio 2017 (any edition, including free Community edition). Before installation, please ensure that you've checked ".NET Framework 4.7.1 targeting pack". If you already have VS2017 installed, please ensure launch Visual Studio Installer -> Modify -> Individual components -- and ensure that ".NET Framework 4.7.1 targeting pack" is checked.
  • Download and install Visual Studio 2017 extension for our custom mod project type.
  • Download CustomProjectSystems.zip and extract it into %LocalAppData% folder. After extracting, please ensure that C:\Users\YOUR_USERNAME\AppData\Local\CustomProjectSystems contains the subfolder AtomicTorch.GameEngine.ModProject.

After that, you can open the game solution file with VS2017. It's located in <game folder>\Core\Core.cpk\.


A few important notes:
  • The CryoFall custom game engine (called Renkei) supports live reloading of C# & XAML code (as well as all the visual and audio assets) so it's not necessary to restart the game to observe the changes!
  • XAML Designer is not supported (though it can work sometimes, slowly and glitchy) and it's recommended to disable it (Visual Studio Options, XAML designer, uncheck "Enable XAML Designer").
  • If you want to debug your code with breakpoints, please go to Visual Studio Options, Debugging, uncheck "Require source files to exactly match the original version" (because the game includes C# compiler which performs some code-generation and so resulting C# files do not match the original C# files - but it's not a problem for step-by-step debugging as the C# code lines kept intact).

Regards!
« Last Edit: May 09, 2018, 01:28:42 am by ai_enabled »