Skip to content

ElectronJS Boilerplate (Quick Start) containing PixiJS v4 and a custom engine stub for getting started with keyboard, WebGL -- all enclosed in a full screen Electron app.

License

Notifications You must be signed in to change notification settings

lostastro/electron-pixi

 
 

Repository files navigation

electron-pixi

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 wrangling
  • drawing.js - Where to put reusable drawing apparatus
  • renderer.js - Came with the Electron Quick Start
  • index.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 Use

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.

Resources for learning PixiJS

Resources for Learning Electron

License

CC0 1.0 (Public Domain) (Note: PixiJS is MIT Licensed seperately but contained in this Electron app starting place)

About

ElectronJS Boilerplate (Quick Start) containing PixiJS v4 and a custom engine stub for getting started with keyboard, WebGL -- all enclosed in a full screen Electron app.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 91.5%
  • HTML 8.5%