R2API ArtifactCode

版本 v1.0.1·更新於 2023-05-29

API for making Artifact Codes

模組介紹 作者原文

R2API.ArtifactCode - Artifact Codes and Compound addition

About

R2API.ArtifactCode is a submodule assembly for R2API that simplifies the process of adding new Artifact Codes to the Artifact Portal Dialer in Sky Meadow,

alongside the additon of custom Artifact Compounds (Such as the vanilla compounds, Circle, Square, Triangle & Diamond).

Use Cases / Features

R2API.ArtifactCode can be used for mods to add their own ArtifactTrials to the game so their artifacts can be unlocked like regular, vanilla artifacts.

This is done via the ArtifactCode scriptable object, which works as a simplified way of creating the required Sha256HashAsset using int values to represent the individual Compound Values.

The Int values are represented by 3 Vector3Ints, representing the top row, middle row and bottom row of compounds.

Adding compounds is done using the ArtifactCompoundDef scriptable object from the base game. The value of the ArtifactCompoundDef must be unique.

A static class populated with constant values that represent the default, vanilla compounds, these are:

Empty = 11

Square = 7

Circle = 1

Triangle = 3

Diamond = 5

Related Pages

The page for Artifacts in the R2Wiki contains a tutorial on how to use the API

Changelog

'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 外掛

  1. 本站下載的壓縮包就是模組本體,通常是 BepInEx 外掛(解壓後得到 .dll 或外掛資料夾)。
  2. 建議流程:用社群模組管理器(如 r2modman)選中本遊戲後匯入該模組,管理器會自動裝好 BepInEx 前置並處理依賴。
  3. 手動流程:先在遊戲目錄裝好 BepInEx 載入器,再把解壓出的 .dll 或外掛資料夾放進 BepInEx/plugins/。
  4. 啟動遊戲,BepInEx 控制台會列印載入日誌;確認這個模組出現在日誌裡即為安裝成功。

帶「前置依賴」的模組需要一併安裝,否則不會載入。功能開關通常在遊戲內或外掛自帶的設定檔裡調整。

前置依賴

下面這些內容需要先安裝,否則該模組不會生效:

bbepis-BepInExPackRiskofThunder-HookGenPatcherRiskofThunder-R2API_Core

檔案與校驗

檔案名稱
R2API_ArtifactCode-1.0.1.zip
檔案大小
17.4 KiB