To begin, here is an example what a complete packdefinitions1.xml file might look like:

The above example defines 2 pack definitions.

The new packdefinitions format is an .xml file, which you should be able to open and edit with any text editor. You can include between 0 to 10 packdefinitions files in your plugin. If you have 0, people will not be able to open packs.

Just name the files "packdefinitions1.xml", "packdefinitions2.xml", "packdefinitions3.xml", and so on, and Lackey will discover them. Instead of multiple files, you can put them all into a single file. The option to split them into multiple files is only for your convenience, should you decide to do it that way. These files should be put in your plugins packs/ folder. For the purpose of this tutorial, I will assume the plugin you are creating is called zombie.

Create a text file and save it to plugins/zombie/packs/packdefinitions1.xml

Each pack definitions file must begin with <packdefinitions version="1.0"> and end with </packdefinitions>, and all of the pack definitions should go between them. Each pack definition should similarly begin with <pack> and end with </pack>, and all of that pack's information should go between them.

How to define a pack

Each pack consists of data, which is in between start and stop tags. Some data is optional, some is required for that pack to be valid. Every pack must begin with a pack title, defined like

<packtitle>Funky Booster</packtitle>

Then you can define 4 more optional pack information tags. Here are the 5 pack information definitions, and what they mean.


Next, you can define any number of <packcommoncrit> entries. These are criteria that each item in the pack must fullfil to be included. You don't need to include any <packcommoncrit> entries, because you can include them elsewhere, as I will talk about shortly. A <packcommoncrit> entry might look like:

<packcommoncrit><field>Set</field><eval>IS</eval><data>Alpha</data></packcommoncrit>

<chance></chance>

Next you define <chance> entries. You can have any number of them, and each of them must begin with <chance> and end with </chance>. A chance is used when a pack's structure is random. For example, if your pack consists of 1 rare, 3 uncommons, and 10 commons, but there is a 10% chance that the rare will be replaced by an ultra-rare, you would need to define 2 chances.

<chance>

<prob>90</prob>
Chance criteria goes here (<kind> entries)...

</chance>

<chance>

<prob>10</prob>
Chance criteria goes here (<kind> entries)...

If the structure of your pack is not random, you just need to include 1 chance, and you can omit the probability tag (which is by default 100%). The probability of all of the seperate chances should total to 100%.

<kind></kind>

Each chance consists of several kinds of cards in it. A kind entry contains both the quantity of that kind included in the pack, as well as any number of criteria entries which define what that kind is. A simple kind entry may include a quantity and a single criterion, and look like:

<kind><qty>3</qty><crit><field>Rarity</field><eval>IS</eval><data>U</data></crit></kind>

This <kind> entry says to include 3 cards whose rarity is "U". You can make a criterion for anything, and each kind can have any number of them. Going back to the previous example, if you also want those 3 uncommons to come from a specific set, "alpha" for example, you could define the kind like:

<kind>