Creating mods for CategoryUnlocker - Neerhom/CM3D2.CategoryUnlocker GitHub Wiki

CatgoryUnlocker and things that it adds

CategoryUnlocker adds expands MPN and SlotID enums, which results new categories and model slots to use in maid edit, enabling for better and more sensible maid customization with less compromises.

List of added MPN's:

  • folder_eye2
  • eye2
  • makeup1
  • makeup2
  • acctatoo2
  • acctatoo3
  • nails
  • toenails
  • skintoon
  • general1
  • general2
  • general3
  • general4
  • general5
  • general6
  • general7
  • ears
  • horns

List of added SlotIDs:

  • nails
  • toenails
  • general1a
  • general1b
  • general2a
  • general2b
  • general3a
  • general3b
  • general4a
  • general4b
  • general5a
  • general5b
  • general6a
  • general6b
  • general7a
  • general7b
  • ears
  • horns

For regular modder, this translates into following table of menu categories and corresponding model slots:

Category Model slot
folder_eye2
eye2
makeup1
makeup2
acctatoo2
acctatoo3
nails nails
toenails toenails
skintoon
general1 general1a , general1b
general2 general2a , general2b
general3 general3a , general3b
general4 general4a , general4b
general5 general5a , general5b
general6 general6a , general6b
general7 general7a , general7b
ears ears
horns horns

Porting Existing items to new categories

Say you're making a maid, and want to give her cat ears and a nice hat. The regular game doesn't allow you to do that, as KISS have put cat ears into hats (acchat) category. Well, you could create copy of ears, and switch it to, say, headset(headset). Which would work, unless you also also want to put a headset onto hear that happens to fit. Then, you search for other category to sacrifice. Go trough such process enough time and you end-up with bunch of duplicates in different categories, which is not only annoying but also impacts performance. Solution? CategoryUnlocker! (duh).

So let's take a look at how one would turn a hat that is technically ears, into proper ears. In this examples I'll simply show how did that with acchat004. It's menu file looks like this:

Entries marked as 1,2,3, 4 are necessary to change. 5 and 6 are optional. 1 is the category in which menu file appears, so it needs to be changed to ears 2 is the model slot into which menu file is adding the model, so this also needs to be changed to ears 3 is the model slot to which the mate file is applied, so this also needs to be changed to ears 4 is internal path for the menu file, which needs to be either unique or unspecified (like assets/menu/), in order so the game won't throw an error at you. 5 is category which is used by SybarisArch editor for sorting menu files. you can either leave it as it is, and have Sybaris show this menu file among hats, or change it to ears so Sybaris won't see it. 6 is a special condition for cat ears, which adds extra dialog when interacting with maid. I'm not sure that this one is relevant, as i don't care for this stuff and not tested how game treats this things, so I'd say either leave as is or delete it, as changing it will most likely make it useless.

So in the end your menu file should look kinda like this:

Save the file, rename it to something unique and check your game:

This process applies for any other menu with the model, except when porting items to General categories, you have two model slots to deal with.

Creating eye2 menus

The process is the same as with regular eye mods: you have your folder category and the menus which actually load the texture, so instead of menu in category folder_eye you create a menu in category folder_eye2, and for color_set you set eye2 instead of eye. For eye menu you simply create an eye2 menu.

Special thin about eye2 del menus is that they are blanks, and only cancel the effect of eye2 menu when the maid is reloaded, i.e. on scene or body change.

Additional tattoos and Makeup

CategoryUnlocker also brings two more more slots designated for body tattoos and 2 Makeup slots that, like lip or hokuro categories, are designated for facial overlays. For makeup1 and makeup2 the process is the same as with creating lip or hokuro mod, expect the category is makeup1 or makeup2. As for the layers, the makeup1 is intended to use layer 3, and makeup2 is for layer 4, as such the included del menus can only remove textures from those layers:

Same deal with Tattoo2 (acctatoo2) and Tatto3 (acctatoo3), with layer 4 and 5 respectively:

Making a SkinToon mod

CategoryUnlocker adds a special category designed for changing toon textures of body and face. Primarily useful if you want to run different toons for different maids, without sacrificing any category that matters. The del menu in this category does nothing in order to keep compatibility with toon mods that are bundled with a skin or nipple menu. An example of toon mod for SkinToon catagory can be found in folder b_toon that is included in the release: