Custom Game CLI

CLI tool to generate slot game projects with configurable grid sizes.

Quick Start

# Generate game 5x3 (standard)
npx custom-game-cli --name my-slot --grid 5x3

# Generate game 5x4 (extended)
npx custom-game-cli --name big-slot --grid 5x4

# Generate game 3x3 (classic)
npx custom-game-cli --name retro-slot --grid 3x3

# With theme preset
npx custom-game-cli --name ocean-slot --grid 5x3 --theme ocean

# Run the generated game
cd my-slot
npm install
npm run dev

Installation (optional)

# Install globally
npm install -g custom-game-cli

# Then use directly
custom-game-cli --name my-game --grid 5x3

Available Grid Sizes

| Grid | Reels | Rows | Paylines | Type | |------|-------|------|----------|------| | 5x4 | 5 | 4 | 30 | Extended - more rows, higher volatility | | 5x3 | 5 | 3 | 20 | Standard - balanced gameplay | | 3x3 | 3 | 3 | 9 | Classic - simple, fast-paced |

Available Themes

| Theme | Description | |-------|-------------| | ocean | Underwater creatures (seahorse, dolphin, whale) | | egypt | Ancient Egypt (pharaoh, scarab, pyramid) | | space | Space odyssey (rocket, UFO, alien) | | fruit | Classic fruit machine (cherry, lemon, grape) | | irish | Lucky Irish (clover, rainbow, pot of gold) |

Commands

custom-game-cli --name <name> --grid <size>    # Generate project
custom-game-cli --name <name> --theme <theme>  # With theme preset
custom-game-cli --config <path>                # Custom config
custom-game-cli --init-config                  # Generate template config
custom-game-cli --list-grids                   # Show grid details
custom-game-cli --help                         # Show help

Examples

# Standard 5x3 game
npx custom-game-cli --name my-slot --grid 5x3

# Extended 5x4 game with ocean theme
npx custom-game-cli --name ocean-adventure --grid 5x4 --theme ocean

# Classic 3x3 game with fruit theme
npx custom-game-cli --name retro-fruits --grid 3x3 --theme fruit

# Custom config
npx custom-game-cli --name custom-game --config my-config.json

# Generate template config to customize
npx custom-game-cli --init-config

Documentation

• USAGE.md - Detailed usage guide
• CONFIGURATION.md - Config customization guide

Tech Stack

Generated projects use:

• PixiJS v8 - 2D WebGL/WebGPU rendering
• GSAP - Animation library
• TypeScript - Type safety
• Vite - Build tool

How It Works

1. CLI reads grid template config (5x4/5x3/3x3)
2. Copies shared core/ source files to output directory
3. Generates GameConfig.ts based on selected grid + theme
4. Generates Symbol.ts, SpinService.ts, AssetManager.ts per config
5. Output is a complete, runnable game project