R2API Unlockable
API for adding custom achievements and unlockables
模組介紹 作者原文
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.
安裝與使用 安裝：BepInEx 外掛
- 本站下載的壓縮包就是模組本體，通常是 BepInEx 外掛（解壓後得到 .dll 或外掛資料夾）。
- 建議流程：用社群模組管理器（如 r2modman）選中本遊戲後匯入該模組，管理器會自動裝好 BepInEx 前置並處理依賴。
- 手動流程：先在遊戲目錄裝好 BepInEx 載入器，再把解壓出的 .dll 或外掛資料夾放進 BepInEx/plugins/。
- 啟動遊戲，BepInEx 控制台會列印載入日誌；確認這個模組出現在日誌裡即為安裝成功。
帶「前置依賴」的模組需要一併安裝，否則不會載入。功能開關通常在遊戲內或外掛自帶的設定檔裡調整。
下面這些內容需要先安裝，否則該模組不會生效：