Clone and run for a quick way to see Electron+Pixijs in action.
This is a minimal Electron-structured PixiJS application based on the Quick Start Guide within the Electron documentation, combined with some custom Pixijs code boilerplate and voila!, the Pixitron Game Engine by Lost Astronaut Studios (lostastronaut.com). It's not a game, just a starting place (blank screen).
Please note we've left the Electron dev console on, because you'll probably need it. Turn it off before you release!
Use this app along with the PixiJS tutorials and the Electron API Demos app for API code examples to help you get started.
This starting place for a Pixitron game is implemented in these files:
package.json
- Points to the app's main file and lists its details and dependencies.main.js
- Starts the app and creates a browser window to render HTML. This is the app's main process.engine.js
- Contains a ready-to-be-extended game engine that hooks "ESC" key to "Quit"interface.js
- Keyboard and mouse wranglingdrawing.js
- Where to put reusable drawing apparatusrenderer.js
- Came with the Electron Quick Startindex.html
- A web page to render. This is the app's renderer process.
You can learn more about each of these components within the Quick Start Guide and by looking into the award-winning PixiJS v4.
To clone and run this repository you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
git clone https://github.com/LAGameStudio/electron-pixi
# Go into the repository
cd electron-pixi
# Install dependencies
npm install
# Run the app
npm start
Note: If you're using Linux Bash for Windows, see this guide or use node
from the command prompt.
- Learning Pixi by Kitty Kat Attack - great place to start
- PixiJS Tutorials from PixiJS.com - more learnin' fun'
- A book on PixiJS - learn by chopping trees! (or get it on a kindle) Learn Pixi.js: Create Great Interactive Graphics for Games and the Web Paperback (Published 5 Nov 2015)
- Pixi.io Shader Filters - Use shaders to spice up your 2D engine
- Many Examples - from PixiJS.com
- Awesome Video and Article - A gentle introduction to shaders with pixi-js
- electronjs.org/docs - all of Electron's documentation
- electronjs.org/community#boilerplates - sample starter apps created by the community
- electron/electron-quick-start - a very basic starter Electron app
- electron/simple-samples - small applications with ideas for taking them further
- electron/electron-api-demos - an Electron app that teaches you how to use Electron
- hokein/electron-sample-apps - small demo apps for the various Electron APIs
CC0 1.0 (Public Domain) (Note: PixiJS is MIT Licensed seperately but contained in this Electron app starting place)