Skip to content

tejvirmann/brokemon

Repository files navigation

BROKEMON

Brokémon, an instant hood classic. A standalone Pokemon-style game built with React, TypeScript, and Vite.

Features

  • Overworld exploration with tile-based movement
  • Turn-based battle system
  • Intro sequence with Professor O-G
  • Pixel art graphics
  • Full keyboard controls

Getting Started

Prerequisites

  • Node.js >= 18.0.0
  • npm >= 10.0.0

Installation

npm install

Running Locally

npm start

This will start the Vite dev server, typically at http://localhost:5173

Building for Production

npm run build

The built files will be in the dist directory.

Preview Production Build

npm run preview

Deployment to Vercel

This project is configured for serverless deployment on Vercel:

  1. Push your code to a Git repository (GitHub, GitLab, or Bitbucket)
  2. Import the project in Vercel
  3. Vercel will automatically detect the Vite framework and use the settings from vercel.json
  4. Deploy!

The vercel.json configuration includes:

  • Build command: npm run build
  • Output directory: dist
  • Framework: vite
  • SPA routing support (all routes redirect to index.html)

Game Controls

  • Arrow Keys or WASD: Move player
  • M: Toggle minimap
  • Space or Enter: Interact with NPCs
  • Mouse: Click buttons in battle

Project Structure

brokemon/
├── src/
│   ├── components/
│   │   └── Brokemon/
│   │       ├── assets/          # Game sprites and images
│   │       ├── data/            # Game data (pokemon, maps)
│   │       ├── BattleScene.tsx  # Battle system
│   │       ├── Overworld.tsx    # Overworld exploration
│   │       ├── IntroSequence.tsx # Intro dialog
│   │       └── index.tsx        # Main game component
│   ├── App.tsx                   # Root component
│   ├── main.tsx                  # Entry point
│   └── index.css                 # Global styles
├── index.html
├── package.json
├── vite.config.ts
├── tsconfig.json
└── vercel.json                   # Vercel configuration

Technologies

  • React 18 - UI framework
  • TypeScript - Type safety
  • Vite - Build tool and dev server
  • Tailwind CSS - Styling
  • Canvas API - Game rendering

License

Private project - All rights reserved

About

Brokémon, an instant hood classic.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors