skyrim/artifact-tracker
1
Fork 0
Code Releases Activity

Pinned Clib version

Browse Source
This commit is contained in:
Eddoursul 2026-07-06 01:19:43 +02:00
parent b812ac1350
commit efeb6e4c2c
11 changed files with 311 additions and 251 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
SKSE/Plugins/ArtifactTracker.dll
View File

Binary file not shown.

86
Source/ArtifactTrackerDLL/CMakeLists.txt
View File

@ -1,5 +1,4 @@
cmake_minimum_required(VERSION 3.21)
message("Using toolchain file ${CMAKE_TOOLCHAIN_FILE}.")
########################################################################################################################
## Define project
@ -11,12 +10,17 @@ project(
LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 23)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_INTERPROCEDURAL_OPTIMIZATION ON)
# Link-time optimization for release builds only (debug builds stay fast).
set(CMAKE_INTERPROCEDURAL_OPTIMIZATION_RELEASE ON)
# CommonLibSSE-NG requires the dynamic CRT. Dependencies used to be supplied by
# vcpkg (which set this via a preset); now that they come from FetchContent we
# set it here so both build.cmd and Visual Studio "Open Folder" pick it up.
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
include(GNUInstallDirs)
find_path(SIMPLEINI_INCLUDE_DIRS "ConvertUTF.c")
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/cmake/version.rc.in
${CMAKE_CURRENT_BINARY_DIR}/version.rc
@ -36,11 +40,79 @@ source_group(
${headers}
${sources})
########################################################################################################################
## Fetch dependencies (pinned versions, no vcpkg required)
########################################################################################################################
include(FetchContent)
# DirectXMath - required by DirectXTK.
FetchContent_Declare(
DirectXMath
URL https://github.com/microsoft/DirectXMath/archive/refs/tags/apr2025.tar.gz
OVERRIDE_FIND_PACKAGE
DOWNLOAD_EXTRACT_TIMESTAMP ON
EXCLUDE_FROM_ALL
SYSTEM)
FetchContent_MakeAvailable(DirectXMath)
add_library("Microsoft::DirectXMath" ALIAS "DirectXMath")
# DirectXTK - required by CommonLibSSE-NG (find_package(directxtk CONFIG REQUIRED)).
# PATCH_COMMAND fixes its shader-compile step under modern CMake (see the script).
FetchContent_Declare(
DirectXTK
URL https://github.com/microsoft/DirectXTK/archive/refs/tags/jul2025.tar.gz
OVERRIDE_FIND_PACKAGE
DOWNLOAD_EXTRACT_TIMESTAMP ON
EXCLUDE_FROM_ALL
SYSTEM
PATCH_COMMAND ${CMAKE_COMMAND} -P "${CMAKE_CURRENT_SOURCE_DIR}/cmake/patch_directxtk.cmake")
FetchContent_MakeAvailable(DirectXTK)
add_library("Microsoft::DirectXTK" ALIAS "DirectXTK")
# rapidcsv - header only, required by CommonLibSSE-NG (find_path "rapidcsv.h").
FetchContent_Declare(
rapidcsv
URL https://github.com/d99kris/rapidcsv/archive/refs/tags/v8.90.tar.gz
OVERRIDE_FIND_PACKAGE
DOWNLOAD_EXTRACT_TIMESTAMP ON)
FetchContent_MakeAvailable(rapidcsv)
set(RAPIDCSV_INCLUDE_DIRS ${rapidcsv_SOURCE_DIR}/src)
# spdlog - used directly (PCH.h) and by CommonLibSSE-NG.
set(SPDLOG_INSTALL ON CACHE BOOL "" FORCE)
set(SPDLOG_USE_STD_FORMAT ON CACHE BOOL "" FORCE)
FetchContent_Declare(
spdlog
URL https://github.com/gabime/spdlog/archive/refs/tags/v1.17.0.tar.gz
OVERRIDE_FIND_PACKAGE
DOWNLOAD_EXTRACT_TIMESTAMP ON)
FetchContent_MakeAvailable(spdlog)
# simpleini - used directly (Util.h).
FetchContent_Declare(
simpleini
URL https://github.com/brofield/simpleini/archive/refs/tags/v4.25.tar.gz
DOWNLOAD_EXTRACT_TIMESTAMP ON)
FetchContent_MakeAvailable(simpleini)
# CommonLibSSE-NG - pinned commit (SE + AE + VR runtime support).
set(ENABLE_SKYRIM_SE ON CACHE BOOL "" FORCE)
set(ENABLE_SKYRIM_AE ON CACHE BOOL "" FORCE)
set(ENABLE_SKYRIM_VR ON CACHE BOOL "" FORCE)
set(BUILD_TESTS OFF CACHE BOOL "" FORCE)
message(STATUS "Fetching CommonLibSSE-NG...")
FetchContent_Declare(
CommonLibSSE
GIT_REPOSITORY https://github.com/alandtse/CommonLibVR
GIT_TAG aacbd76c01bff9381e253ffdfcb4f9d5f263f1df)
FetchContent_MakeAvailable(CommonLibSSE)
get_target_property(COMMONLIB_SRC_DIR CommonLibSSE SOURCE_DIR)
include(${COMMONLIB_SRC_DIR}/cmake/CommonLibSSE.cmake)
########################################################################################################################
## Configure target DLL
########################################################################################################################
find_package(CommonLibSSE CONFIG REQUIRED)
add_commonlibsse_plugin(${PROJECT_NAME} SOURCES ${headers} ${sources})
add_library("${PROJECT_NAME}::${PROJECT_NAME}" ALIAS "${PROJECT_NAME}")
@ -49,7 +121,7 @@ target_include_directories(${PROJECT_NAME}
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src>
$<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/src>
$<INSTALL_INTERFACE:src>
${SIMPLEINI_INCLUDE_DIRS}
${simpleini_SOURCE_DIR}
)
target_include_directories(${PROJECT_NAME}

132
Source/ArtifactTrackerDLL/CMakePresets.json
View File

@ -13,17 +13,6 @@
"CMAKE_CXX_FLAGS": "$env{COMMONLIBSSE_COMPILER} $env{COMMONLIBSSE_PLATFORM} $env{COMMONLIBSSE_TEXT}"
}
},
{
"name": "vcpkg",
"hidden": true,
"cacheVariables": {
"CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
"VCPKG_TARGET_TRIPLET": "x64-windows-skse",
"VCPKG_HOST_TRIPLET": "x64-windows-skse",
"VCPKG_OVERLAY_TRIPLETS": "${sourceDir}/cmake",
"CMAKE_MSVC_RUNTIME_LIBRARY": "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL"
}
},
{
"name": "win32",
"hidden": true,
@ -79,100 +68,68 @@
}
}
},
{
"name": "build-tests",
"displayName": "Build Tests",
"hidden": true,
"description": "Include test suites in the build.",
"cacheVariables": {
"BUILD_TESTS": {
"type": "STRING",
"value": "ON"
}
}
},
{
"name": "build-release-msvc",
"inherits": [
"base",
"vcpkg",
"win32-unicode",
"x64",
"build-tests",
"msvc"
],
"displayName": "Release",
"displayName": "Release (MSVC)",
"description": "Optimized release build.",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build/release-msvc",
"cacheVariables": {
"CMAKE_BUILD_TYPE": {
"type": "STRING",
"value": "Release"
}
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "build-debug-msvc",
"inherits": [
"base",
"vcpkg",
"win32-unicode",
"x64",
"build-tests",
"msvc"
],
"displayName": "Debug",
"displayName": "Debug (MSVC)",
"description": "Debug build for testing.",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build/debug-msvc",
"cacheVariables": {
"CMAKE_BUILD_TYPE": {
"type": "STRING",
"value": "Debug"
}
}
},
{
"name": "build-debug-clang-cl",
"inherits": [
"base",
"vcpkg",
"win32-unicode",
"x64",
"build-tests",
"clang-cl"
],
"displayName": "Debug",
"description": "Debug build for testing.",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build/debug-clang",
"cacheVariables": {
"CMAKE_BUILD_TYPE": {
"type": "STRING",
"value": "Debug"
}
"CMAKE_BUILD_TYPE": "Debug"
}
},
{
"name": "build-release-clang-cl",
"inherits": [
"base",
"vcpkg",
"win32-unicode",
"x64",
"build-tests",
"clang-cl"
],
"displayName": "Release",
"displayName": "Release (Clang)",
"description": "Optimized release build.",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build/release-clang",
"cacheVariables": {
"CMAKE_BUILD_TYPE": {
"type": "STRING",
"value": "Release"
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "build-debug-clang-cl",
"inherits": [
"base",
"win32-unicode",
"x64",
"clang-cl"
],
"displayName": "Debug (Clang)",
"description": "Debug build for testing.",
"generator": "Ninja",
"binaryDir": "${sourceDir}/build/debug-clang",
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug"
}
}
],
@ -201,52 +158,5 @@
"configurePreset": "build-debug-clang-cl",
"description": "Debug build for testing."
}
],
"testPresets": [
{
"name": "tests-all",
"displayName": "All Tests",
"configurePreset": "build-debug-msvc",
"output": {
"outputOnFailure": true
},
"execution": {
"noTestsAction": "error",
"stopOnFailure": false
}
},
{
"name": "tests-unit",
"displayName": "Unit Tests",
"description": "Runs tests that do not require any Skyrim module loaded into the process.",
"inherits": "tests-all",
"filter": {
"exclude": {
"label": "[integration],[e2e]"
}
}
},
{
"name": "tests-integration",
"displayName": "Integration Tests",
"description": "Runs tests that interact with a Skyrim module at rest (do not require the Skyrim module to have run any main function).",
"inherits": "tests-all",
"filter": {
"include": {
"label": "[integration]"
}
}
},
{
"name": "tests-e2e",
"displayName": "End-to-End Tests",
"description": "Runs test that depend on a fully running Skyrim engine in the process.",
"inherits": "tests-all",
"filter": {
"include": {
"label": "[e2e]"
}
}
}
]
}

