RiskofThunder-R2API_Items icon

R2API Items

API for adding custom items

Last updated a year ago
Total downloads 1470396
Total rating 5 
Categories Libraries
Dependency string RiskofThunder-R2API_Items-1.0.3
Dependants 763 other packages depend on this package

This mod requires the following mods to function

bbepis-BepInExPack-5.4.2109 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.2109
RiskofThunder-HookGenPatcher-1.2.3 icon
RiskofThunder-HookGenPatcher

MMHOOK generation at runtime.

Preferred version: 1.2.3
RiskofThunder-R2API_Core-5.0.8 icon
RiskofThunder-R2API_Core

Core R2API module

Preferred version: 5.0.8
RiskofThunder-R2API_ContentManagement-1.0.1 icon
RiskofThunder-R2API_ContentManagement

API for adding content to the game

Preferred version: 1.0.1

README

R2API.Items - Item, ItemTags, Equipments, ItemDisplays and more

About

R2API.Items is a submodule assembly for R2API that allows mod creators to add new Items, Equipments, ItemTags, and manage the Items and Equipment's ItemDisplays.

Use Cases / Features

R2API.Items is mainly used for adding new ItemDefs and EquipmentDefs to the game, To facilitate the inclusion of Itemdisplays, R2API.Items provides wrapper classes for both Items and Equipments.

CustomItem: Represents a new ItemDef being added, includes a field for handling the Item's ItemDisplayRules
CustomEquipment: Represents a new EquipmentDef being added, includes a field for handling the Equipment's ItemDisplayRules.

The ItemDisplayRuleDictionary is a class included with the module, which provides utilities and systems for adding new ItemDisplays to your items, including default display rules if a character does not provide it's own item display for your item.

Finally, ItemAPI includes the ability to add new ItemTags to the game, which can be used for multiple things ingame.

Related Pages

A detailed tutorial on how to make custom items using ItewmAPI can be found here

Changelog

'1.0.3'

  • Add missing BepInDependency to R2API.ContentManagement

'1.0.2'

  • Fix the NuGet package which had a dependency on a non-existent version of R2API.Core.

'1.0.1'

  • Fix invalid IDRS checker telling IDRS are not correct when they actually are.

'1.0.0'

  • Split from the main R2API.dll into its own submodule.