Developers

Community Shaders Base Package

This is the base package that loads all the custom shaders.

DLL

This is the main dll in the repo that enables the replacement of vanilla shaders with new shaders.

Can be found primarily in https://github.com/doodlum/skyrim-community-shaders/tree/main/src

Shaders

The default shaders will be found in https://github.com/doodlum/skyrim-community-shaders/tree/main/package/Shaders.

These default shaders should be overwritten by feature specific shaders.

Features

These are custom features that are loaded after the default CS install.

DLL

To add a new feature, the DLL needs to be modified. See prior examples of adding new features for the full list. https://github.com/doodlum/skyrim-community-shaders/pull/83

• feature.cpp https://github.com/doodlum/skyrim-community-shaders/blob/dev/src/Feature.cpp

The main features should live here: https://github.com/doodlum/skyrim-community-shaders/tree/dev/src/Features

Virtual functions

Required functions:

• GetName
  • Used in ImGui feature list and json entry per feature
• GetShortName
  • Used for ini loading (No spaces usually)
• SetupResources
  • Called once in startup
• Reset
  • Called once per frame
• DrawSettings
  • Used for rendering imgui
• Draw
  • Normal rendering code here
• Save
  • Serialize settings to json

Functions that should be defined

• Load
  • Deserialize settings from json, also need to call Feature::Load after loading

Functions that can be overridden

These are already default defined in Feature.h but can be overriden if you need to do something extra like defined below

• DrawDeferred
  • This one is not called yet, that is in the subsurface-scattering branch
• DataLoaded
  • Called by SKSE kDataLoaded event
• PostPostLoad
  • Called by SKSE kPostPostLoad event
• ClearShaderCache
  • Called by imgui clear shader cache button

Shaders

Shaders are stored in https://github.com/doodlum/skyrim-community-shaders/tree/dev/features

Debugging

To debug CS you will need to be able to debug both the cpp dll and the hlsl shader files.

Remove DRM

1. Save a copy of the original exe so you can replace it.
2. Use Steamless to strip the SteamDRM from the Skyrim.exe. This is required for a debugger to attach.

Disable ASLR

To ensure addresses don't move, disable ASLR. This can be done with CFF Explorer. Optional Header -> DLL Characteristics -> DLL can move. Disable this.

Attach

Renderdoc

Renderdoc can be used to debug shaders.

1. Disable Skyrim Upscaler. They are not compatible.
2. Enable Global Hooking
3. Set up Launch Application so it will find the exe when it launches. Make sure to Enable Global Hook which will grey out all settings. This also will prevent closing renderdoc until you disable the setting.

4. Launch Skyrim. You will know RenderDoc has connected because of the message in the top left of Skyrim Capturing D3D11. If it doesn't show, try toggling the global hook and launching again.

5. In game, press F12 to capture the scene.
6. In Renderdoc, File -> Attach to Running Instance. Select Skyrim and Connect to App.

7. Once attached, a new tab will appear. Double click any captures to load.

Resources

• HLSL Tutorial