Menthol - A Silly Little Minty-flavored Mod

(This is the main branch; you may want to look at the next branch for in-progress updates.)

My silly little mod that adds some silly little jokers and decks and things. It's minty because it's not vanilla. (It's not vanilla because I think calling a mod a word which in this context means "not modded" is silly. ... Silly in the non-fun way. You know what I mean.)

Mod main page on Modded Balatro Wiki (Beware of SPOILERS! If you even care about discovering things on your own, that is 😛)

Current features:

• Cats
• Cement
• Injokes
• Boosters
• Challenges
• Boss Blinds
• Several decks
• A bunch of jokers
• Cross-mod content
• A silly custom suit
• A little 3, as a treat
• An alternate stake path
• Pencil-tool doodles for art
• Far more ambition than sense

Planned features:

• Mostly just more of the things we've already added, tbqh

Installation Instructions

1. Install Lovely, if you haven't already.
2. Install Steamodded, if you haven't already.
   • This mod was developed on a custom branch off of 1501a; using the actual release shouldn't cause any Menthol-specific issues, other than the stake screen being bad sometimes.
3. Because this is the main branch, you most likely want the latest release.
4. Inside the zip file is the mod code in a folder, Menthol. Put that folder in your Mods folder. The file structure should look like Mods/Menthol/Menthol.json. In particular, there should not be a second Menthol folder nested inside the first one. (You might prefer to remove the version number suffix from the folder name; it doesn't actually matter.)
5. Have a little 3 as a treat! :3

To update to a newer version

1. Download the latest update.
2. Delete all files from your Mods/Menthol folder (or Mods/MintysSillyMod if you're a real OG). (There's no save data in there, so you won't lose any progress.)
3. Unzip all the new files into the now-empty folder. Check again to make sure it's not nested.

Important

Always start a new run after updating any mod. Attempting to continue an in-progress run may result in crashes.

Config Options

• Flavor text: Default true. Enables funky MtG-style quotes at the bottom of Jokers, and also some other cards.
• Include crossover content: Default false. Includes cross-mod content which doesn't actually rely on the other mod's code to function. Not really the intended experience (it'll bias the Joker pool toward 3s a lot), but you might prefer maximum access to things.
• Rename Stone to Slate: Default true. This is really just for me; I'm persnickety, "stone" isn't a well-defined Thing, but slate is a real rock that resembles your video game standard grey ahh chunk of generic. Turn this off if you're persnickety in an incompatible way where seeing it have a different name than vanilla would bug you.
• Ticking cards: Certain cards tick. Click this button to turn that off if it annoys you. Inherits default value from your reduced motion option. Er, the opposite of it, I guess (reduced motion = no ticking cards)
• 3 lock: Whether the 3 suit and related content can appear in a run; "Unlocked" means it's available from the start, "Locked" means it requires using The Cat tarot or playing a Spectrum hand¹, "Sealed" means it never appears unless a deck specifically enables it. Default "Locked".
• Disable bad jokes: Some items are just me being kind of salty, and they don't make much long-term game sense as a result. Click this when the joke gets old and you don't want to see it anymore. Default false.
• Dev Mode: Reveals some stuff that isn't 100%. Maybe you can fiddle with it and see how to fix whatever it was disabled for. Also forces crossover content on. Default false on release versions, true on dev commits.
  • Suppress trace messages: Default false; stops TRACE-level console messages even if Dev Mode is on.

Recommended additional mods:

If you're trying out Menthol for the first time and want minimal other mods, go with Amulet (unless you don't care about ^Mult as a concept), Challenger Deep (unless you don't care about challenges as a concept) and Spectrum Framework (unless you don't care about the Spectrum hand as a concept). The rest of the list is for after that.

Technical

• Challenger Deep is required for some challenges in Menthol.
• Spectrum Framework enables five-suit poker hands, which are a fun little thing to play with.
• Amulet enables scores above e308 and also ^mult, which is just fun imo.

Cross-mod content

Menthol adds content for all of the following mods. Those with ⭐️ are also recommended for just, like, a basic default content mod set. in my imo.

• Aikoyori's Shenanigans
• CardPronouns
• Card Sleeves ⭐️
• Cryptid
• Drafting ⭐️
• Finity
• Fusion Jokers ⭐️
• Gemstones
• More Fluff ⭐️

• Paperback ⭐️
• TOGA's Stuff

The following mods add content for Menthol and we haven't returned the favor (yet):

• Prism ⭐️
• Random's Partners (requires Partner)

Other content mods

Menthol doesn't add anything for these yet, but we might in future. Until then, we're just recommending them because we like them. Consider anything on this list ⭐️'d.

• KCVanilla is just a couple of Jokers but I like them a lot. and it was the first mod I found that organized its files so I'm giving it a shoutout for that reason (I figured out how to organize my files by looking at its code)
• Rift-Raft lets you send cards to the Void and then later you can get them back as negative from Void Packs, it's fun

Quality of life

Technically you can do whatever you want here, but here's the mods I like for the purpose:

• Galdur revamps the New Run screen to make deck and sleeve selection much easier.
• Glue for Modpacks lets you adjust the shop so having a lot of mods doesn't drown everything out.
• Handy adds a whole lot of things but tbh the only one I care about is selecting multiple playing cards by dragging across them.
• Item Remover lets you disable specific items from the Collection, if they're OP or bugged or you just don't like them. (Banner does the same thing and is newer, switch if one of them isn't doing what you want it to.)
• re:Unlock All lets you push the Unlock All button again if you switch mods and there's more to unlock.

Adding cross-mod interactions

• 3 suit: If you want things to interact with the 3s mechanic, use Card:is_3() for proper detection. It returns the number of times the card counts as a 3, or false if it doesn't, because 0 is truthy in Lua...
• Face rank: If your modded suit includes Face art, give it minty_facerank = true to stop it from using the fallback art. Uh... I don't know how to properly implement cross-mod suit-rank combo art. I'll ask Kirbio UnStable, maybe. (Where by "ask" I mean "look in his published code".)
• Legendary Kitys: Give your kittycats pools = {["kity"] = true} to enable them to be summoned by The Wand and The Bitz and to grant chips with Cat Cafe.
• Gym Buddy boosts: Give your enhancements a config.extra.gymboost of "chips", "xchips", "mult", "xmult", "cash", "hchips", "hxchips", "hmult", "hxmult", "hcash" or "none" to have them grant the corresponding boost when scored with cards not of that enhancement. (If you don't, one will be chosen randomly each time. Which maybe you prefer!)
• The Silliest, Littlest Deck: Add pools = {["Menthol"] = true} to have your cross-mod content appear with increased frequency when this deck is in play.
• Rocks: Add minty_rock = true to your enhancement definition to have it count as a rock. If this fails for priority reasons (which I don't think should be possible, but you never know) there's a Lovely patch target in lib/functions.lua.

Contributing

• Yes, feel free to contribute if you have a contribution!
• If you find a bug or plausibly-different-than-intended behavior, you can file an issue (please test thoroughly to confirm the exact conditions that do and don't cause the problem - you may find DebugPlus to be helpful with this)
• If you have a code contribution you can do a pull request
• If you have an art contribution... you can also do a pull request but if atlases make that too much a pain you can just send the art via one of the methods below:

Contacting me (Minty wingedcatgirl)

• Mod thread on the Balatro Discord is the most obvious choice for mod-related communication.
• There's also my Discord server or well, one of them, i start so many things and never follow through lol
• Does GitHub have messaging? It has Discussions, that'll have to do.
• Most reliable will be Dreamwidth. I'm not super active there, but I can assure you it's not going away.
• I'm most active on tumblr, though I don't trust the CEO of that site not to burn it all down without notice.

---

Footnotes

1. Only if Spectrum Framework is active. Yes, there are other mods that add the Spectrum hand, but what's the point of having a framework if every mod has to account for every other mod. you know. If you're running those mods, add Spectrum Framework. Let it account for every other mod. ↩