56
Source/ArtifactTrackerDLL/README.md Normal file
View File

@ -0,0 +1,56 @@
# Artifact Tracker DLL — building
The plugin builds against a **pinned CommonLibSSE-NG** pulled in with CMake
`FetchContent`. There is no vcpkg dependency: everything is fetched from source
at configure time, so the same `CMakePresets.json` drives both the command line
and Visual Studio.
## Command line
```cmd
build.cmd :: release-msvc (default)
build.cmd debug-msvc
```
`build.cmd` locates Visual Studio via `vswhere`, imports the MSVC x64
environment (`vcvars64.bat` — the part VS sets up for you automatically), then
runs the preset:
```cmd
cmake --preset build-release-msvc
cmake --build --preset release-msvc
```
The built `ArtifactTracker.dll` is copied to `../../SKSE/Plugins/`.
## Visual Studio
Open the `Source/ArtifactTrackerDLL` folder (File ▸ Open ▸ Folder). VS reads
`CMakePresets.json`, configures the MSVC environment itself, and builds with the
same presets. No extra setup.
## Dependencies (pinned, fetched automatically)
| Dependency | Pin | Why |
|-------------------|----------------|-----|
| CommonLibSSE-NG | `alandtse/CommonLibVR` @ `aacbd76` | SKSE API (SE/AE/VR) |
| DirectXTK / DirectXMath | jul2025 / apr2025 | required by CommonLibVR |
| rapidcsv | v8.90 | required by CommonLibVR |
| spdlog | v1.17.0 | logging (also used directly) |
| simpleini | v4.25 | reads `ArtifactTracker.ini` |
## Note: the DirectXTK shader patch
`cmake/patch_directxtk.cmake` is applied to DirectXTK via `FetchContent`
`PATCH_COMMAND`. DirectXTK compiles its HLSL shaders by running
`cmake -E env … CompileShaders.cmd` with a **bare** script name, relying on the
current directory being on the executable search path.
That only holds when `NoDefaultCurrentDirectoryInExePath` is **unset** — which is
the case inside Visual Studio's build environment, but **not** in a hardened
command-line shell that sets it (there, `cmake -E env` refuses to look in the
current directory and the step fails with "no such file or directory"). The
patch rewrites that one invocation to an absolute path so shaders compile
regardless of the environment. Removing it will break command-line builds while
still "working" in Visual Studio. The patch is idempotent and only touches the
shader command line.

