Skip to content

IanE-Official/rehash-sfse-asi-loader

 
 

Repository files navigation

GitHub Release Main/Release Build

📑 SFSE ASI Loader

SFSE plugin which safely preloads ASI mods with logging forked from Doodlez by Ian E.

To install / use this mod as an end-user:

  1. For the mod to work correctly, Install Starfield (Steam Edition), Starfield Script Extender (SFSE), and Address Library for SFSE Plugins.
  2. Download latest compiled version from NexusMods or my Github Releases
  3. To use just place expand in your Starfield data directory or just copy the DLL to {StarfieldDirectory}/Data/SFSE/Plugins/ and run the game

Get started from source

⚙ Requirements

  • CMake
    • Add this to your PATH
  • DKUtil
    • Used for logging primarily; Init & update with git submodule
  • SFSE
    • Init & update with git submodule
  • PowerShell
    • Runs scripts which automate building.
  • Vcpkg
    • Handles non-submodule dependency packages
  • Visual Studio Community 2022
    • Desktop development with C++. Note that VSCode will not build properly at this time.
  • Starfield Steam Distribution
    • Add the environment variable SFPath with the value as the path to the game installation for auto-deployment.

💻 Register Visual Studio Community 2022 as a Generator

  • Open x64 Native Tools Command Prompt
  • Run cmake
  • Close the cmd window

🔨 Building

To build from source (unrecommended):

git clone https://github.com/IanE-Official/rehash-sfse-asi-loader.git sfse-asi-loader
cd sfse-asi-loader
git submodule init
git submodule update
cd extern/vcpkg
./bootstrap-vcpkg.bat
vcpkg integrate install
cd ..
cd ..
pwsh build-release.ps1

If you are building for a Starfield other than the latest, use git clone https://github.com/IanE-Official/rehash-sfse-asi-loader.git --branch {version} sfse-asi-loader where {version} is set to the newest version of starfield you are trying to build for (currently 1.14.74).

📦 Deployment

Automated steps in Build-release.ps1 will automatically handle deployment.

➕ DKUtil addon

This project bundles DKUtil.

📖 License

MIT LICENSE with requirment of credit and restrictions on packaging DLLs directly with Mods.

Security

See SECURITY.md

❓ Credits