Giters

Seally / yastm

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

YASTM SKSE Plugin

This plugin implements the SKSE portion of the YASTM (Yet Another Soul Gem Manager) mod for Skyrim Special Edition.

It completely overrides the soul trap logic used by the game, so Papyrus code can simply call caster.TrapSoul(victim) and it should work as long as all supporting TOMLs and ESPs are in place. Note that the changes made by USSEP to magicSoulTrapFXScript must be reverted for this mod to operate as intended.

It also fixes the crash that occurs when using a reusable soul gem whose base form already has a soul. In order for reusable soul gems to be supported by this plugin, all non-empty reusable soul gems must have their NAM0 field (linked soul gem) filled with their empty version.

This plugin has been written to be somewhat mod-agnostic and requires a supporting ESP and configuration files to take advantage of its capabilities. It does not hardcode soul gem and global variable form IDs, relying on configuration files to provide this information.

Configuration examples have been provided in the examples folder. A reference (and hopefully perfectly serviceable) implementation can be found here.

Building Requirements

  • CMake
  • Vcpkg
    • Add the environment variable VCPKG_ROOT with the value as the path to the folder containing Vcpkg.
  • Visual Studio Community 2019/2022
    • Desktop development with C++.
    • The project currently does not officially support any compilers other than MSVC. Everything is written with the assumption that MSVC is the compiler, especially because it is also the compiler used for Skyrim SE, hence the generated instructions should be more compatible with it.
  • TOML Language Support: This is optional since one can live without highlighting and syntax checking since you probably won't be working with it much.

Note #1: Project is set up and catered for Visual Studio. Visual Studio Code should work, but seems to be occasionally buggy. Certain CMake variables like SKYRIM64_DATA_PATH won't set when doing it from the interface so one must do it manually, and sometimes it will refuse to find the correct library paths.

CLion should work if you set it to target MSVC, but it's not tested.

Note #2: Any plugin that parses TOML must support at least v1.0 of the specs. We use certain constructs that are only valid in v1.0+.

Build Instructions

  1. Install and set up dependencies.
    • The CMake script uses the VCPKG_ROOT environment variable to locate Vcpkg. Make sure this is set before starting your IDE. You may need to kill and restart explorer.exe for this to apply properly.
    • The build configuration is currently set up to use MSVC 14.2 (from VS2019) as the compiler so to replicate the build you'll need to also install that version of the compiler from the installer if you're using VS2022.
  2. Clone the project and its submodules using git clone --recurse-submodules <repo_url>.
  3. Open the project in Visual Studio (preferred version: Visual Studio 2022).
  4. Set CMake variables. You can use CMakePresets.json as a starting point. See Important CMake Variables and Example CMakeUserPresets.json sections for details.
  5. Build the project.

Important CMake Variables

These variables should be set in CMakePresets.json and CMakeUserPresets.json. The environment variable VCPKG_ROOT should be set to the path of Vcpkg.

Required

  • SKSE_SUPPORT_XBYAK - This option comes from CommonLibSSE and is required to be set to ON for the project to build.

  • SKYRIM_VERSION - Specifies the version of Skyrim to compile for.

    Valid values: SE, AE, VR

Optional

  • COPY_BUILD - Copies the built binaries to the appropriate folder after building.

  • SKYRIM64_DATA_PATH - Set this to the path of Skyrim's Data folder. This should be filled if COPY_BUILD is ON.

    Tip: You can also set this to the mod folder you're working on if you're using something like Mod Organizer 2.

Example CMakeUserPresets.json

Copy and paste this into CMakeUserPresets.json, then modify values as appropriate. Replace base-vs2022 with base-vs2019 if you're using VS2019.

The msvc142 hidden preset uses MSVC 14.2 (VS2019) while msvc143 uses MSVC 14.3 (VS2022) as their names suggest. Public builds for 1.5.x and pre-1.6.629 normally use the 14.2 compiler. The 14.3 build is used for the 1.6.629+ version.

