@iruka-edu/create-iruka-game

The official scaffolding tool for building Iruka Mini Games. Quickly set up a new project with pre-configured templates for Phaser and React.

Quick Start

You don't need to install this package globally. Simply run it using npx:

npx @iruka-edu/create-iruka-game

Follow the interactive prompts to:

1. Enter your project name.
2. Choose a template (e.g., React + Phaser).
3. Provide your GitHub Personal Access Token (for downloading private SDK core packages).

Features

• 🚀 Fast Scaffolding: Set up a production-ready game project in seconds.
• 🎨 Modern Templates:
  • React + Phaser (Recommended): A powerful combination for building complex game UIs with React and high-performance game logic with Phaser.
  • Basic Phaser: A lightweight starting point for pure Phaser development.
• 🛠️ Integrated SDK: Automatically configures the project to use @iruka-edu/mini-game-sdk.
• 🔐 Secure Configuration: Helps you set up .npmrc to access private Iruka packages securely.

What's Included

Each scaffolded project comes with:

• A pre-configured vite.config.ts for fast development and optimized builds.
• Built-in TypeScript support.
• Iruka SDK integration for features like Leaderboards, User Auth, and Analytics.
• A basic game scene to get you started.

Development

If you want to contribute to the CLI itself:

# Clone the monorepo
git clone https://github.com/iruka-edu/iruka-mini-game-sdk.git

# Install dependencies
pnpm install

# Build the CLI
cd packages/create-iruka-game
pnpm build

License

MIT © Iruka Edu