* Plugin API: ComboEx and ItemDeactivatedAfterEdit Two widget functions appended to the end of OptiPluginApi. The API version stays 1 and no field moves. - ComboEx: Combo with greyed out items, bit i of disabledItems disables items[i]. Lets a plugin keep an option in the list while it's not available instead of hiding it. Combo now calls it with no items disabled. - ItemDeactivatedAfterEdit: true on the frame the previous widget stopped being edited, a slider was released for example, so a plugin can apply a value once instead of on every frame of a drag. The sample uses both: Ultra quality is greyed out below 8 samples and the strength is logged once when its slider is released. A plain Combo picks the counter's log level, so the sample still calls every function. * Plugin API: 64 bit ComboEx mask, sample steps Ultra down ComboEx takes a uint64_t disabledItemsMask, so the first 64 items can be greyed out. In the sample, lowering Samples below 8 while Ultra is selected moves Quality to High.
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. Returnfalseto opt out; any tabs you registered are then removed. -
Put the
.asifile in thepluginsfolder and setLoadAsiPlugins=trueinOptiScaler.ini. -
Your tabs appear under PLUGINS in the menu sidebar.
Drawing
Inside a draw callback you can use Section, Text, Checkbox, SliderFloat/SliderInt, Combo/ComboEx, InputText, ColorEdit, Button, SameLine, Disabled, ItemTooltip and ItemDeactivatedAfterEdit.
Sectionstarts a card like the ones in OptiScaler's own tabs.ComboExis a combo whose items can be greyed out.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.
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.