Phaser RPG

phaser-rpg is a template for making Phaser RPG games. The template is inspired by phaser-3-tilemap-blog-posts (read the Medium story).

Play the game on:

• remarkablegames

Prerequisites

nvm:

brew install nvm

Install

Clone the repository:

git clone https://github.com/remarkablegames/phaser-rpg.git
cd phaser-rpg

Install the dependencies:

npm install

Rename the game:

git grep -l phaser-rpg | xargs sed -i '' -e 's/phaser-rpg/my-game/g'

git grep -l 'Phaser RPG' | xargs sed -i '' -e 's/Phaser RPG/My Game/g'

Update the files:

• README.md
• index.html
• package.json
• public/*.png
• public/manifest.json
• src/index.ts

Environment Variables

Update the environment variables:

cp .env .env.local

Update the Secrets in the repository Settings.

Available Scripts

In the project directory, you can run:

npm start

Runs the game in the development mode.

Open http://localhost:5173 to view it in the browser.

The page will reload if you make edits.

You will also see any errors in the console.

npm run build

Builds the game for production to the dist folder.

It correctly bundles in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your game is ready to be deployed!

npm run bundle

Builds the game and compresses the contents into a ZIP archive in the dist folder.

Your game can be uploaded to your server, itch.io, newgrounds, etc.

License

MIT