43
Source/ArtifactTrackerDLL/build.cmd Normal file
View File

@ -0,0 +1,43 @@
@echo off
rem ---------------------------------------------------------------------------
rem Command-line build wrapper.
rem
rem Sets up the MSVC x64 environment (the piece Visual Studio configures for you
rem automatically) and then drives the exact same CMake presets that Visual
rem Studio uses, so both build paths stay in sync.
rem
rem Usage: build.cmd [preset]
rem preset defaults to "release-msvc". Other options: debug-msvc,
rem release-clang-cl, debug-clang-cl (must match a name in CMakePresets.json).
rem ---------------------------------------------------------------------------
setlocal
set "PRESET=%~1"
if "%PRESET%"=="" set "PRESET=release-msvc"
set "CONFIGURE_PRESET=build-%PRESET%"
cd /d "%~dp0"
rem --- Locate Visual Studio (or the C++ Build Tools) ---
set "VSWHERE=%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe"
if not exist "%VSWHERE%" (
echo [ERROR] vswhere.exe not found. Install Visual Studio 2022 or the C++ Build Tools.
exit /b 1
)
set "VSINSTALL="
for /f "usebackq delims=" %%i in (`"%VSWHERE%" -latest -products * -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -property installationPath`) do set "VSINSTALL=%%i"
if not defined VSINSTALL (
echo [ERROR] No Visual Studio installation with the C++ toolset was found.
exit /b 1
)
rem --- Import the MSVC x64 developer environment ---
call "%VSINSTALL%\VC\Auxiliary\Build\vcvars64.bat" || exit /b 1
rem --- Configure and build using the shared presets ---
cmake --preset %CONFIGURE_PRESET% || exit /b 1
cmake --build --preset %PRESET% || exit /b 1
echo.
echo [OK] Built preset "%PRESET%". Plugin deployed to SKSE\Plugins\.

