paul-s-yi / platformer

Home Page:https://platformer-tau.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Occupational Hazard (final title TBD)

⭐ If you like the project or just want to support me, star this on Github - it'll put a smile on my face ( ͡° ͜ʖ ͡°)

platformer-screenshot

Table Of Contents

Introduction

A 2-D platformer built with TypeScript!

This fully free-to-play game (WIP) was built with TypeScript, using Phaser.js and Matter.js as the physics engine. It's available to play right in your browser of choice at https://platformer-tau.vercel.app.

Special thanks to my wife and my friends for being supportive as I work on this fun little project!

The Story (so far)

You're an office worker entering the rat race, and you've got some obstacles to dodge! With spikes and toxic waste in your path, you need to file those reports to get promoted. But that's not all you have to look out for; your coworkers had dreams that died and haunt the place. Make sure your spirits stay high! All that work can get real tiring - replenish your stamina and get a little boost with coffee (don't drink too much!).

Installation

Play in Browser

If you're just looking to try out the game, you can head over to this site and start playing right away!

Developers

To get started, git clone the project by typing the following in your terminal:

git clone https://github.com/paul-s-yi/platformer.git

Don't forget to run npm install or npm i before running npm start to start playing (and developing!)

Controls

Use ←↑→↓ to move, and space to jump. Hit space against a wall to do a double jump.

Planned Features

Gameplay and Visuals

  • Add weapons and additional combat mechanics
  • Add levels, final boss, endless mode (will require programmatic generation of map)
  • Add save files
  • Add audio for character movement and collision (running, jumping, hitting enemy)

Story

  • Add main menu, info in pause screen, add speech bubbles to character and enemies
  • Add intro scene to establish character background

Multiplayer

  • Track high scores, add leaderboard
  • Add player map creation tools and ability to seed player-made maps (this is a real stretch tbh but we'll see where it takes us)
  • Big maybe: add versus modes

Changelog

Click to expand

2023-08-30

Took a little break to focus on work, but I'm back!

  • Updated readme and added changelog (retroactive)
  • Added basic enemy movement logic (looking into more advanced targeting AI)

2023-08-12

  • Added enemy sprites
  • Added health and stamina items and placement
  • Added job titles and advancement logic
  • Added listeners for health and stamina changes upon collisions

2023-08-04

  • Added new fonts (and relevant typings)
  • Added collision logic for hazards

2023-08-03

  • Added tilemap, powerup graphics

License

This game is licensed under the terms of the GPL Open Source license and is available for free.

Credits

Tools and Technologies

Resources and Assets

About

https://platformer-tau.vercel.app

License:GNU General Public License v3.0


Languages

Language:TypeScript 97.1%Language:JavaScript 1.8%Language:HTML 1.0%