Homebrewery User Manual - Catman-232/Homebrewery GitHub Wiki

Homebrewery on Thunderstore

Homebrewery's Logo
"How do I work this?"
Made through sheer force of will by Catman, with internal art content and some parts by Remedy (like that sweet logo up there), and inclusions of parts/items made by Saucy Goblin, Jaytwoster, Zoé, Cowpy, Kiruex and Descen.
(and some totally serious programmer art parts/items by myself!)

Also thanks to all of these cool duders for helping out in some way, shape or form along the way: Marioalexsan, Remedy, DivergentDreams, Saucy Goblin, Nori, Shmaus, Zoé, Jaytwoster, Nyx, Zo¡!, Spicy~, Valerie, Nessie, Captain Baconator, Tea, Lone, TransientGuy, ScottyFox, Rainwolf, Hestia, Poonsplorer, Cowpy, Stone_slab442, Zeina, Rukio, Kiruex, Descen, Rune, Stoingularity.

Table of Contents:

What does this mod even do?

Homebrewery enables you to add new parts to character customisation, and new items for the purpose of cosmetic gear and custom dye colours. The mod comes with a selection of parts and items and will probably gain more things over time. The mod also copies and spreads every race's parts to every other race, so you can use skins, eyes, mouths and hairs from the other races. I did try to make the mod copy all the kind of mesh parts but so far only Hair actually worked, but it is also subject to disjoint jank since the meshes are set at the height to fit the scale of the races they are for. I will try to fix this eventually.

HB has a hotkey to reload existing textures and items, and attempt to import new ones (Ctrl + R), so that if you are in the process of making parts/items, you won't need to restart the game. Reloading items was a tricky implementation so I cannot guarantee it will work flawlessly, and new parts will be added to the end of the game's list, so they will likely be in a different place in the list when you next restart the game.

HB adds an extra dialogue option to Skrit to enable you to acquire custom items, as long as you've spoken to him once before, you'll see the new option. All the items should be free, even the vanilla dyes, which I sneaked into the list as well!

HB enables you to mess with the eyes and mouth states in the character creation, character select and vanity mirror UIs using hotkeys. You can use this to preview what custom eyes and mouth parts look like without having to wonder what action causes the character to use a specific state naturally, I think one of them never gets used anyway.
Control for Mouth:
F - Open

Controls for eyes:
E - Closed
Q - Pissed
R - Hurt
W - Up
S - Down
A - Left
D - Right
(Left and Right end up mirrored when the Mirror Body option is toggled on)

HB forces the vanity mirror UI to think you always have three Illusion Crystals, effectively making it free to use. This is because the nature of the mod will likely cause your character to sometimes look different when you have added or removed custom parts, so I figured it should be free and easy to alter your appearance.

HB adds a custom NPC dialogue you can access via a hotkey (Ctrl + P), it is represented as a mobile phone that you can use for quick shortcuts to your storage and the vanity mirror UIs. Character customisation and storage on the go, never be caught without your wardrobe when you fancy a quick outfit change in a dungeon run!

HB patches the game's blink animation method to make it actually set the eyes to their closed image for a split second rather than just awkwardly squishing them.

How do I get the custom items?

Pay a visit to Skrit, around the back of Sally's shop.
Screenshot of Skrit (Gambler)

When you talk to him (except for the first time) you will see this extra dialogue option.
Skrit's main dialogue, highlighting Homebrewery selection

This opens a new shop screen for you to get unlimited custom items for free!
Homebrewery Shop UI opened
In the dialogue options next to his textbox you should see "next" and "previous" buttons you can now use to go through pages of the shop items rather than the previous bodge implementation of the huge scrolling list that didn't fit the UI at all.

I have also stocked him with the vanilla dyes, for convenience. You'll want one of these in case you uninstall Homebrewery while you are still using a custom dye - proper explanation about that can be found in the dye guide.
Free vanilla dyes in the shop

Caution

DO NOT STORE OR LEAVE MOD ITEMS IN YOUR STORAGE!

The game does not do anything about items it cannot find in its item Dictionary, but seemingly those missing items still exist as junk data which can cause you to lose items when you try to put things into your storage boxes. This can happen if a mod item has its name changed, is removed from your installation, or you uninstall the mod entirely. So PLEASE don't store the mod items, you hardly need to bother when you can get them free, in unlimited quantity at any time from Skrit!

How do I make an item/part?

As of writing this you can make the following things using Homebrewery:

I have created a template item folder for each of the items the mod handles, you can find it in the mod's own HomebreweryFiles folder. Pictured is the manual install. Check the How to Install sections for directions on how to get here, if you don't know!
HomebreweryFiles folder, highlighting the Template folder
Inside the Template folder
I will obviously be working on adding more to the list, and guides for each will be added here when they are implemented!

Here's some custom things I would like to implement in the near to far future:

  • Weapon skins - clone an existing weapon for its stats and alter its physical appearance
  • NPC Texture sets and model swaps as outfits you can ask them to change between
  • Extras for all of the mesh related character parts, hair, ears, tails, horns etc
  • Custom races
  • Custom classes
  • Custom weapon types with their own animations
  • Custom skills with custom animations
⚠️ **GitHub.com Fallback** ⚠️