R2API Unlockable
API for adding custom achievements and unlockables
About this mod Author’s original text
R2API.Unlockable - Creation of Unlockables, Achievement and Tying them together.
About
R2API.Unlockable is a submodule assembly for R2API that allows mod creators to add new Unlockables and Achievements to the game. These can later be used to gate certain content pieces from your mods so that an achievement needs to be unlocked before you can get to use a specific content (such as an item)
Use Cases / Features
R2API.Unlockable is mainly used for adding Unlockables that get unlocked after obtaining an AchievementDef, please note that unlocks such as stage / monsters log books should not be added with R2API.Unlockable but rather with R2API.ContentAddition
A valid unlockable and achievement pair is defined by a class that inherits from both BaseAchievement and IModdedUnlockableDataProvider, which gives enough data to create both the UnlockableDef and AchievementDef.
Related Pages
Changelog
'1.0.2'
- Add missing BepInDependency to R2API.ContentManagement
'1.0.1'
- Fix the NuGet package which had a dependency on a non-existent version of R2API.Core.
'1.0.0'
- Split from the main R2API.dll into its own submodule.
Install & use Install: BepInEx plugin
- The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
- Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
- Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
- Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.
Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.
Install these first, or the mod will not work: