Skip to content
A plugin for the Atom editor that adds autocomplete and other utilities for making Lua based PV8 games.
JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data
lib
styles
.gitignore
LICENSE.md
README.md
package.json

README.md

What is Pixel Vision 8

PV8's core philosophy is to teach retro game development with streamlined workflows. It enables designing games around limited resolutions, colors, sprites, sound and memory. It is ideal for game jams, prototyping ideas or having fun.

While Pixel Vision OS’s built-in text editor is good for simple coding, the ideal way to make PV8 games is with an external code editor. Atom (https://atom.io) is a great, lightweight code editor that works perfectly with Pixel Vision 8 external tool workflow. Before you open your game’s Lua files in Atom, you will want to add a few packages.

Plugin Features

This plugin was designed to add autocomplete and other features for using the Atom Editor with Pixel Vision 8.

  • Auto complete for Pixel Vision 8's Lua APIs.
  • Auto complete for the Pixel Vision OS's UI framework (coming soon)
  • Code templates (coming soon)

Getting Started

The first package to install is Pixel Vision 8’s own API autocomplete. You do this by going to Atom’s settings, then select the install tab. From there type in pixel-vision-8 and search for the package.

Once installed, you will be able to get PV8 code completion in any .lua file you work on in the editor.

Just start typing out the first few letters of an API and the autocomplete drop-down will give you the options to choose from. Each listing has a detailed description of what the API does and offers an autocomplete template allowing you to tab through each of the parameters once you add the code snippet to your project.

Another advantage of installing the PV8 Atom package is that you can keep it up to date with each release. This allows you to have the latest API autocomplete definitions without having to dig through the documentation to see the latest changes.

You will also want to install a good Lua package if you have not done so already. I use language-lua by FireZenk.

Once you have everything set up, you can open any PV8 disk or project folder with Atom. You’ll see the entire file structure of the project and can begin making changes to any of the Lua or JSON files.

image alt text

When you make changes to your code in Atom, simply press CTRL + 4 in Pixel Vision 8 to reload the game.

Credits

Pixel Vision 8 was created by Jesse Freeman (@jessefreeman) in collaboration with Christina-Antoinette Neofotistou (@CastPixel), Pedro Medeiros (@saint11) for art and Christer Kaitila (@McFunkypants) for music. With additional coding contributions by Shawn Rakowski (@shwany).

License

Licensed under the Microsoft Public License (MS-PL) License. See LICENSE file in the project root for full license information.

Pixel Vision 8 is Copyright (c) 2017 Jesse Freeman. All rights reserved.

You can’t perform that action at this time.