Groggy NPM | npm.io

Groggy CLI

A CLI for managing Groggy game engine assets.

Groggy project structure

A Groggy project is a directory that contains the following files:

/texture-sets/<texture set name>.json
/texture-sets/<texture set name>.png

An example project is available at github.com/cariad/groggy-cli/demo.

Texture sets

A texture set is a pairing of:

A PNG image that contains one or more textures in a grid
A JSON document that describes the embedded textures

An example texture set is available at github.com/cariad/groggy-cli/demo/texture-sets.

The JSON schema is:

{
  "grid": 16, // Width and height of each texture in pixels
  "textures": {
    // The name of each texture and its (x,y) coordinate in textures
    // (not pixels).
    // For example, the "Wall" texture is at the top left:
    "Wall": [0, 0],
    // ...the "WallTop" texture is one texture to the right:
    "WallTop": [1, 0],
    // ...and the "FloorLeft" texture is two textures to the right:
    "FloorLeft": [2, 0]
  }
}

Commands

render-textures

npx groggy render-textures [--project PATH]

The render-textures command renders a project's texture sets to human-readable lookup tables. Each texture set is rendered to a "renders" subdirectory and named <name>.texture-set.png.

For example, the demo texture set renders to:

A lookup table of textures