https://github.com/remarkablegames/phaser-rpg

🕹️ Phaser RPG game template
https://github.com/remarkablegames/phaser-rpg

game phaser remarkablegames rpg

Last synced: 3 months ago
JSON representation

🕹️ Phaser RPG game template

• Host: GitHub
• URL: https://github.com/remarkablegames/phaser-rpg
• Owner: remarkablegames
• License: mit
• Created: 2022-01-09T19:54:09.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T11:41:29.000Z (3 months ago)
• Last Synced: 2024-10-29T13:27:10.686Z (3 months ago)
• Topics: game, phaser, remarkablegames, rpg
• Language: TypeScript
• Homepage: https://remarkablegames.org/phaser-rpg
• Size: 2.81 MB
• Stars: 10
• Watchers: 0
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# phaser-rpg

phaser-rpg is a template for making [Phaser](https://phaser.io/) RPG games.

Inspired by [`phaser-3-tilemap-blog-posts`](https://github.com/mikewesthad/phaser-3-tilemap-blog-posts/tree/master/examples/post-1) (see [Medium story](https://medium.com/@michaelwesthadley/958fc7e6bbd6)).

Demo:

- [remarkablegames](https://remarkablegames.org/phaser-rpg)

Stack:

- [Phaser](https://phaser.io/)

- [Vite](https://vitejs.dev/)

- [GitHub Pages](https://pages.github.com/)

## Prerequisites

- [nvm](https://github.com/nvm-sh/nvm#readme)

## Install

Clone the repository:

```sh

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

cd phaser-rpg

```

Install the dependencies:

```sh

npm install

```

## Environment Variables

Set the environment variables:

```sh

less .env

```

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](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 packages it into a Zip file in the `dist` folder.

Your game can be uploaded to your server, [Itch.io](https://itch.io/), [Newgrounds](https://www.newgrounds.com/), etc.

## License

[MIT](LICENSE)