phaser-rpg - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #go #golang #machine-learning #deep-learning #linux #docker #nodejs #vue #awesome-list #openai

phaser-rpg

(★ 57)

🕹️ Phaser RPG game template

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
  - release-please.yml
- CODEOWNERS
- dependabot.yml
- mergify.yml
- commit-msg
- pre-commit
- app-icon.png
- favicon.ico
- logo192.png
- logo512.png
- manifest.json
- robots.txt
- bundle.sh
- - index.ts
- - Button.tsx
  - index.ts
  - Overlay.tsx
  - TilemapDebug.tsx
  - Typewriter.tsx
- - depth.ts
  - env.ts
  - index.ts
  - key.ts
  - tilemap.ts
- - Boot.ts
  - index.ts
  - Main.tsx
  - Menu.tsx
- - index.ts
  - Player.ts
- - index.ts
- - vite-env.d.ts
- - analytics.ts
  - index.ts
- index.ts
- style.css
.commitlintrc.json
.env
.gitignore
.lintstagedrc.json
.nvmrc
.prettierrc.json
AGENTS.md
eslint.config.mts
index.html
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
vite.config.mts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img src="public/logo192.png" alt="Phaser RPG">
</p>

# Phaser RPG

[![release](https://img.shields.io/github/v/release/remarkablegames/phaser-rpg)](https://github.com/remarkablegames/phaser-rpg/releases)
[![build](https://github.com/remarkablegames/phaser-rpg/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablegames/phaser-rpg/actions/workflows/build.yml)

<kbd>phaser-rpg</kbd> is a template for making [Phaser](https://phaser.io/) RPG games. The template is inspired by [`phaser-3-tilemap-blog-posts`](https://github.com/mikewesthad/phaser-3-tilemap-blog-posts/tree/master/examples/post-1) (read the [Medium story](https://medium.com/@michaelwesthadley/958fc7e6bbd6)).

Play the game on:

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

## Prerequisites

[nvm](https://github.com/nvm-sh/nvm#installing-and-updating):

```sh
brew install nvm
```

## Install

Clone the repository:

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

Install the dependencies:

```sh
npm install
```

Rename the game:

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

```sh
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:

```sh
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](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](https://itch.io/), [newgrounds](https://www.newgrounds.com/), etc.

## License

[MIT](LICENSE)