OptiScaler plugin SDK
Dlls loaded by OptiScaler can add their own tabs to the OptiScaler menu and keep their settings in OptiScaler.ini. Two kinds of dlls get the API:
- ASI plugins in the
pluginsfolder, loaded whenLoadAsiPlugins=true. - Custom upscaler and FG dlls in
custom/<name>/<kind>(ffx,ffx_vk,dlss,dlssgordlssd).
Both use the API the same way. Below, "plugin" means either kind.
- The API is a plain C function table defined in
optiscaler_plugin.h. This header is all you need: you don't link against OptiScaler or ImGui. - Plugins don't have to be rebuilt for newer OptiScaler versions. Fields are only ever appended to
OptiPluginApi, so before you use a field added after version 1, check it withOPTI_API_HAS(api, Field).
Getting started
-
Export
OptiPluginInitfrom your dll:extern "C" __declspec(dllexport) bool OptiPluginInit(const OptiPluginApi* api, OptiPlugin* plugin) { api->RegisterTab(plugin, "My Plugin", "Tooltip in the sidebar", DrawTab, nullptr); return true; }OptiScaler calls it once per dll:
- ASI plugins: right after
InitializeASI, when the game starts (or afterLateAsiPluginsDelayfor-loadlateplugins). - Custom upscaler and FG dlls: when OptiScaler loads the dll, the first time that upscaler or FG is used. This can be well after the game started.
Tabs registered here show up once it returns
true. Returnfalseto opt out; the tabs you registered are then dropped andRegisterTabfails from then on. - ASI plugins: right after
-
Install the dll:
- ASI plugin: put the
.asifile in thepluginsfolder and setLoadAsiPlugins=trueinOptiScaler.ini. - Custom upscaler, FG or ray reconstruction: put the dll in
custom/<name>/<kind>and select<name>as the upscaler, FG or ray reconstruction upscaler in the menu.
- ASI plugin: put the
-
Your tabs appear under PLUGINS in the menu sidebar.
Drawing
Inside a draw callback you can use Section, Text, Checkbox, SliderFloat/SliderInt, Combo, InputText, ColorEdit, Button, SameLine, Disabled, ItemTooltip and ItemDeactivatedAfterEdit.
Sectionstarts a card like the ones in OptiScaler's own tabs.Combotakes an optional array of bools that greys out items.ItemDeactivatedAfterEditis true on the frame a slider is released, for values that should apply once instead of on every frame of a drag.- Cards, disabled blocks and IDs are closed by OptiScaler after the callback, so a plugin can't leave ImGui in a broken state.
- Widget functions do nothing when called outside a draw callback or from another thread.
- Draw callbacks run on the render thread while the menu is open. Keep them fast, don't call D3D/Vulkan from them, and protect any data you share with your own threads.
- If a callback crashes, OptiScaler disables that tab and logs it, instead of crashing the game.
Settings
Settings are stored in the [Plugin.<name>] section of OptiScaler.ini, where <name> is:
-
for an ASI plugin, the file name without the extension and without a
-loadlatesuffix; -
for a custom upscaler or FG dll, the
<name>folder incustom, not the dll's file name. -
Get*returns the default when the key is missing or set toauto. -
Set*only changes the value in memory.SaveSettings, or Save INI in the menu, writes the file. -
ResetValueremoves the key.
Sample
sample/ contains a plugin that uses every function of the API.
To build it:
- Install Visual Studio 2022 or newer with the Desktop development with C++ workload. The free Community edition is enough.
- Open
sample/SamplePlugin.vcxprojin Visual Studio (File → Open → Project/Solution). - Select the
Releaseconfiguration and thex64platform in the toolbar. - Build → Build Solution.
The plugin is written to sample/bin/Release/SamplePlugin.asi. Copy it to the plugins folder next to OptiScaler and set LoadAsiPlugins=true in OptiScaler.ini.
License
The SDK files that carry an SPDX-License-Identifier: MIT tag are licensed under the MIT License, so plugins can use them under any license. OptiScaler itself is licensed under the GNU GPL v3.