RimWorld

RimWorld

97 ratings
Animal Apparel: Framework
3
2
2
   
Award
Favorite
Favorited
Unfavorite
Mod, 1.6
File Size
Posted
Updated
120.089 KB
1 Jul @ 8:48am
20 Jul @ 2:39am
14 Change Notes ( view )

Subscribe to download
Animal Apparel: Framework

Description
Animal Apparel: Framework

This mod serves as a framework to allow animals to wear all kinds of apparel. By itself, this mod only enables animals to be equipped with shield belts and jump packs.

For a selection of plate, flak and cataphract armor for your animals, check out Animal Apparel: Basic Armor.

Features

Designed to be as intuitive and vanilla-friendly as possible: Equip and manage your animals like they were normal colonists. Use 1.6s new "Force equip on"-feature to equip your pets! They're not smart enough to do it on their own.

For modders

In order to make animal apparel using this framework, here's a short primer. For examples, check out Animal Apparel: Basic Armor:

1. Add the "AnimalApparel" tag to your apparel. This will make it equipable by both colonists and tame animals. You're technically done at this point!

2. (Optional, but highly recommended for armor with visuals):
Add def-specific sprites. By default, the framework will look at the wornGraphicPath path of the apparel and append the name of the ThingDef that has it equipped. If your path, for example, is "Things/Pawn/Animal/Apparel/Body/Power" and a Thrumbo equips your armor, it will first look if there is a sprite available at "Things/Pawn/Animal/Apparel/Body/Power/Thrumbo/Thrumbo_[north/east/south].png". If not, it'll default to the actual path you used.

3. (Optional):
Add a "defName{def}" tag to limit which creatures can equip an item, i.e. "defNameElephant" to make it only equippable by elephants. If multiple "defName" requirements are added this way, any of those creatures can use the apparel

4. (Optional):
Add a mod extension like so to your ThingDef
<modExtensions>
<li Class="AnimalGear.AnimalApparelDefExtension">
<showCoverageForBodyType>QuadrupedAnimalWithPaws</showCoverageForBodyType>
</li>
</modExtensions>
This will make it so the info of the apparel will show which bodyparts it covers using the BodyDef you defined there. For example, this will make armor say that it covers back legs, paws and such, rather than referring to normal human body parts. Ideally use a BodyDef that roughly fits for all animals the apparel is intended for.

In order to make animals that are compatible with the framework:

In short, each part of an animal's BodyDef needs to have one of AnimalHead, AnimalBody or AnimalLeg as its group defined. For vanilla bodies, this is done via the patch in Patches/Bodies.xml, so if your animals use a vanilla BodyDef, should be all good. If not, check the "Compatibility" section.

Make sure that the RenderTree for your animal contains the "AnimalApparel" node. If you are using the default "Animal" PawnRenderTreeDef, nothing needs to be done. For anything else, add/patch it in, see Patches/PawnRenderTreeDef.xml

Compatibility

I am expecting this mod to be pretty compatible with almost every mod. If any incompatibilities are found, do let me know!

Modded animals with custom bodies
MOST custom bodies should get patched automatically, no separate patch mods required. Long story short, if the body has a head part with a def that contains "Head" (i.e. "Head" or "InsectHead" or "SnakeHead") and leg parts with a def that contains "Leg", the automatic patching should work!

If you do need to manually patch a body, you should first REMOVE any present "AnimalHead", "AnimalBody" and "AnimalLeg" parts to undo the automatic patching, then re-add them back to where they are supposed to be.

Specific Compatibility
- Big and Small Sapient Animals: Sapient animals can equip all armor designed for their feral counterparts. Sapient Thrumbos in cataphract armor, wielding Miniguns, is highly recommended.
- RPG Style Inventory: Compatible.

Credits and Thanks:

While I couldn't contact the original creator of "Animal Gear", Dylan, much thanks for the specific mention that he doesn't mind someone trying to continue his mod. This mod uses an entirely different, from-scratch implementation of everything, but has the same purpose!

Owlchemist, for letting me use the sprites for his Animal Gear submod, Animal Equipment. They're implemented in Animal Apparel: Basic Armor

FAQ

Combat Extended compatible?

I'll be honest, I have never even touched CE. There is a high chance this mod is compatible out of the box, but please tell me if not. I haven't explicitly tested it, since I have no idea how CE works at all.


1.5 compatibility?

Sorry, no shot there. 1.6 releases very, very soon and this mod uses features explicitly introduced by 1.6, such as the "Force equip to"-functionality


How about adding invisible armor that fits all animals, like the old Animal Gear had?

Maybe as a submod. This mod is not intended to add actual content to the game, other than letting animals equip shield belts, which, honestly, just makes sense.
Popular Discussions View All (1)
2
15 Jul @ 6:13pm
Encountered yellow text error when generating map
水晶哥
36 Comments
caveman 11 hours ago 
how do i put it on the animals
s_m_w  [author] 19 hours ago 
@Big Head Zach
Gave that mopd a quick glance. There's some implementation details (i.e. this framework allows animals to use actual apparel, that mod there simulates apparel it looks like), but ignoring those, if you use this framework with Basic Armors, you get some actual armor graphics for (some) animals. This framework also lets them use shield belts and jump packs.
Big Head Zach 19 hours ago 
Are you able to provide a comparison between this and XeoNovaDan's older-but-maintained Animal Armor mod? https://steamhost.cn/steamcommunity_com/sharedfiles/filedetails/?id=2270547158
Azure 18 Jul @ 5:41am 
That author seems to not update his mod in short term. And last time after he said thing like that he just abandoned the mod. By the way i am talking about draftable animal
s_m_w  [author] 18 Jul @ 12:51am 
@Azure
I'm sure there's a mod that already does it! I want to be careful to not include too many extra features that aren't directly relevant to animal apparel
Azure 17 Jul @ 8:54pm 
Hi are you interested in make animals draftable? Since they have jumppack and shield belt now,it would be great if we could directly control them
s_m_w  [author] 17 Jul @ 1:54pm 
@Dilius
You're right! That mod has its own strategies for making apparel work for an animal. I've written a quick patch so that the two mods work alongside one another. https://steamhost.cn/steamcommunity_com/sharedfiles/filedetails/?id=3528241203
Dilius 17 Jul @ 10:53am 
I have found a incompatibility with kyulens , their kyulen armors cant be equiped on them (wrong body type). Tested with a minumun list, order dont matter.
s_m_w  [author] 17 Jul @ 3:30am 
@水晶哥牌音响
It seems to work if Vanilla Combat Reloaded is before this mod in your load order. I've only tested it briefly however
水晶哥 16 Jul @ 11:57pm 
This mod is not compatible with Vanilla Combat Reloaded