23
Source/ArtifactTrackerDLL/cmake/patch_directxtk.cmake Normal file
View File

@ -0,0 +1,23 @@
# Patch applied to DirectXTK's CMakeLists.txt via FetchContent PATCH_COMMAND.
#
# DirectXTK compiles its HLSL shaders by running Src/Shaders/CompileShaders.cmd
# through `cmake -E env ... CompileShaders.cmd` (a bare script name, relying on
# the custom command's WORKING_DIRECTORY). Modern CMake no longer resolves a
# bare command name against the working directory, so the step fails with
# "no such file or directory" and the whole build stops.
#
# Rewrite that single invocation to an absolute path. WORKING_DIRECTORY is left
# untouched so the script still runs with Src/Shaders as its CWD. The replace is
# idempotent: after patching, the original "CompileShaders.cmd ARGS" substring is
# gone, so re-running the patch is a no-op. It also targets only the COMMAND line
# (the MAIN_DEPENDENCY reference already uses a full path and is not matched).
set(_dxtk_cmakelists "CMakeLists.txt")
file(READ "${_dxtk_cmakelists}" _dxtk_content)
string(REPLACE
"CompileShaders.cmd ARGS"
"\"\${PROJECT_SOURCE_DIR}/Src/Shaders/CompileShaders.cmd\" ARGS"
_dxtk_content "${_dxtk_content}")
file(WRITE "${_dxtk_cmakelists}" "${_dxtk_content}")
message(STATUS "Patched DirectXTK CompileShaders.cmd invocation to use an absolute path.")

8
Source/ArtifactTrackerDLL/cmake/x64-windows-skse.cmake
View File

@ -1,8 +0,0 @@
set(VCPKG_TARGET_ARCHITECTURE x64)
set(VCPKG_CRT_LINKAGE dynamic)
if (${PORT} MATCHES "fully-dynamic-game-engine|skse|qt*")
set(VCPKG_LIBRARY_LINKAGE dynamic)
else ()
set(VCPKG_LIBRARY_LINKAGE static)
endif ()

36
Source/ArtifactTrackerDLL/src/ArtifactTracker.cpp
View File

