Runn the World is an infinite sidescroller with procedurally-generated levels written in TypeScript. The player can grow the sprite to jump over mountains or shrink them down to enjoy our original pixel art close-up!
Original boilerplate made with ❤︎ by digitsensitive
Framework created by Photonstorm
Phaser is a wonderful, fast and free open source HTML5 game framework. It's used here with Typescript to enhance maintainability and understandability.
Download and install npm with Node.js @ https://nodejs.org/en
Select a folder, navigate to it, and clone this repository with this command-line:
git clone https://github.com/FakeBarenziah/runtheworld.git
Install the dependencies with this command-line:
npm install
Perform a quick build (bundle.js) and start server:
npm run dev
Terrains currently follow a convention of 27 tiles per set and 32x32 pixels per tile. The first 9 tiles are assigned collision properties and represent "underground," or visually below the level the player stands on, and tiles 10-27 are placed on the "surface" level and not assigned collision.
To add new tilesets, place the .png file into /src/boilerplate/assets, and then add the path in a load statement below line 61 of /src/boilerplate/scenes/mainScene.ts in the same way that the other sets are given. Then add the corresponding key into the array on line 53 of that file.
- Phaser 3 Framework
- Phaser 3 Docs with TypeScript Definition File
- Phaser 3 Online Docs
- Phaser 3 Official Examples
- Phaser 3 Discourse
The following Compiler Options have been set in the tsconfig.json file:
| Option | Value |
|---|---|
| target | ES2016 |
| module | CommonJS |
| sourceMap | true |
| noImplicitAny | true [WIP] |
| strict | true [WIP] |
You can see the complete list of the available options at here. Interesting read about setting up a nodejs-project.
Want to correct a bug, contribute some code, or improve the codes? Excellent! Let me know! Please read CONTRIBUTING.md for details on our code of conduct.
This project is licensed under the MIT License - see the LICENSE.md file for details.