Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 2.43 KB

README.md

File metadata and controls

47 lines (37 loc) · 2.43 KB
Raw

XPiggy Bank

Welcome!

Using the mod

This is a simple mod for dealing with XP in bulk. It adds a single block, the XPiggy Bank, which is where you can:

  • Store your XP as Liquid Experience or any of the configured compatible fluids
  • Retrieve XP
  • Collect XP Orbs in a radius (if not disabled)
  • Pipe in compatible fluids and auto-convert them
  • Pipe out a compatible fluid

You can store and retrieve your own XP by right-clicking on the XPiggy Bank and then using the buttons to transfer 10, 100, 1000 or all XP.

You can change the XPiggy Bank's fluid type by using the arrows above the tank image on the right. This does not stop you storing or retrieving XP manually, and any supported fluid can still be piped in and automatically converted. This does, however, change the type of fluid that can be piped out of the XPiggy Bank.

Configuring the mod

Mod configuration options include:

  • Compatible fluids, their conversion rates, and whether or not they can be inputs or outputs. This allows things like:
    • only using the single Liquid Experience added by this mod (where 1mB = 1XP)
    • specifying different rates of conversion for "Experience Fluids" added by other mods. For example, CoFH/Thermal's "Essence of Knowledge", Cyclic's "Experience", and Sophisticated Backpack's "Experience" are 20mB = 1XP, so this can be specified for auto conversion at those rates. Similarly, Industrial Foregoing's "Essence" could be configured as 100mB = 1XP (or whatever suits your pack).
    • Allowing some fluids to be input only - for example, your pack might have a mechanic where ether gas can be "traded in" for experience.
    • Allowing some fluids to be output only - for example, your pack might make it an option to export lava in exchange for stored XP.
  • The radius of the XP collection (the default covers a 9x9 area)
  • Change the number ticks between collections (defaults to every 10 ticks, or twice a second)
  • Set the internal tank size. The default is a whopping 20 million mB (20 thousand buckets of Liquid Experience - or about 2125 levels!)
  • Disable/Enable the XP Orb pickup function (defaults to enabled).

The config is found in config/cuboiddroid/xpiggybank/xpiggybank.toml. The settings are all explained in that file, but if you need additional assistance, please don't hesitate to reach out to me on my Discord and I'll see what I can do about helping out.