https://github.com/arielfr/pixijs-boilerplate
A PixiJS development environment boilerplate
https://github.com/arielfr/pixijs-boilerplate
boilerplate game game-development game-engine gameengine javascript pixi pixijs pixijs-v5
Last synced: 10 days ago
JSON representation
A PixiJS development environment boilerplate
- Host: GitHub
- URL: https://github.com/arielfr/pixijs-boilerplate
- Owner: arielfr
- Created: 2020-04-10T16:53:50.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T16:56:11.000Z (over 2 years ago)
- Last Synced: 2025-02-16T01:43:22.301Z (2 months ago)
- Topics: boilerplate, game, game-development, game-engine, gameengine, javascript, pixi, pixijs, pixijs-v5
- Language: JavaScript
- Homepage: https://arielfr.github.io/pixijs-boilerplate/
- Size: 2.3 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PixiJS Boilerplate
A [PixiJS](https://pixijs.io/) development environment boilerplate (Github Template). With this boilerplate you're going to have an easy to develop environment with feature as hot reloading, minify, etc...
## What's Inside?
This application counts with all you need to start developing your game as fast as an `npm install`. It contains:
* PixiJS (5.1.6)
* Webpack with Dev Server and Hot Reloading
* **Auto Publish** to Github Page (gh-pages) to play your game
* Automatic Minify & Uglify of your code depending on your build type
* Public folder to put all your assets
* SASS Support
## Folder Structure
* src
Main game folder. The `index.js` is the Webpack entry point. In the `styles` you can put all of your styles using `sass`.
* public
In this folder you can put all of your assets that the game needs and is going to be used on `dev-server` and is going to be publish on the `gh-pages`
* templates
This is going to be the `index.html` that `webpack-dev-server` uses to load the game. It is using `EJS` by default
## Installation
Just install the package dependencies using `NPM`:
```
$ npm install
```
## Development
To run the development server you just need execute the next `NPM Script`:
```
$ npm run start
```
## Publish Game
Run the `npm script` call `publish`
```
$ npm run publish
```
This is going to automatically publish your application into your repository `gh-pages`
## Author
Ariel Rey