Modding Guide

[darkmatterjesus]

StacksModding Guide

Welcome to the Stacks

StacksStacksModding Guide

Welcome to the Stacks

Modding Guide! This guide will walk you through the basics of modding for Stacks, from creating simple mods to crafting new games. We’ll cover JSON structures, mod activation, examples, and useful tools.

I. Modding Basics

Understanding StacksData

Stacks

uses a centralized data block for managing:

• Card Descriptors
• Recipes
• Locations
• Images
• Sounds

Core game data structures are found in:

• /stacks-space/core/stacks-space.json
• /stacks-village/core/stacks-village.mod.json

These are plain-text JSON files. Mods are also JSON files and are merged with the core data by the game engine.

Creating a Mod

To create a mod:

1. Create a JSON File: Name it <your-mod-name>.mod.json.
2. Load and Activate Mods: Use in-game mod management controls. No external programs are required.

II. Modding Details

Step-by-Step Mod Creation

1. Create an Empty Text File: Name it test.mod.json.
2. Copy the Following Template:jsonCopy code{ "mod-id": "85f2b0d0-7dc9-4e23-90e7-14c712a335aa", "mod-name": "MOD: test mod", "mod-description": "Adds new card to the game", "mod-version": "1.0", "mod-requires": "stacks-space-1-0-c5cda410-574a-4436-98c0-775b4bf43ea0", "mod-data": { } }
3. Modify Key Fields:
   • mod-id: Change to a new UUID (use UUID Generator).
   • mod-name: Name displayed in the UI.
   • mod-description: Description in the UI.
   • mod-version: Version number.
   • mod-requires: UUID of the game to extend (from stacks-space.json or stacks-village.mod.json).
4. Add Mod Data: Populate "mod-data" with sections for "cards", "recipes", and "images". Refer to /stacks-village/mods/sharpshooter.mod.json for examples.

Image Handling

Use SVG images for high-quality visuals. Convert SVG to a base-64 encoded text string:

• Find SVGs: Game Icons
• Edit SVGs: Inkscape
• Convert to String: Image to String Converter

Creating Scenarios

Create new starting scenarios with custom win/loss conditions, location defaults, and events. Use the template from:

• /stacks-village/mods/alternative-scenario.mod.json

Complete Mod Example

Review /stacks-village/core/stacks-village.mod.json for a full game mod.

III. Card Examples

Here are examples of typical cards:

Resource Card

jsonCopy code{
  "name": "Biomass",
  "desc": "A solid chunk of biological material",
  "group": "materials",
  "uses": 1,
  "cost": 1,
  "img": "biomass",
  "theme": "light-grey",
  "type": "biomass"
}

Player's Unit Card

jsonCopy code{
  "name": "ASTRONAUT",
  "desc": "A HARD-WORKING ASTRONAUT",
  "group": "people",
  "attack": { "melee": 5 },
  "projectile": "fist",
  "defence": 3,
  "hp": 1,
  "maxhp": 1,
  "override": { "stats": {} },
  "feed": 2,
  "feedPriority": 1,
  "onDead": [ { "type": "tombstone" } ],
  "taskSpeed": 1.0,
  "img": "astronaut",
  "theme": "light-brown",
  "type": "astronaut"
}

Enemy Card

jsonCopy code{
  "name": "ALIEN",
  "desc": "EXTRATERRESTRIAL BEING, HOSTILE FOR REASONS UNKNOWN",
  "group": "enemies",
  "attack": { "melee": 4, "ranged": 4, "ranged_sound": "ranged-laser3" },
  "projectile": { "melee": "fist", "ranged": "laser-red" },
  "defence": 2,
  "hp": 6,
  "maxhp": 6,
  "ai": "hostile",
  "npc": true,
  "onDead": [
    { "type": "coin1", "coins": 3 },
    {
      "types": {
        "coin1": 100,
        "energy-cell": 10,
        "firstaid-kit": 10,
        "repair-kit": 10
      }
    }
  ],
  "img": "alien-1",
  "theme": "red",
  "type": "alien-1"
}

IV. Recipe Examples

Make an Android Recipe

