Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.54 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.54 KB

Jazz Jackrabbit Endless Runner

An endless runner game inspired by the classic Jazz Jackrabbit, featuring original assets, music, and sound effects from the original game, built with modern technologies.

📜 Project Description

This project is a nostalgic endless platformer game that brings back the classic Jazz Jackrabbit vibe. Players control Jazz as he collects diamonds and defeats enemies, aiming to cover the greatest distance possible while scoring the highest points.

🚀 Technologies

The project is built with the following technologies:

  • Kaplay: A game engine enabling real-time rendering and animations.
  • Vite: A fast and lightweight development server and build tool for TypeScript-based development.
  • TypeScript: A type-safe superset of JavaScript, providing structured and maintainable code.
📦 Installation and Running

This project requires Node.js to run.

  1. Clone the repository:

    git clone <repo-url>
    cd jazz-jackrabbit
  2. Install the required packages:

    npm install
  3. Start in development mode:

    npm run dev
  4. To access it on a local network:

    npm run host
  5. Build for production:

    npm run build
  6. Preview the build:

    npm run preview
📚 Structure
  • src/: Contains all source code, including game logic in TypeScript.
  • public/: Contains the original Jazz Jackrabbit assets (graphics, sounds, music).
  • vite.config.ts: Configuration for Vite.