@hmpu/powerups.platformer

A platformer game engine module for Happy Meal Power-Ups, built with TypeScript, PixiJS, Matter.js, and GSAP.

Features

• Performance Optimized: Pixi.js v8 with native culling and render groups
• Physics-based: Platformer logic using Matter.js physics engine
• Modern Rendering: Advanced rendering and animation with PixiJS v8
• Viewport Management: Smooth camera controls with pixi-viewport
• Audio System: Comprehensive sound support via @pixi/sound and Tone.js
• Event System: Modular event system via @hmpu/powerups.services.global-event-listener
• TypeScript: Full TypeScript support with type definitions

Installation

npm install @hmpu/powerups.platformer
# or
pnpm add @hmpu/powerups.platformer
# or
yarn add @hmpu/powerups.platformer

Peer Dependencies

Make sure your project includes the following versions:

• [email protected]
• matter-js@^0.20.0
• pixi-viewport@^6.0.3
• pixi.js@^8.11.0 (updated for v8 performance)
• typescript@>=5.8.3

Usage

Import and initialize the platformer engine in your project:

import { PlatformerEngine } from "@hmpu/powerups.platformer";

const engine = new PlatformerEngine({
  // configuration options
});
engine.start();

Scripts

• pnpm build — Build the TypeScript project
• pnpm publish — Build and publish the package

Development

Install dependencies and build:

pnpm install
pnpm build

API Extractor

• How to Install
• Running the tool

License

Copyright © McDonald's Corporation.