OptiScaler plugin SDK
ASI plugins loaded by OptiScaler can add their own tabs to the OptiScaler menu and keep their settings in OptiScaler.ini.
- 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 plugin: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, right after
InitializeASI. Tabs registered here show up once it returnstrue. Returnfalseto opt out; the tabs you registered are then dropped andRegisterTabfails from then on. -
Put the
.asifile in thepluginsfolder and setLoadAsiPlugins=trueinOptiScaler.ini. -
Your tabs appear under PLUGINS in the menu sidebar.
Custom upscaler and FG dlls in custom/<name>/<kind> can export OptiPluginInit too. It's called when OptiScaler loads the dll, which happens when the upscaler or FG is first used, so their tabs can show up after the game started.
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 the plugin file name without the extension and without a -loadlate suffix. For a custom dll it's the <name> folder.
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.