doodlum / skyrim-community-shaders

Skyrim Community Shaders SKSE core plugin for community-driven advanced graphics modifications. Nexus User Wiki Requirements • Any terminal of your choice (e.g., PowerShell) • Visual Studio Community 2022 • Desktop development with C++ • CMake Tools for Windows • HLSL Tools • Git • Edit the environment variable and add the Git.exe install path as a new value Optional Requirements • CMake • No need to install manually if you have Visual Studio CMake Tools installed • CMake 4.0+ is **not** supported right now • Edit the environment variable and add the cmake.exe install path as a new value • Instructions for finding and editing the environment variable can be found here • Vcpkg • Install vcpkg using the directions in vcpkg's Quick Start Guide • After install, add a new environment variable named with the value as the path to the folder containing vcpkg • Make sure your local vcpkg repo matches the commit id specified in in otherwise you might get another version of a non pinned vcpkg dependency causing undefined behaviour User Requirements • Address Library for SKSE • Needed for SSE/AE • VR Address Library for SKSEVR • Needed for VR Build Instructions Clone the Repository with submodules To clone the repository with all submodules, run the following command in your terminal: Visual Studio build To build the project, just open with Visual Studio's "Open Folder" feature. (Ensure you have selected when installing VS) Follow the prompts to and the project. It should generate the AIO package in the folder by default. Zip package & Optional targets If you change the into , you can find optional targets to create zip packages for each feature. Right click on the target and select to create the zip package in . Advanced build with CMake in command line Open the "Developer PowerShell for VS 2022" or the "x64 Native Tools Command Prompt" (these set up the Visual Studio toolchain for you). Then from the repository root run: Notes • If you prefer to run the VC environment manually, launch Developer PowerShell or the x64 Native Tools prompt instead of calling vcvarsall.bat directly from PowerShell. • The convenience wrapper also captures these steps. Build a zip package You can build zip packages for optional cmake targets. Currently support , , , and : For more details about packaging targets, options, and the difference between automated and manual packaging, see the "Manual packaging targets (detailed)" section in . CMAKE Options (optional) If you want an example CMakeUserPreset to start off with you can copy the -> AUTO_PLUGIN_DEPLOYMENT • This option is default • Make sure is set to in • Change the value to match your desired outputs, if you want multiple folders you can separate them by is shown in the template example TRACY_SUPPORT • This option is default • This will enable tracy support, might need to delete build folder when this option is changed When using custom preset you can call BuildRelease.bat with an parameter to specify which preset to configure eg: When switching between different presets you might need to remove the build folder Build with Docker For those who prefer to not install Visual Studio or other build dependencies on their machine, this encapsulates it. This uses Windows Containers, so no WSL for now. • Install Docker first if not already there. • In a shell of your choice run to switch to Windows containers and create the build container: • Then run the build: • Retrieve the generated build files from the folder. • In subsequent builds only run the build step (3.) Troubleshooting Build with Docker If you run into build errors during step 3, you can try adding : Debugging Launching MO2-SKSE-Skyrim from commandline • Open Steam • Close ModOrganizer GUI • Add (MO2 Folder) to your PATH, or use the path of it • Run the commands: Capture with RenderDoc In Launch Application Menu, use the following settings: • Executable Path: • Working Directory: • Command-line Arguments: • [x] **Capture Child Process** License Default GPL-3.0-or-later WITH Modding Exception AND GPL-3.0 Linking Exception (with Corresponding Source). Specifically, the Modded Code includes: • Skyrim (and its variants) • Hardware drivers to enable additional functionality provided via proprietary SDKs, such as Nvidia DLSS and AMD FidelityFX FSR3 The Modding Libraries include: • SKSE • Commonlib (and variants). Shaders See LICENSE within each directory; if none, it's Default • Features Shaders • Package Shaders Icons • Community Shaders Logo is not covered by the GPL-3.0 license. It is provided solely for personal use (e.g., building from source) and may only be used in unmodified form. There is no license for any other purpose or to distribute the logo. No trademark license is granted for the logo. Any use not expressly permitted is prohibited without the express written consent of the Community Shaders team.