k0mp1ex / skyrim-runtime-devtools

🔍 📈 Developer tools for modders to visualize and tweak Skyrim game data at runtime

Skyrim Runtime Developer Tools (SRDT)

• Skyrim Runtime Developer Tools
  • What does it do?
  • Requirements
  • Project setup

---

What does it do?

Developer tools for modders to visualize and tweak Skyrim game data at runtime.

Requirements

• Visual Studio 2022 (the free Community edition is fine!)
• CMake 3.25.1+ (please install the Latest Release)
• vcpkg
  • 1. Clone the repository using git OR download it as a .zip
  • 2. Go into the vcpkg folder and double-click on bootstrap-vcpkg.bat
  • 3. Edit your system or user Environment Variables and add a new one:
    • Name: VCPKG_ROOT
      Value: C:\path\to\wherever\your\vcpkg\folder\is

Once you have Visual Studio 2022 installed, you can open this folder in basically any C++ editor, e.g. VS Code or CLion or Visual Studio

• for VS Code, if you are not automatically prompted to install the C++ and CMake Tools extensions, please install those and then close VS Code and then open this project as a folder in VS Code

You may need to click OK on a few windows, but the project should automatically run CMake!

It will automatically download CommonLibSSE NG and everything you need to get started making your new plugin!

Project setup

By default, when this project compiles it will output a .dll for your SKSE plugin into the build/ folder.

If you want to configure this project to output your plugin files into your Skyrim Special Edition's "Data" folder:

• Set the SKYRIM_FOLDER environment variable to the path of your Skyrim installation
  e.g. C:\Program Files (x86)\Steam\steamapps\common\Skyrim Special Edition

If you want to configure this project to output your plugin files into your "mods" folder:
(for Mod Organizer 2 or Vortex)

• Set the SKYRIM_MODS_FOLDER environment variable to the path of your mods folder:
  e.g. C:\Users\<user>\AppData\Local\ModOrganizer\Skyrim Special Edition\mods
  e.g. C:\Users\<user>\AppData\Roaming\Vortex\skyrimse\mods

Thanks mrowrpr for the lovely template.

📜 other templates available at https://github.com/SkyrimScripting/SKSE_Templates

PLEASE DO NOT RELEASE YOUR SKSE PLUGIN ON NEXUS/ETC WITHOUT MAKING THE SOURCE CODE AVAILABLE