Balatro modding modules

This repository contains various files that can be quickly inserted into mod code to enable various features that are too small to warrant their own mods, but complex enough that more than "a few lines" is needed to implement them. All of these files are designed for Steamodded mods.

You may use and modify these files without prior permission for any purpose. Credit is also optional, but appreciated nonetheless. If, however, you are going to use these files without any fundamental modifications (i.e. outside of designated configuration areas), I strongly advise linking back to this repository, if only to point people reading your source code to the documentation present on this repository's wiki.

Current modules

• Cardanim - A card animation system that streamlines per-layer simple sequence definitions, and allows sequence generation from "macros".
  • Developed for Ascensio by Oinite, further developed for general mod usage.
• JTML - An alternate syntax for UIBox definitions that is unambiguous, easier to read, and easier to organize.
  • Developed by Oinite.
• Locsplit - A system that allows for localization files to be split into separate, smaller, and easier to navigate localization files.
  • Developed by Oinite.

Using these files

There are two ways to use these files:

1. Copy and paste the code into your source code (please don't, that's just disorganized)
2. Add the file into your mod folder and load it via SMODS: SMODS.load_file(...)

Please bear in mind that different modules may want to be loaded at different times of mod loading. For example, Cardanim should be loaded after registering Centers, and JTML should be loaded before any written JTML. Information on when to load these files can be found on each file's wiki entries.

FAQ

1. Why not just add these to Steamodded as features via pull requests?
   • To me, most of these features are not really relevant to most modders and thus don't really warrant implementation in Steamodded, which is designed to be general. For example, the current implementation of animations - which involves defining atypical card layers and macros, and allows for highly complex animations (non-linear sequence) - isn't relevant to most modders.
   • also i can't work well with others' code, i don't wanna dig through smods source code
2. Can I add these to Steamodded as features?
   • Sure, go ahead, though I won't guarantee that they'll let the feature in, and I'm not responsible for any issues that arise from the Steamodded derivation. Do let me know about it, though - I'd be curious to see the process!
3. Why not just make these as API mods?
   • As of the making of this repository, there isn't a streamlined method to installing a mod and its dependencies. Making these modules as API mods would lead to dependency bloat on a mod, and require having to handle a bunch of mods just to be able to play one.
4. Why not just package these into a library mod?
   • Again, there's an issue with a lack of streamlined dependency downloading. I don't want to contribute to dependency hell being worsened.
5. I feel like you're overthinking it with the whole dependency issue.
   • Maybe. But I have seen complaints about it, and I do find it to be annoying myself. Until we have a better system for downloading mods and their dependencies, this problem will continue to be in my mind, and even afterwards, I might continue to be mindful of using too many dependencies.
6. Your code sucks!!!!/I have an idea on how to change this...
   • Feel free to make a pull request! Honestly, there's still a lot for me to learn with Lua and Steamodded, so any suggestions for improvements are greatly appreciated.

Adding modules to this repository

If you wish to add a module to the repository, feel free to make a pull request. At minimum, for your pull request to be accepted, you must write documentation of your module. You must also acknowledge that your code will be used by Balatro modders likely without direct credit and/or derived for other purposes.