skyrimscripting / packages

Skyrim Scripting vcpkg / xmake packages

Skyrim Packages (xmake and vcpkg)

Note: packages are only available thru xmake at this time

xmake

To use these xmake packages, add the following to your xmake.lua file:

add_repositories("SkyrimScripting https://github.com/SkyrimScripting/Packages.git")

Packages

• skyrim-commonlib
• skyrim-commonlib-vr
• skyrim-commonlib-ng
• skyrim-commonlib-ae
• skyrim-commonlib-se
• Other packages in this repo are a work in progress and I wouldn't use them yet!

CommonLib

xmake packages available:

• skyrim-commonlib ( Alias for skyrim-commonlib-ng )
• skyrim-commonlib-vr ( Adds dependency on @alandtse's CommonLibVR )
• skyrim-commonlib-ng ( Adds dependency on @CharmedBaryon's CommonLibSSE-NG )
• skyrim-commonlib-ae ( Adds dependency on @powerof3's CommonLibSSE configured for Skyrim 1.6+ compatibility )
• skyrim-commonlib-se ( Adds dependency on @powerof3's CommonLibSSE configured for Skyrim 1.5.97 compatibility )

Basic Usage

To use one of these CommonLib packages:

add_requires("skyrim-commonlib")

target("My-SKSE-Plugin")
    add_files("plugin.cpp")
    add_packages("skyrim-commonlib")

Or any of the other packages listed above:

add_requires("skyrim-commonlib-vr")

target("My-SKSE-Plugin")
    add_files("plugin.cpp")
    add_packages("skyrim-commonlib-vr")

Xbyak Support

To enable xbyak support, enable the xybak option (available for any version):

add_requires("skyrim-commonlib", { configs = { xbyak = true } })

This will provide the following function (which is otherwise unavailable):

SKSE::Trampoline::allocate(Xbyak::CodeGenerator& codeGenerator)

Mod Folder Deployment

Optionall, you can define one or more "mods" folders to deploy the plugin dll/pdb to:

add_requires("skyrim-commonlib")

target("My-SKSE-Plugin")
    add_files("plugin.cpp")
    add_packages("skyrim-commonlib")

    add_rules("@skyrim-commonlib/plugin", {
        -- This will output to the following generated folder location:
        --  C:/Path/to/my/mods/My-SKSE-Plugin/SKSE/Plugins/My-SKSE-Plugin.dll
        mods_folder = "C:/Path/to/my/mods"
    })

    -- Note: use the rule with a name matching the package that you are using:
    -- add_rules("@skyrim-commonlib/plugin", {...
    -- add_rules("@skyrim-commonlib-vr/plugin", {...
    -- add_rules("@skyrim-commonlib-ae/plugin", {...
    -- add_rules("@skyrim-commonlib-se/plugin", {...
    -- add_rules("@skyrim-commonlib-vr/plugin", {...

If you have multiple mods folders, you can specify them as a list:

add_requires("skyrim-commonlib")

target("My-SKSE-Plugin")
    add_files("plugin.cpp")
    add_packages("skyrim-commonlib")
    add_rules("@skyrim-commonlib/plugin", {
        mod_folders = { "C:/...", "C:/..." }
    })

Paths containing a ; are split, allowing for use of an environment varialbe to specify multiple output paths:

add_requires("skyrim-commonlib")

target("My-SKSE-Plugin")
    add_files("plugin.cpp")
    add_packages("skyrim-commonlib")
    add_rules("@skyrim-commonlib/plugin", {
        mod_folders = os.getenv("SKYRIM_MOD_FOLDERS")
    })

xmake configuration based on official CommonLibSSE-NG xmake package configuration:
https://github.com/xmake-io/xmake-repo
License: Apache 2.0

Configuration above was authored by by Qudix (https://github.com/Qudix)

Modifications were made to the original code