Documentation

Get started with Pixel Vision 8 by reading the extensive online documentation.
This documentation is designed to cover how to work with Pixel Vision 8. Once you have read this documentation, you will be ready start making Pixel Vision 8 games!

Table of Contents

Pixel Vision 8
Introduction
Change Log
Installing The Pro Tools
Credits
Quick Start
Installing Pixel Vision OS
Running PV8
New Projects
Example Lua Game
Exporting Games
Using Pixel Vision OS
Folders
The Workspace
Creating Files
File Actions
The Trash
Mounting Disks
Creating New Disks
Booting From A Disk
Running Games
Configuring Controllers
Settings Tool
Bios
Log Tool
Upgrading
Reinstalling
Screenshots
Image Preview Tool
Image Preview Tool Extras
Recording
Shutting Down
Making Games
Share Libraries
Included Tools
Demo Games
System Templates
API Cheatsheet
Coding With Atom
Rendering To The Display
The Screen
Resolution
Overscan
Clearing The Display
Displaying The Tilemap
Tilemap Cache
Scrolling
Draw Calls
Sprite Limits
Layers
Input
Keyboard Input
Controller Input
Mouse Input
Inside A Game Project
Loading Order
System Data
Chip Properties
Chip Editor Tool
System Chip Templates
Chip Editor Storage
Chip Editor Graphics
Chip Editor Sounds
Locking System Data
System Colors
Importing System Colors
Color Tool
Total System Colors
Color IDs
Adding Colors
Color Mixer
Changing BG Color
Color Mode
Direct Color Mode
Palette Mode
Using Color Offset
Using A Color Map
Manual Palette Mode
Remap Sprite Colors
Palette Pages
Palette Size
Building Palettes
Sprites
Importing Sprites
Sprite Colors
Sprite Memory Pages
Rendering Sprites
LargeSprites
Draw Multiple Sprites
Sprite Tool
Sprite Pages
Drawing Tools
Previewing Sizes
CPS Preview
BG Color Preview
Optimizing Sprites
Fonts
Font Template
Font Characters
Font Tool
Editing Fonts
Creating New Fonts
Tilemaps
Tilemap Tool
Loading Tilemaps
Editing Tilemaps
Exporting Tilemaps
Collision Flags
Editing Collision Flags
Tilemap BG Color
Tile Palettes
Sound Effects
Sound Data
SFX Tool
Preview Sound Effects
Sound Channels
Sound Templates
Customizing Sounds
Waveforms
Samples
Exporting Sounds
Patterns And Songs
Music Data
Music Tool
Preview Songs
Editing Songs
Editing Patterns
Tracker
Adding Notes
Modifying Tracks
Random Music Generator
Configure Music Generator
Exporting Songs
Exporting Games
Runner Templates
Configuring Builds
Building Executables
Building Pixel Vision 8
Runners
Cloning From Github
MonoGame Runners
Pixel Vision 8 Runners
Making C# Games
C# vs Lua
Pixel Vision 8 API
Enums
AddScript
BackgroundColor
Button
CalculateDistance
CalculateIndex
CalculatePosition
Clamp
Clear
Color
ColorsPerSprite
CharacterToPixelData
Display
DrawPixels
DrawRect
DrawSprite
DrawSpriteBlock
DrawSprites
DrawText
DrawTilemap
Flag
InputString
IsChannelPlaying
LoadScript
MaxSpriteCount
MouseButton
MousePosition
NewCanvas
NewPoint
NewRect
PaletteOffset
PauseSong
PlaySong
PlaySound
ReadAllMetadata
ReadMetadata
ReadSaveData
RebuildTilemap
RedrawDisplay
Repeat
ReplaceColor
RewindSong
ScrollPosition
SongData
Sound
SplitLines
Sprite
SpriteSize
StopSong
StopSound
Tile
TilemapSize
TotalColors
TotalSprites
UpdateTiles
WordWrap
WriteSaveData

Join The Club

The Fantasy Console Club is free to join and offers exclusive access to updates, tutorials, and more. By joining, you'll get a free copy of Pixel Vision 8, it's documentation, and a collection of API example tutorials to get you started, which is everything you need to start making 8-bit games.
Become A Memmber Today

Help Support Pixel Vision 8

Pixel Vision 8 is still in development. Currently, it is offered as "early access" and may contain bugs, unexpectedly crash, or have missing features. These early access builds help get feedback, identify bugs, and stress test the tool-chain. Join the dedicated Discord server for support and sharing with the community.
Join The Discord Server