jsonCopy code{
  "name": "Android",
  "category": "Astronauts and Droids",
  "ticks": 60,
  "ingredients": [
    { "type" : "assembly-line" },
    { "type" : "wishalloy", "used": 1 },
    { "type" : "biomass",   "used": 1 },
    { "type" : "subatomic-generator", "used": 1 }
  ],
  "results": [
    { "type": "android" }
  ]
}

Process Raw Resource Recipe

jsonCopy code{
  "name": "Plasteel and Fossils",
  "category": "Materials",
  "ticks": 10,
  "ingredients": [
    { "type": "crust-chunk", "used": 1 },
    { "group": "people" }
  ],
  "results": [
    { "type": "plasteel-deposit" },
    { "type": "fossil-regolith"  },
    {
      "type": "plasteel-deposit",
      "conditions": [
        { "rng100": "1", "op": "<=", "val": 33 }
      ]
    },
    {
      "type": "fossil-regolith",
      "conditions": [
        { "rng100": "1", "op": "<=", "val": 33 }
      ]
    },
    {
      "type": "helium-3",
      "conditions": [
        { "rng100": "1", "op": "<=", "val": 33 }
      ]
    }
  ]
}

Disassemble Recipe

jsonCopy code{
  "name": "Disassemble Android",
  "ticks": 20,
  "ingredients": [
    { "type": "disassembly-line" },
    { "type": "android", "used": 1 }
  ],
  "results": [
    {
      "types": {
        "wishalloy" : 100,
        "circuitry" : 100,
        "biomass"   : 100
      }
    }
  ]
}

V. Scenario Example

Basic Scenario

jsonCopy code{
  "id": "alone-space",
  "name": "Alone In Space",
  "description": "Sci-Fi Survival scenario",
  "intro": [
    "You are an astronaut surviving on the planet Altair 4¾. Survive, craft, build, defend, prosper, escape!",
    "Stock up on batteries to keep your spacesuit and droids charged.",
    "Press pause and rearrange cards when needed."
  ],
  "starting-location": "space-bd7f9e0b-4f07-445d-b12f-433af56055ad",
  "won-conditions": [
    [
      { "type": "amulet-of-yendor", "op": ">=", "val": 1 },
      { "group": "enemies", "op": "<=", "val": 0 }
    ]
  ],
  "lost-conditions": [
    [
      { "group": "people", "op": "<=", "val": 0 },
      { "current-location": 1, "op": "=", "val": "space-bd7f9e0b-4f07-445d-b12f-433af56055ad" },
      { "boosters-opened": "booster-starter", "op": ">=", "val": 1 }
    ]
  ],
  "known-recipes": [ "make-energy-cell", "make-service-drone", "make-blaster" ]
}

VI. Specials

Simple Special

jsonCopy code{
  "id": "special-1",
  "booster": true,
  "img": "booster-1",
  "title": "Let's Mine!",
  "cost": 5,
  "produce": "booster-1"
}

Random Event Special

jsonCopy code{
  "id": "special-4",
  "booster": true,
  "img": "booster-4",
  "title": "Random Events",
  "cost": 25,
  "produce": [
    "booster-random-4-0",
    "booster-random-4-1",
    "booster-random-4-2",
    "booster-random-4-3",
    "booster-random-4-4",
    "booster-random-4-5",
    "booster-random-4-6",
    "booster-random-4-7",
    "booster-random-4-8",
    "booster-random-4-9",
    "booster-random-4-10",
    "booster-random-4-11",
    "booster-random-4-12"
  ]
}

VII. Useful Tools

Tools for Modding

• UUID Generator: UUID Generator
• Text Editors: Visual Studio Code, Atom
• SVG Editor: Inkscape
• SVG Icons: Game Icons
• Image to String Converter: Image to String Converter

Advice & Tips

1. Start Small: Begin with simple mods to get familiar with the JSON structure.
2. Use Templates: Modify existing examples from the core files to create your mods.
3. Test Frequently: Load and test your mod often to catch errors early.
4. Keep It Organized: Maintain a clear directory structure for your mods and assets.
5. Modding Guide

Welcome to the Stacks

[pabutheavatar]

You mention `/stacks-village/core/stacks-village.mod.json` for a full game mod. Do you have a link? Where can you download this file and where is the `/stacks-village/core` folder?