A library for custom items, equipments, buffs and elites in Risk of Rain 2.
ItemLib is a BepinEx plugin and a Monomod patch, that will also be used as an assembly reference for your BepinEx Plugin (and an Unity AssetBundle for custom assets)
ItemLib.slnYou may have to fix the assembly reference ItemLib.dll for the ExampleItemMod project.
Once your project is ready you'll want to have a method defined that will return a CustomItem / CustomEquipment / CustomBuff / CustomElite object and have an Item Attribute at the top so that the library can load it. \
Depending on what you want, you'll want to change the ItemType (enum) in the attribute. \
Leave both pickupModelPath and/or pickupIconPath empty if you want to have a custom prefab / icon for your item. \
For having a custom prefab and icon you will need to make an AssetBundle in Unity, you could also download the unitypackage and use it as an example.
A class example for a BepinEx mod is available here
An AssetBundle project example is available here
[Item(ItemAttribute.ItemType.Item)]
public static CustomItem Test()
{
// Load the AssetBundle you made with the Unity Editor
_exampleAssetBundle = AssetBundle.LoadFromFile(System.IO.Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location) + "/Rampage_data");
_prefab = _exampleAssetBundle.LoadAsset<GameObject>("Assets/Import/belt/belt.prefab");
_icon = _exampleAssetBundle.LoadAsset<Object>("Assets/Import/belt_icon/belt_icon.png");
ItemDef newItemDef = new ItemDef
{
tier = ItemTier.Tier3,
pickupModelPath = "", // leave it empty and give directly the prefab / icon on the return but you can also use an already made prefab by putting a path in there.
pickupIconPath = "",
nameToken = "Custom Item Example",
pickupToken = "i'm a custom item. i do sticky bomb on kill",
descriptionToken = "yes"
};
_itemDisplayRules = new ItemDisplayRule[1]; // keep this null if you don't want the item to show up on the survivor 3d model. You can have multiple rules !
_itemDisplayRules[0].followerPrefab = _prefab; // the prefab that will show up on the survivor
_itemDisplayRules[0].childName = "Chest"; // this will define the starting point for the prefab, you can see what are the differents name available in the prefab model of the survivors.
_itemDisplayRules[0].localScale = new Vector3(0.15f,0.15f,0.15f);
_itemDisplayRules[0].localAngles = new Vector3(0f, 180f, 0f);
_itemDisplayRules[0].localPos = new Vector3(-0.35f, -0.1f, 0f);
return new CustomItem(newItemDef, _prefab, _icon, _itemDisplayRules);
}You'll want to retrieve the id of your custom item using the name you gave it in the method body. Using the GetItemId (GetEquipmentId for equipment) method from the library :
_myCustomItemId = ItemLib.GetItemId("Custom Item Example"); // get the item's id
On.RoR2.CharacterBody.OnKilledOther += (orig, self, damageReport) =>
{
orig(self, damageReport);
if (self.inventory.GetItemCount((ItemIndex) _myCustomItemId) > 0)
{
// do stuff
}
};[Item(ItemAttribute.ItemType.Equipment)]
public static ItemLib.CustomEquipment Test()
{
// Load the AssetBundle you made with the Unity Editor
_exampleAssetBundle = AssetBundle.LoadFromFile(System.IO.Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location) + "/Rampage_data");
_prefab = _exampleAssetBundle.LoadAsset<GameObject>("Assets/Import/belt/belt.prefab");
_icon = _exampleAssetBundle.LoadAsset<Object>("Assets/Import/belt_icon/belt_icon.png");
EquipmentDef newEquipmentDef = new EquipmentDef
{
cooldown = 45f,
pickupModelPath = "",
pickupIconPath = "",
nameToken = "Custom Equipment Example",
pickupToken = "pickup sample text",
descriptionToken = "description in logbook",
canDrop = true,
enigmaCompatible = true
};
_itemDisplayRules = new ItemDisplayRule[1]; // keep this null if you don't want the item to show up on the survivor 3d model. You can have multiple rules !
_itemDisplayRules[0].followerPrefab = _prefab; // the prefab that will show up on the survivor
_itemDisplayRules[0].childName = "Chest"; // this will define the starting point for the prefab, you can see what are the differents name available in the prefab model of the survivors.
_itemDisplayRules[0].localScale = new Vector3(0.15f,0.15f,0.15f);
_itemDisplayRules[0].localAngles = new Vector3(0f, 180f, 0f);
_itemDisplayRules[0].localPos = new Vector3(-0.35f, -0.1f, 0f);
return new CustomEquipment(newEquipmentDef, _prefab, _icon);
}_myCustomItemId = ItemLib.ItemLib.GetEquipmentId("Custom Equipment Example");
// Need to hook in here so the item actually proc, the orig method is a switch case on the equipmentIndex
On.RoR2.EquipmentSlot.PerformEquipmentAction += (orig, self, equipmentIndex) =>
{
if ((int) equipmentIndex == _myCustomItemId)
{
DetonateAlive(100);
return true; // must
}
return orig(self, equipmentIndex); // must
};Buffs in RoR2 are status effects, which may or may not be 'buffs' in the beneficial sense. By creating a custom buff, it will add an array entry to all characters that can track whether that buff is present, will automatically display an icon when the buff is active and also gives you access to handy methods like adding a timed buff to a character that automatically decays. To create a custom buff, just provide an Icon, buffColor and whether it's stackable. If no Icon is specified, it will default to a square of the buffColor provided. To make the buff have effects in the code, hook whatever methods you want to modify, then use CharacterBody.HasBuff to check for its presence. You can use AddBuff and AddTimedBuff to apply the buff.
[Item(ItemAttribute.ItemType.Buff)]
public static CustomBuff TestBuff()
{
LoadAssets();
var buffDef = new BuffDef
{
buffColor = Color.green,
canStack = false
};
Sprite icon = null; //Can load a custom sprite asset here; null defaults to a blank colored square
return new CustomBuff("MyBuff", buffDef, icon);
}Elites in Risk of Rain 2 are internally made up of three key elements. There is an EliteDef, plus every elite has a custom Equipment, which then passively applies a custom Buff. To create custom elites, you only need to implement one method and the associated equipment/buff will automatically be created and linked to it. This method is implemented very much like the custom items and equipment:
[Item(ItemAttribute.ItemType.Elite)]
public static CustomElite TestElite()
{
LoadAssets();
var eliteDef = new EliteDef
{
modifierToken = "Cloaky",
color = new Color32(255, 105, 180, 255)
};
var equipDef = new EquipmentDef
{
cooldown = 10f,
pickupModelPath = "",
pickupIconPath = "",
nameToken = "Cloaky",
pickupToken = "Cloaky",
descriptionToken = "Cloaky",
canDrop = false,
enigmaCompatible = false
};
var buffDef = new BuffDef
{
buffColor = eliteDef.color,
canStack = false
};
var equip = new CustomEquipment(equipDef, _prefab, _icon, _itemDisplayRules);
var buff = new CustomBuff("Affix_Cloaky", buffDef, null);
var elite = new CustomElite("Cloaky", eliteDef, equip, buff, 1);
return elite;
}Note that we're reusing equipment _prefab and _icon assets from the Equipment example here. The final parameter of the CustomElite constructor here is the 'tier'. According to vanila spawning mechanics, tiers 1 and 2 have different modifiers, as well as some additional requirements (tier 2 can only spawn after the first loop.) For more fine-grained control over spawning, consider using the Elite Spawning Overhaul mod.