Getting Started

Welcome to TYPE - the modern TypeScript game engine! This guide will help you get up and running quickly.

DANGER

This is a project under construction and some bugs may occur. Some documentation may not be fully updated. Use at your own risk for development purposes.

Prerequisites

Before you begin, make sure you have the following installed:

• Node.js 22 or higher
• pnpm 10 or higher (recommended package manager)

Installation

1. Clone the Repository

git clone https://github.com/HenriqueArtur/TYPE.git
cd TYPE

2. Install Dependencies

pnpm install

3. Start Development

pnpm dev

This launches both the Electron editor and game runtime in development mode with hot reloading.

Project Structure

Once you have the project running, you'll see this structure:

TYPE/
├── src/
│   ├── __Engine__/              # 🎮 Core Engine
│   │   ├── TypeEngine.ts        # Main coordinator
│   │   ├── Engines/             # Sub-engines
│   │   ├── Systems/             # Game logic systems
│   │   └── Component/           # ECS components
│   ├── __Project__/             # 🎯 Your Game Development Area
│   ├── main/                    # 🔧 Electron main process
│   ├── preload/                 # 🔒 IPC bridge
│   └── renderer/game/           # 🎮 Game runtime
├── docs/                        # 📚 Documentation
└── package.json

Creating Your Game

You should create your game inside the __Project__ folder. This is where you'll place:

• Scene files (.scene.json)
• Blueprint files (.blueprint.json)
• Custom components (.component.js)
• Game assets (images, sounds, etc.)

No additional setup is required - the Electron renderer automatically handles the game execution and setup process for you.

Available Commands

Command	Description
pnpm dev	Start development mode
pnpm build	Build for production
pnpm test	Run test suite
pnpm test:type	TypeScript type checking
pnpm lint	Code linting and formatting
pnpm docs:dev	Start documentation server
pnpm docs:build	Build documentation

Development Workflow

Type follows Test-Driven Development (TDD):

1. Write Tests First: Create .spec.ts files before implementing features
2. Red Phase: Ensure tests fail initially
3. Green Phase: Write minimal code to pass tests
4. Refactor Phase: Improve code while maintaining test coverage

Next Steps

Now that you have TYPE running locally:

1. Explore the Architecture: Learn about the multi-engine design
2. Understanding ECS: Dive into the Entity Component System
3. Create Components: Build your first custom components
4. Write Systems: Implement game logic systems

Need Help?

• 📚 Check the full documentation
• 🐛 Report issues on GitHub
• 💡 Join discussions in the repository

---

Development Environment

The __Project__ directory contains test scenes, entities, and systems that demonstrate engine capabilities. Use these as examples while learning the engine architecture.

TypeScript Strict Mode

Type uses strict TypeScript configuration. Make sure your code follows type safety guidelines - no any types are allowed!