Pixitron Engine: the Electron and Pixijs-based cross-platform game engine. A perfect start to cross-platform PC game development.
Clone or download
Latest commit e432bf1 Oct 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
i first awesome commit Apr 19, 2018
lib/gamepad adding gamepad support Apr 20, 2018
.gitignore Add gitignore Oct 17, 2015
LICENSE.md Update LICENSE.md Apr 20, 2018
README.md Adding intro stuff Oct 22, 2018
bunny.png first awesome commit Apr 19, 2018
drawing.js first awesome commit Apr 19, 2018
engine.js Update engine.js Apr 20, 2018
index.html Update index.html Apr 20, 2018
interface.js first awesome commit Apr 19, 2018
main.js first awesome commit Apr 19, 2018
package.json Update package.json Apr 21, 2018
pixi-display.js Update pixi-display.js Apr 20, 2018
pixi.min.js first awesome commit Apr 19, 2018
renderer.js first awesome commit Apr 19, 2018
utilities.js first awesome commit Apr 19, 2018

README.md

pixitron engine

Clone and run for a perfect Electron game project starting place

The Pixitron Game Engine by Lost Astronaut Studios (lostastronaut.com). It's not a game, just a starting place.

This is a minimal boilerplate / starting place for making an Electron-structured PixiJS application based on the Electron Quick Start, combined with some custom Pixijs code and voila!,

Comes with a gamepad console up for testing any game controllers you might have connected, and a keyboard mapping area already configured to easily bind to various special key events. Audio is played through HTML5, but ships with Howler.js if you want something more substantial for audio wrangling

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.

Getting started:

  1. Go through the basic quick start of Electronjs
  2. Get familiar with the Atom.io editor
  3. Clone this and run it
  4. Experiment with native building features of electron-build and related add-ons

Maybe this video will help: https://www.youtube.com/watch?v=Z-oN_YI3KIE

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/pixitron
# Go into the repository
cd pixitron
# 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.

What's in the soup

  • Includes a custom Engine class for structural organization and window setup for quickly starting a fullscreen game app in Electron
  • PixiJS cross-platform game engine for 2D and WebGL games
  • For spatial audio and audio sprites: Howler.js
  • For gamepad support: jsgamepad
  • Great all-inclusive keyboard bindings setup
  • Z-ordering display groups for making 2.5D games

What's not but could be

Resources for learning PixiJS

Resources for Learning Electron

License

It's a mix of MIT and CC0 1.0 (Public Domain) licensing. See all licensing here