Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cxong/peppertown
🧙 RPG-themed idle game
https://github.com/cxong/peppertown
game idle-game javascript phaser pixel-art
Last synced: about 1 month ago
JSON representation
🧙 RPG-themed idle game
- Host: GitHub
- URL: https://github.com/cxong/peppertown
- Owner: cxong
- License: mit
- Created: 2019-02-22T08:05:42.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T23:52:00.000Z (about 1 month ago)
- Last Synced: 2024-11-19T00:39:59.193Z (about 1 month ago)
- Topics: game, idle-game, javascript, phaser, pixel-art
- Language: JavaScript
- Homepage: https://congusbongus.itch.io/peppertown
- Size: 24.2 MB
- Stars: 40
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PepperTown
An RPG-themed idle game, [**Play Online**](https://congusbongus.itch.io/peppertown)
# Licenses
Featuring characters and art from [Pepper&Carrot](https://www.peppercarrot.com) by David Revoy https://creativecommons.org/licenses/by/4.0/
Dialog by [StarNavigator](https://starnavigator.itch.io)
**Code**: based on https://github.com/nkholski/phaser3-es6-webpack
**GFX**:
- [24x32 Pepper&Carrot Characters](https://opengameart.org/content/24x32-peppercarrot-characters) https://creativecommons.org/licenses/by/4.0/
- [Cabbit Collection](https://opengameart.org/node/79804) http://opengameart.org/content/oga-by-30-faq
- [Tiny 16: Basic](https://opengameart.org/content/tiny-16-basic) http://opengameart.org/content/oga-by-30-faq
- [Roguelike/RPG Items](https://opengameart.org/content/roguelikerpg-items) http://creativecommons.org/licenses/by-sa/3.0/
- [16x16 Small and Medium Coin Animation](https://opengameart.org/content/16x16-small-and-medium-coin-animation) http://creativecommons.org/publicdomain/zero/1.0/
- [Slime monster 24x24](https://opengameart.org/content/slime-monster-24x24) https://creativecommons.org/licenses/by/4.0/
- [Golden UI - Bigger Than Ever edition](https://opengameart.org/content/golden-ui-bigger-than-ever-edition) http://creativecommons.org/licenses/by-sa/3.0/
**Music**: [Adorable Ache](https://soundcloud.com/dragor/adorable-ache) by [Dragor](https://soundcloud.com/dragor), http://creativecommons.org/licenses/by-nc-sa/3.0/
**SFX**:
- [JRPG Style UI Sounds](https://opengameart.org/content/jrpg-style-ui-sounds) http://creativecommons.org/licenses/by/3.0/
- [Cash Register](https://freesound.org/people/kiddpark/sounds/201159/) http://creativecommons.org/licenses/by/3.0/
- [Picked Coin Echo](https://opengameart.org/content/picked-coin-echo) http://creativecommons.org/licenses/by/3.0/
- [100 CC0 SFX #2](https://opengameart.org/content/100-cc0-sfx-2) http://creativecommons.org/publicdomain/zero/1.0/
**Font**: [Three Little Bitmap Fonts](https://opengameart.org/content/three-little-bitmap-fonts) by [Buch](https://opengameart.org/users/buch), http://creativecommons.org/publicdomain/zero/1.0/
# Setup
You’ll need to install a few things before you have a working copy of the project.
## 1. Clone this repo
## 2. Install node.js and yarn:
https://nodejs.org/en/
https://yarnpkg.com/
## 3. Install dependencies:
Navigate to the cloned repo’s directory.
Run: ```yarn```
## 4. Run the development server:
Run:
```yarn run dev```
This will run a server so you can run the game in a browser.
Open your browser and enter localhost:3000 into the address bar.
Also this will start a watch process, so you can change the source and the process will recompile and refresh the browser.
## Build for deployment:
Run:
```npm run deploy```
This will optimize and minimize the compiled bundle.