{
    "version": 3,
    "cmakeMinimumRequired": {
        "major": 3,
        "minor": 21,
        "patch": 0
    },
    "configurePresets": [
        {
            "name": "x64-Debug-SE-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "se" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimSE/mods/YASTM - SKSE Plugin (Debug)"
            }
        },
        {
            "name": "x64-Release-SE-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "se" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimSE/mods/YASTM - SKSE Plugin"
            }
        },
        {
            "name": "x64-Debug-SE-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "se" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimSE/mods/YASTM - SKSE Plugin (Debug)"
            }
        },
        {
            "name": "x64-Release-SE-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "se" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimSE/mods/YASTM - SKSE Plugin"
            }
        },
        {
            "name": "x64-Debug-AE-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "ae" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/se/YASTM - SKSE Plugin (Debug - Anniversary Edition 1.6.353)"
            }
        },
        {
            "name": "x64-Release-AE-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "ae" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/se/YASTM - SKSE Plugin (Release - Anniversary Edition 1.6.353)"
            }
        },
        {
            "name": "x64-Debug-AE-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "ae" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/se/YASTM - SKSE Plugin (Debug - Anniversary Edition 1.6.353)"
            }
        },
        {
            "name": "x64-Release-AE-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "ae" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/se/YASTM - SKSE Plugin (Release - Anniversary Edition 1.6.353)"
            }
        },
        {
            "name": "x64-Debug-AE2-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "ae2" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimAE/mods/YASTM - SKSE Plugin (Debug)"
            }
        },
        {
            "name": "x64-Release-AE2-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "ae2" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimAE/mods/YASTM - SKSE Plugin"
            }
        },
        {
            "name": "x64-Debug-AE2-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "ae2" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimAE/mods/YASTM - SKSE Plugin (Debug)"
            }
        },
        {
            "name": "x64-Release-AE2-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "ae2" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/Games/MO2 Data/SkyrimAE/mods/YASTM - SKSE Plugin"
            }
        },
        {
            "name": "x64-Debug-VR-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "vr" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/vr/YASTM - SKSE Plugin (Debug)"
            }
        },
        {
            "name": "x64-Release-VR-MSVC142",
            "inherits": [ "base", "msvc142", "vs2022", "vr" ],
            "cacheVariables": {
                "COPY_BUILD": true,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/vr/YASTM - SKSE Plugin"
            }
        },
        {
            "name": "x64-Debug-VR-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "vr" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/vr/YASTM - SKSE Plugin (Debug)"
            }
        },
        {
            "name": "x64-Release-VR-MSVC143",
            "inherits": [ "base", "msvc143", "vs2022", "vr" ],
            "cacheVariables": {
                "COPY_BUILD": false,
                "SKYRIM64_DATA_PATH": "D:/devel/Seally/yastm-ck/vr/YASTM - SKSE Plugin"
            }
        }
    ],
    "buildPresets": [
        {
            "name": "se-debug-msvc142",
            "displayName": "SE Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-SE-MSVC142"
        },
        {
            "name": "se-release-msvc142",
            "displayName": "SE Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-SE-MSVC142"
        },
        {
            "name": "se-debug-msvc143",
            "displayName": "SE Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-SE-MSVC143"
        },
        {
            "name": "se-release-msvc143",
            "displayName": "SE Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-SE-MSVC143"
        },
        {
            "name": "ae-debug-msvc142",
            "displayName": "AE Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-AE-MSVC142"
        },
        {
            "name": "ae-release-msvc142",
            "displayName": "AE Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-AE-MSVC142"
        },
        {
            "name": "ae-debug-msvc143",
            "displayName": "AE Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-AE-MSVC143"
        },
        {
            "name": "ae-release-msvc143",
            "displayName": "AE Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-AE-MSVC143"
        },
        {
            "name": "ae2-debug-msvc142",
            "displayName": "AE2 Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-AE2-MSVC142"
        },
        {
            "name": "ae2-release-msvc142",
            "displayName": "AE2 Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-AE2-MSVC142"
        },
        {
            "name": "ae2-debug-msvc143",
            "displayName": "AE2 Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-AE2-MSVC143"
        },
        {
            "name": "ae2-release-msvc143",
            "displayName": "AE2 Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-AE2-MSVC143"
        },
        {
            "name": "vr-debug-msvc142",
            "displayName": "VR Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-VR-MSVC142"
        },
        {
            "name": "vr-release-msvc142",
            "displayName": "VR Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-VR-MSVC142"
        },
        {
            "name": "vr-debug-msvc143",
            "displayName": "VR Debug",
            "configuration": "Debug",
            "configurePreset": "x64-Debug-VR-MSVC143"
        },
        {
            "name": "vr-release-msvc143",
            "displayName": "VR Release",
            "configuration": "RelWithDebInfo",
            "configurePreset": "x64-Release-VR-MSVC143"
        }
    ]
}

About

License:MIT License

Languages

Language:C++ 93.4%Language:CMake 3.0%Language:Papyrus 1.9%Language:TypeScript 1.7%