@ -225,9 +225,9 @@ namespace ArtifactTracker
#endif
g_persistentMap.clear();
g_persistentStorage->ForEachForm([&](RE::TESForm& a_exform) {
if (&a_exform) {
g_persistentMap[a_exform.formID] = a_exform.As<RE::TESObjectREFR>();
g_persistentStorage->ForEachForm([&](RE::TESForm* a_exform) {
if (a_exform) {
g_persistentMap[a_exform->formID] = a_exform->As<RE::TESObjectREFR>();
}
return RE::BSContainer::ForEachResult::kContinue;
});
@ -400,8 +400,8 @@ namespace ArtifactTracker
RE::TESObjectREFR* cellStorage = nullptr;
bool bHasDupes = false;
g_persistentStorage->ForEachForm([&](RE::TESForm& a_form) {
const auto refr = a_form.As<RE::TESObjectREFR>();
g_persistentStorage->ForEachForm([&](RE::TESForm* a_form) {
const auto refr = a_form->As<RE::TESObjectREFR>();
if (refr && refr->GetParentCell()->formID == a_formID && refr->GetBaseObject() == g_cellContainer) {
if (cellStorage) {
log::warn("Multiple cell storages detected in {}", cell->GetName());
@ -443,12 +443,12 @@ namespace ArtifactTracker
RE::TESObjectREFR* cellStorage = nullptr;
std::vector<RE::TESObjectREFR*> dupes;
cell->ForEachReference([&cellStorage, &dupes](RE::TESObjectREFR& a_ref) {
if (a_ref.GetBaseObject() == g_cellContainer && !a_ref.IsMarkedForDeletion()) {
cell->ForEachReference([&cellStorage, &dupes](RE::TESObjectREFR* a_ref) {
if (a_ref->GetBaseObject() == g_cellContainer && !a_ref->IsMarkedForDeletion()) {
if (cellStorage) {
dupes.push_back(&a_ref);
dupes.push_back(a_ref);
} else {
cellStorage = &a_ref;
cellStorage = a_ref;
}
}
return RE::BSContainer::ForEachResult::kContinue;
@ -520,19 +520,19 @@ namespace ArtifactTracker
const auto cell = g_cellStorage->GetParentCell();
const auto inv = g_cellStorage->GetInventory();
cell->ForEachReference([&](RE::TESObjectREFR& a_ref) {
if (ignoreFormID && ignoreFormID == a_ref.formID) {
cell->ForEachReference([&](RE::TESObjectREFR* a_ref) {
if (ignoreFormID && ignoreFormID == a_ref->formID) {
return RE::BSContainer::ForEachResult::kContinue;
}
const auto baseObj = a_ref.GetBaseObject();
const auto baseObj = a_ref->GetBaseObject();
if (IsValidContainer(&a_ref)) {
if (g_cellContainer == baseObj || baseObj->formID == 0xDC9E7 || g_persistentMap.contains(a_ref.formID)) { // skip persistent and PlayerBookShelfContainer
if (IsValidContainer(a_ref)) {
if (g_cellContainer == baseObj || baseObj->formID == 0xDC9E7 || g_persistentMap.contains(a_ref->formID)) { // skip persistent and PlayerBookShelfContainer
return RE::BSContainer::ForEachResult::kContinue;
}
const auto contInv = a_ref.GetInventory([&](RE::TESBoundObject& a_object) -> bool {
const auto contInv = a_ref->GetInventory([&](RE::TESBoundObject& a_object) -> bool {
return !cellItems.contains(a_object.formID) && g_artifactAllFormTypes.contains(a_object.GetFormType());
});
@ -553,7 +553,7 @@ namespace ArtifactTracker
return RE::BSContainer::ForEachResult::kContinue;
}
if (!g_artifactAllFormTypes.contains(baseObj->GetFormType()) || a_ref.IsDisabled() || a_ref.IsMarkedForDeletion() || cellItems.contains(baseObj->formID)) {
if (!g_artifactAllFormTypes.contains(baseObj->GetFormType()) || a_ref->IsDisabled() || a_ref->IsMarkedForDeletion() || cellItems.contains(baseObj->formID)) {
return RE::BSContainer::ForEachResult::kContinue;
}
@ -810,8 +810,8 @@ namespace ArtifactTracker
}
if (a_refOrList->Is(RE::FormType::FormList)) {
a_refOrList->As<RE::BGSListForm>()->ForEachForm([&](RE::TESForm& a_exform) {
const auto refrItem = a_exform.As<RE::TESObjectREFR>();
a_refOrList->As<RE::BGSListForm>()->ForEachForm([&](RE::TESForm* a_exform) {
const auto refrItem = a_exform->As<RE::TESObjectREFR>();
if (refrItem) {
AddRefArtifactsToList(refrItem, a_targetList, a_excludeList);
}

4
Source/ArtifactTrackerDLL/src/Util.h
View File

@ -100,8 +100,8 @@ inline bool RefListHasItem(RE::TESForm* a_refOrList, RE::FormID a_formID)
if (list) {
bool bResult = false;
list->ForEachForm([&](RE::TESForm& a_form) {
if (&a_form && RefListHasItem(&a_form, a_formID)) {
list->ForEachForm([&](RE::TESForm* a_form) {
if (a_form && RefListHasItem(a_form, a_formID)) {
bResult = true;
return RE::BSContainer::ForEachResult::kStop;
}

15
Source/ArtifactTrackerDLL/vcpkg-configuration.json
View File

@ -1,15 +0,0 @@
{
"registries": [
{
"kind": "git",
"repository": "https://gitlab.com/colorglass/vcpkg-colorglass",
"baseline": "6309841a1ce770409708a67a9ba5c26c537d2937",
"packages": [
"commonlibsse-ng",
"gluino",
"script-extender-common",
"skse"
]
}
]
}

21
Source/ArtifactTrackerDLL/vcpkg.json
View File

@ -1,21 +0,0 @@
{
"$schema": "https://raw.githubusercontent.com/microsoft/vcpkg/master/scripts/vcpkg.schema.json",
"name": "artifact-tracker",
"version-string": "1.0.11",
"port-version": 0,
"description": "Artifact Tracker",
"homepage": "https://mod.pub/skyrim-se/36-artifact-tracker",
"license": null,
"features": {
"plugin": {
"description": "Tracks found and stored artifacts.",
"dependencies": [
"commonlibsse-ng",
"simpleini"
]
}
},
"default-features": [
"plugin"
]
}