Home

Welcome to the VallKarri wiki!

For now we're just going to put together a slapdash list of misc info.

How to do cross-mod things

Hand buffs

Option 1, give your enhancement a valk_hand_buff table with the following contents:

valk_hand_buff = {
    title = "string", --Name of your hand buff
    colour = some_colour_table, --You can pull these from G.C like with description text, or use HEX("some hex value") to pick an arbitrary one
    -- scoring_func will be run right during the final scoring step; treat it like a contextless calculate() with all the returns and such
    -- Its only parameter is the buff power; it's usually 1 but increases with extra cards beyond the requirement
    -- It must return a table with at least one item; if your buff doesn't want to do that for some reason give it a dummy item
    scoring_func = function (power)
        return {
            emult = 1.75 + (power*0.25)
        }
    end
},

Option 2 only works if your mod's priority is higher than Vall-Karri's (99999) or you use some other method to run code after other mods are loaded: use the function vallkarri.add_hand_buff(key, title, colour, scoring_func); key is your enhancement's key (with prefixes), and the other stuff is the same.

Planetoids

Vall-Karri automatically generates Unnamed Planetoids for cross-mod hands, but if you want to define your own, there's a Lovely patch target in Items/Consumables/planetoids.lua; the definition format is like so:

{ atlas = "modprefix_atlasname", pos = { x = number, y = number }, hand = "modprefix_handkey", name = "Planetoid Name", dep = { "YourModId" } },