Skip to content

KrisV-777/Acheron

Repository files navigation

Acheron

A SKSE64 Death Alternative Framework for TESV Skyrim, sitting on top of native damage calcuations to create custom and extensible game over events, reducing the need to reload game saves upon losing in combat and adding new ways to interact with NPCs.

For documentation on how to interact with this plugin see the wiki.
Alternative download mirror on Nexus Mods.

Requirements

Building

Clone

git clone https://github.com/KrisV-777/Acheron.git
cd Acheron
git submodule update --init --recursive

Configure

Before building you must provide the following options: spriggit_path, papyrus_path, papyrus_include, and papyrus_gamesource. These can be provided using either:

  1. Environment variables (optionally loaded from .env)

    • See .env.example for variables/descriptions.
    • Copy to .env and edit the values.
    • Run xmake f -c after making changes to load the new values.
    • Alternate files can be loaded with xmake f -c --dotenv=.env.other
  2. Command-line configure

    • Set options when configuring with xmake f:
xmake f -m release \
	--spriggit_path="path\to\Spriggit.CLI" \
	--papyrus_path="path\to\Papyrus Compiler" \
	--papyrus_include="path\to\ModOrganizer\mods" \
	--papyrus_gamesource="path\to\Skyrim Special Edition\Data"

Build

xmake

Install

If install_path and auto_install are configured, files will be automatically coppied to install_path after a successful build. Otherwise install can be run manually using:

xmake install -o INSTALLDIR

Packaging

Package the project into a .7z distribution using:

xmake pack

The file will be located in build\xpack\.

Papyrus Project Generation

Generate a papyrus project file for IDE integration using:

xmake papyrus.project papyrus

About

A death alternative framework for TES5: Skyrim

Resources

Stars

5 stars

Watchers

1 watching

Forks

Contributors