prototype-01

A 2D platformer prototype built using Phaser, TypeScript, Electron, and Vite. The project serves as a foundation for developing platformer games with smooth physics, animations, and desktop integration.

1. Technologies Used

1.1 Core Technologies

• Phaser 3 – Game engine for 2D games
• TypeScript – Type-safe JavaScript for better maintainability
• Electron – Desktop application framework
• Vite – Fast development and build tool

1.2 Key Features

• Platformer mechanics: movement and jumping
• Sprite animations with frame-based rendering
• Physics-based interactions using Phaser's arcade physics
• Desktop & Web support with Electron and Vite
• Game scenes management using Phaser's Scene API
• Optimized FPS control with a custom FPSScene class

2. Project Structure

/src
  ├── assets/             # Game assets (sprites, audio, etc.)
  ├── config/             # Configurations (Electron, FPS settings)
  ├── constants/          # Game-related constants
  ├── entities/           # Game objects (Player, Platforms)
  ├── scenes/             # Game scenes (Main scene, FPS controller)
  ├── main.ts             # Game entry point
  ├── game.ts             # Phaser game setup
  ├── electron/           # Electron configuration

3. Development

3.1 Install Dependencies

Using Yarn (recommended):

yarn install

Or using npm:

npm install

3.2 Start the web version (browser)

yarn start:dev:web

Runs the game in a browser using Vite.

3.3 Start the desktop version (Electron)

yarn start:dev:desktop

Runs the game as a desktop app with Electron.

4. Build & Distribution

4.1 Build for Web

yarn build:prod:web

Compiles TypeScript and builds the web version.

4.2 Build for Windows (Electron)

yarn build:prod:windows

Generates a .exe file for Windows.

5. Future Improvements

Enhancements will be introduced in future prototypes based on this one. Check out the next iteration:

• prototype-02

6. LicenseF

This project is licensed under the MIT License.