pi

README

pi

The retro game development engine for Go, inspired by Pico-8 and powered by Ebitengine.

FAQ

Is this a new fantasy console?

No, it's not. It's rather a game development library with dev-tools which make it simple (and fun!) to write retro games in Go.

What is a retro game?

It's a game that resembles old 8-bit/16-bit games. This usually means:

• (extremely) Low resolution (like 128x128 pixels)
• Limited number of colors (like 16)
• Very small number of assets (like 256 sprites, map having up to 8K tiles)
• Small number lines of code (thousands rather than millions)
• Sound effects and music made using predefined synth instruments and effects

What similarities does Pi have with Pico-8?

• Most API function names are similar and behave the same way.
• Screen resolution is small, and the number of colors is limited. Although in Pi you can change the resolution and palette.
• You have one small sprite sheet.

Why would I use it?

Because it's the easiest way to write a game in Go. IMHO ;)

Is Pi ready to use?

Pi is under development. Only limited functionality is provided. API is not stable. See ROADMAP for details.

How to get started?

1. Install dependencies
   • Go 1.18+
   • If not on Windows, please install additional dependencies for Linux or macOS.
2. Try examples from examples directory.
3. Create a new game using provided Github template.
4. Read the documentation.

Documentation

Overview

Package pi provides API to develop retro games.

Please note that the entire pi package is not concurrency-safe. This means that it is unsafe to run functions and access package variables from go-routines started by your code.

Index

• Constants
• Variables
• func Atan2(dx, dy float64) float64
• func Btn(button Button) bool
• func BtnBits() int
• func BtnPlayer(button Button, player int) bool
• func Btnp(button Button) bool
• func BtnpBits() int
• func BtnpPlayer(button Button, player int) bool
• func Camera(x, y int) (prevX, prevY int)
• func CameraReset() (prevX, prevY int)
• func Circ(centerX, centerY, radius int, color byte)
• func CircFill(centerX, centerY, radius int, color byte)
• func Clip(x, y, w, h int) (prevX, prevY, prevW, prevH int)
• func ClipReset() (prevX, prevY, prevW, prevH int)
• func Cls()
• func ClsCol(col byte)
• func Cos(angle float64) float64
• func Line(x0, y0, x1, y1 int, color byte)
• func Load(resources fs.ReadFileFS)
• func MaxInt[T Int](x, y T) T
• func Mid(x, y, z float64) float64
• func MidInt[T Int](x, y, z T) T
• func MinInt[T Int](x, y T) T
• func MouseBtn(b MouseButton) bool
• func MouseBtnp(b MouseButton) bool
• func MousePos() (x, y int)
• func Pal(color byte, replacementColor byte)
• func PalDisplay(color byte, replacementColor byte)
• func PalReset()
• func Palt(color byte, transparent bool)
• func PaltReset()
• func Pget(x, y int) byte
• func Print(text string, x, y int, color byte) (rightMostX int)
• func Pset(x, y int, color byte)
• func Rect(x0, y0, x1, y1 int, color byte)
• func RectFill(x0, y0, x1, y1 int, color byte)
• func Reset()
• func SetCustomFontHeight(height int)
• func SetCustomFontSpecialWidth(w int)
• func SetCustomFontWidth(w int)
• func SetScreenSize(width, height int)
• func Sget(x, y int) byte
• func Sin(angle float64) float64
• func Spr(n, x, y int)
• func SprSize(n, x, y int, w, h float64)
• func SprSizeFlip(n, x, y int, w, h float64, flipX, flipY bool)
• func Sset(x, y int, color byte)
• func Stop()
• func Time() float64
• func UseEmptySpriteSheet(w, h int)
• type Button
• type Controller
• type Font
  • func CustomFont() Font
  • func SystemFont() Font
  • func (f Font) Print(text string, x, y int, color byte) int
• type Int
• type MouseButton
• type PixMap
  • func NewPixMap(width, height int) PixMap
  • func NewPixMapWithPixels(pixels []byte, lineWidth int) PixMap
  • func Scr() PixMap
  • func SprSheet() PixMap
  • func (p PixMap) Circ(centerX int, centerY int, radius int, color byte)
  • func (p PixMap) CircFill(centerX int, centerY int, radius int, color byte)
  • func (p PixMap) Clear()
  • func (p PixMap) ClearCol(col byte)
  • func (p PixMap) Clip() Region
  • func (p PixMap) Copy(x, y, w, h int, dst PixMap, dstX, dstY int)
  • func (p PixMap) Foreach(x, y, w, h int, update func(x, y int, dst []byte))
  • func (p PixMap) Get(x, y int) byte
  • func (p PixMap) Height() int
  • func (p PixMap) Line(x0, y0, x1, y1 int, color byte)
  • func (p PixMap) Merge(x, y, w, h int, dst PixMap, dstX, dstY int, merge func(dst, src []byte))
  • func (p PixMap) Pix() []byte
  • func (p PixMap) Pointer(x, y, w, h int) (ptr Pointer, ok bool)
  • func (p PixMap) Rect(x0, y0, x1, y1 int, col byte)
  • func (p PixMap) RectFill(x0 int, y0 int, x1 int, y1 int, col byte)
  • func (p PixMap) Set(x, y int, col byte)
  • func (p PixMap) Width() int
  • func (p PixMap) WithClip(x, y, w, h int) PixMap
• type Pointer
• type Position
• type Region

Constants

const (
	Left  = 0
	Right = 1
	Up    = 2
	Down  = 3
	O     = 4 // O is a first fire button
	X     = 5 // X is a second fire button
)

Keyboard mappings:

player 0: [DPAD] - cursors  [O] - Z C N   [X] - X V M
player 1: [DPAD] - SFED     [O] - LSHIFT  [X] - TAB W Q A

First connected gamepad controller is player 0, second player 1 and so on. On XBox controller O is A and Y, X is B and X.

const (
	MouseLeft   = 0
	MouseMiddle = 1
	MouseRight  = 2
)

const (
	SpriteWidth, SpriteHeight = 8, 8
)

Variables

var (
	// Update is a user provided function executed each frame (30 times per second).
	//
	// The purpose of this function is to handle user input, perform calculations, update
	// game state etc. Typically, this function does not draw on screen.
	Update func()

	// Draw is a user provided function executed at most each frame (up to 30 times per second).
	// π may skip calling this function if previous frame took too long.
	//
	// The purpose of this function is to draw on screen.
	Draw func()

	// Palette has all colors available in the game. Up to 256.
	// Palette is taken from loaded sprite sheet (which must be
	// a PNG file with indexed color mode). If sprite-sheet.png was not
	// found, then default 16 color palette is used.
	//
	// Can be freely read and updated. Changes will be visible immediately.
	Palette = defaultPalette
)

User parameters.

var (
	// DrawPalette contains mapping of colors used to replace color with
	// another one for all subsequent drawings.
	//
	// The index of array is original color, the value is color replacement.
	DrawPalette [256]byte

	// DisplayPalette contains mapping of colors used to replace color with
	// another one for the entire screen, at the end of a frame
	//
	// The index of array is original color, the value is color replacement.
	DisplayPalette [256]byte

	// ColorTransparency contains information whether given color is transparent.
	//
	// The index of array is a color number.
	ColorTransparency = defaultTransparency

	// TimeSeconds is the number of seconds since game was started
	TimeSeconds float64

	GameLoopStopped bool
)

var Controllers [8]Controller // 0th element is for Player 0, 1st for Player 1 etc.

Functions

func Atan2

func Atan2(dx, dy float64) float64

Atan2 converts DX, DY into an angle from 0..1

Similar to Cos and Sin, angle is taken to run anticlockwise in screenspace. For example:

atan(0,-1)  // returns 0.25

func Btn

func Btn(button Button) bool

Btn returns true if a controller button is being pressed at this moment by player 0.

func BtnBits

func BtnBits() int

BtnBits returns the state of all controller buttons for players 0 and 1 as bitset.

The first byte contains the button states for player 0 (bits 0 through 5, bits 6 and 7 are unused). The second byte contains the button states for player 1 (bits 8 through 13).

Bit 0 is Left, 1 is Right, bit 5 is the X button.

A bit of 1 means the button is pressed.

func BtnPlayer

func BtnPlayer(button Button, player int) bool

BtnPlayer returns true if a controller button is being pressed at this moment by specific player. The player can be 0..7.

func Btnp

func Btnp(button Button) bool

Btnp returns true when the controller button has just been pressed. It also returns true after the next 15 frames, and then every 4 frames. This simulates keyboard-like repeating.

func BtnpBits

func BtnpBits() int

BtnpBits returns the state of all controller buttons for players 0 and 1 as bitset.

The first byte contains the button states for player 0 (bits 0 through 5, bits 6 and 7 are unused). The second byte contains the button states for player 1 (bits 8 through 13).

Bit 0 is Left, 1 is Right, bit 5 is the X button.

A bit of 1 means the button has just been pressed.

func BtnpPlayer

func BtnpPlayer(button Button, player int) bool

BtnpPlayer returns true when the controller button has just been pressed. It also returns true after the next 15 frames, and then every 4 frames. This simulates keyboard-like repeating. The player can be 0..7.

func Camera

func Camera(x, y int) (prevX, prevY int)

Camera sets the camera offset used for all subsequent draw operations.

func CameraReset

func CameraReset() (prevX, prevY int)

CameraReset resets the camera offset to origin (0,0).

func Circ

func Circ(centerX, centerY, radius int, color byte)

Circ draws a circle on screen.

Circ takes into account camera position, clipping region and draw palette.

func CircFill

func CircFill(centerX, centerY, radius int, color byte)

CircFill draws a filled circle

CircFill takes into account camera position, clipping region and draw palette.

func Clip

func Clip(x, y, w, h int) (prevX, prevY, prevW, prevH int)

Clip sets the clipping region in the form of rectangle. All screen drawing operations will not affect any pixels outside the region.

Clip returns previous clipping region.

func ClipReset

func ClipReset() (prevX, prevY, prevW, prevH int)

ClipReset resets the clipping region, which means that entire screen will be clipped.

func Cls

func Cls()

Cls cleans the entire screen with color 0. It does not take into account any global state such as clipping region or camera. Cls also resets clipping region.

func ClsCol

func ClsCol(col byte)

ClsCol cleans the entire screen with specified color. It does not take into account any global state such as clipping region or camera. ClsCol also resets clipping region.

func Cos

func Cos(angle float64) float64

Cos returns the cosine of angle which is in the range of 0.0-1.0 measured clockwise.

If you want to use conventional radian-based function use math.Cos.

func Line

func Line(x0, y0, x1, y1 int, color byte)

Line draws a line on screen between points x0,y0 and x1,y1 (inclusive).

Line takes into account camera position, clipping region and draw palette.

func Load

func Load(resources fs.ReadFileFS)

Load loads files like sprite-sheet.png, custom-font.png

func MaxInt

func MaxInt[T Int](x, y T) T

MaxInt returns maximum of two integer numbers.

func Mid

func Mid(x, y, z float64) float64

Mid returns the middle of three float64 numbers. Very useful for clamping. NaNs are always put at the beginning (are the smallest ones).

func MidInt

func MidInt[T Int](x, y, z T) T

MidInt returns the middle of three integer numbers. Very useful for clamping.

func MinInt

func MinInt[T Int](x, y T) T

MinInt returns minimum of two integer numbers.

func MouseBtn

func MouseBtn(b MouseButton) bool

MouseBtn returns true if the mouse button is being pressed at this moment.

func MouseBtnp

func MouseBtnp(b MouseButton) bool

MouseBtnp returns true when the mouse button has just been pressed. It also returns true after the next 15 frames, and then every 4 frames. This simulates keyboard-like repeating.

func MousePos

func MousePos() (x, y int)

MousePos returns the position of mouse in screen coordinates.

func Pal

func Pal(color byte, replacementColor byte)

Pal replaces color with another one for all subsequent drawings (it is changing the so-called draw palette).

Affected functions are Pset, Spr, SprSize, SprSizeFlip, Rect and RectFill.

func PalDisplay

func PalDisplay(color byte, replacementColor byte)

PalDisplay replaces color with another one for the whole screen at the end of a frame (it is changing the so-called display palette).

func PalReset

func PalReset()

PalReset resets all swapped colors for all palettes.

func Palt

func Palt(color byte, transparent bool)

Palt sets color transparency. If true then the color will not be drawn for next drawing operations.

Color transparency is used by Spr, SprSize and SprSizeFlip.

func PaltReset

func PaltReset()

PaltReset sets all transparent colors to false and makes color 0 transparent.

func Pget

func Pget(x, y int) byte

Pget gets a pixel color on the screen.

func Print

func Print(text string, x, y int, color byte) (rightMostX int)

Print prints text on the screen using system font. It takes into consideration clipping region and camera position.

Only unicode characters with code < 256 are supported. Unsupported chars are printed as question mark. The entire table of available chars can be found here: https://github.com/elgopher/pi/blob/master/internal/system-font.png

Print returns the right-most x position that occurred while printing.

func Pset

func Pset(x, y int, color byte)

Pset sets a pixel color on the screen. It takes into account camera and draw palette.

func Rect

func Rect(x0, y0, x1, y1 int, color byte)

Rect draws a rectangle on screen between points x0,y0 and x1,y1 (inclusive).

Rect takes into account camera position, clipping region and draw palette.

func RectFill

func RectFill(x0, y0, x1, y1 int, color byte)

RectFill draws a filled rectangle on screen between points x0,y0 and x1,y1 (inclusive).

RectFill takes into account camera position, clipping region and draw palette.

func Reset

func Reset()

func SetCustomFontHeight

func SetCustomFontHeight(height int)

func SetCustomFontSpecialWidth

func SetCustomFontSpecialWidth(w int)

func SetCustomFontWidth

func SetCustomFontWidth(w int)

func SetScreenSize

func SetScreenSize(width, height int)

SetScreenSize sets the screen size to specified resolution. The maximum number of pixels is 65536 (64KB). Will panic if screen size is too big or width/height are <= 0.

func Sget

func Sget(x, y int) byte

Sget gets the pixel color on the sprite sheet.

func Sin

func Sin(angle float64) float64

Sin returns the sine of angle which is in the range of 0.0-1.0 measured clockwise.

Sin returns an inverted result to suit screen space (where Y means "DOWN", as opposed to mathematical diagrams where Y typically means "UP"):

sin(0.25) // returns -1

If you want to use conventional radian-based function without the y inversion, use math.Sin.

func Spr

func Spr(n, x, y int)

Spr draws a sprite with specified number on the screen. Sprites are counted from left to right, top to bottom. Sprite 0 is on top-left corner, sprite 1 is to the right and so on.

func SprSize

func SprSize(n, x, y int, w, h float64)

SprSize draws a range of sprites on the screen.

n is a sprite number in the top-left corner.

Non-integer w or h may be used to draw partial sprites.

func SprSizeFlip

func SprSizeFlip(n, x, y int, w, h float64, flipX, flipY bool)

SprSizeFlip draws a range of sprites on the screen.

If flipX is true then sprite is flipped horizontally. If flipY is true then sprite is flipped vertically.

func Sset

func Sset(x, y int, color byte)

Sset sets the pixel color on the sprite sheet.

func Stop

func Stop()

Stop will stop the game loop after Update or Draw is finished. If you are using devtools, the game will be paused. Otherwise, the game will be closed.

func Time

func Time() float64

Time returns the amount of time since game was run, as a (fractional) number of seconds.

Calling Time() multiple times in the same frame will always return the same result.

func UseEmptySpriteSheet

func UseEmptySpriteSheet(w, h int)

UseEmptySpriteSheet initializes empty sprite-sheet with given size. Could be used when you don't have sprite-sheet.png in resources.

Types

type Button

type Button int

Button is a virtual button on any game controller. The game controller can be a gamepad or a keyboard.

Button is used by Btn, Btnp, BtnPlayer, BtnpPlayer, BtnBits and BtnpBits.

type Controller

type Controller struct {
	// BtnDuration is how many frames button was pressed:
	// Index of array is equal to controller button constant.
	BtnDuration [6]uint
}

type Font

type Font struct {
	// Data contains all 256 characters sorted by their ascii-like number.
	// Each character is 8 subsequent bytes, starting from the top.
	// Left-most pixel in a line is bit 0. Right-most pixel in a line is bit 7.
	//
	// The size of slice is always 8 * 256 = 2048.
	//
	// Can be freely read and updated. Changes will be visible immediately.
	Data []byte
	// Width in pixels for all characters below 128. For Width > 8 only 8 pixels are drawn.
	Width int
	// SpecialWidth is a with of all special characters (code>=128)
	// For SpecialWidth > 8 only 8 pixels are drawn.
	SpecialWidth int
	// Height of line
	Height int
}

Font contains all information about loaded font and provides method to Print the text.

func CustomFont

func CustomFont() Font

func SystemFont

func SystemFont() Font

func (Font) Print

func (f Font) Print(text string, x, y int, color byte) int

Print prints text on the screen at given coordinates. It takes into account clipping region and camera position.

Only unicode characters with code < 256 are supported. Unsupported chars are printed as question mark. The entire table of available chars can be found here: https://github.com/elgopher/pi/blob/master/internal/system-font.png

Print returns the right-most x position that occurred while printing.

type Int

type Int interface {
	~int | ~int8 | ~int16 | ~int32 | ~int64 | ~uint | ~uint8 | ~uint16 | ~uint32 | ~uint64 | ~uintptr
}

Int is a generic type for all integer types

type MouseButton

type MouseButton int

type PixMap

type PixMap struct {
	// contains filtered or unexported fields
}

PixMap is a generic data structure for manipulating any kind of pixel data - screen, sprite-sheet etc. PixMap uses a single byte (8 bits) for storing single color/pixel. This means that max 256 colors can be used. PixMap can also be used for maps which not necessary contain pixel colors, such as world map (as long as only 256 different tiles are used).

To create PixMap please use either NewPixMap or NewPixMapWithPixels function.

All PixMap functions (besides Clear and ClearCol) take into account the clipping region.

func NewPixMap

func NewPixMap(width, height int) PixMap

NewPixMap creates new instance of PixMap with specified size. Width and height cannot be negative.

func NewPixMapWithPixels

func NewPixMapWithPixels(pixels []byte, lineWidth int) PixMap

NewPixMapWithPixels creates new instance of PixMap using the slice of pixel colors as a source. Pixels slice contains colors for the entire PixMap. Pixels are organized from left to right, top to bottom. Slice element number 0 has pixel located in the top-left corner. Slice element number 1 has pixel color on the right, and so on.

The lineWidth is the width of PixMap. Height is calculated by dividing pixels by lineWith.

This function is handy when you already have a pixel slice and want to create a PixMap out of it. This function does not allocate anything on the heap.

func Scr

func Scr() PixMap

func SprSheet

func SprSheet() PixMap

func (PixMap) Circ

func (p PixMap) Circ(centerX int, centerY int, radius int, color byte)

Circ draws a circle.

func (PixMap) CircFill

func (p PixMap) CircFill(centerX int, centerY int, radius int, color byte)

func (PixMap) Clear

func (p PixMap) Clear()

Clear clears the entire PixMap with color 0. It does not take into account the clipping region.

func (PixMap) ClearCol

func (p PixMap) ClearCol(col byte)

ClearCol clears the entire PixMap with specified color. It does not take into account the clipping region.

func (PixMap) Clip

func (p PixMap) Clip() Region

Clip returns the clipping region, which specifies which fragment of the PixMap can be accessed by its functions. By default, clipping region has a size of the entire PixMap (no clipping).

func (PixMap) Copy

func (p PixMap) Copy(x, y, w, h int, dst PixMap, dstX, dstY int)

Copy copies the region specified by x, y, w, h into dst PixMap at dstX,dstY position.

func (PixMap) Foreach

func (p PixMap) Foreach(x, y, w, h int, update func(x, y int, dst []byte))

Foreach runs the update function on PixMap fragment specified by x, y, w and h.

The update function accepts entire line to increase the performance.

func (PixMap) Get

func (p PixMap) Get(x, y int) byte

Get returns the pixel color at given position. If coordinates are outside clipping region than color 0 is returned.

func (PixMap) Height

func (p PixMap) Height() int

Height returns the height of PixMap, without taking into account the current clipping region.

func (PixMap) Line

func (p PixMap) Line(x0, y0, x1, y1 int, color byte)

Line draws a line between points x0,y0 and x1,y1 (inclusive).

func (PixMap) Merge

func (p PixMap) Merge(x, y, w, h int, dst PixMap, dstX, dstY int, merge func(dst, src []byte))

Merge merges destination with source by running merge operation for each destination line.

func (PixMap) Pix

func (p PixMap) Pix() []byte

Pix return pixel colors. Pixels are organized from left to right, top to bottom. Slice element number 0 has pixel located in the top-left corner. Slice element number 1 has pixel color on the right and so on.

Returned slice can be freely read and updated. Useful when you want to use your own functions for pixel manipulation.

func (PixMap) Pointer

func (p PixMap) Pointer(x, y, w, h int) (ptr Pointer, ok bool)

Pointer finds the index of (x,y) coordinates and returns a pointer to pixel data at this position in Pointer.Pix.

If the pixel is outside the clipping region, then the closest pixel to the bottom-right is returned. The difference in position is returned in Pointer.DeltaX and Pointer.DeltaY.

If the pixel is either below or right after the clipping region then ok=false and empty Pointer are returned.

func (PixMap) Rect

func (p PixMap) Rect(x0, y0, x1, y1 int, col byte)

Rect draws a rectangle between points x0,y0 and x1,y1 (inclusive).

func (PixMap) RectFill

func (p PixMap) RectFill(x0 int, y0 int, x1 int, y1 int, col byte)

RectFill draws a filled rectangle between points x0,y0 and x1,y1 (inclusive).

func (PixMap) Set

func (p PixMap) Set(x, y int, col byte)

Set sets the pixel color at given position.

func (PixMap) Width

func (p PixMap) Width() int

Width returns the width of PixMap (lineWidth), without taking into account the current clipping region.

func (PixMap) WithClip

func (p PixMap) WithClip(x, y, w, h int) PixMap

WithClip creates a new PixMap which has a different clipping region. The newly created PixMap still refers to the same pixels though.

type Pointer

type Pointer struct {
	// Pix is a slice of PixMap.Pix at the position specified when calling PixMap.Pointer function.
	Pix             []byte
	DeltaX, DeltaY  int
	RemainingPixels int // in line
	RemainingLines  int
}

Pointer is a low-level struct for fast pixel processing created by PixMap.Pointer function.

type Position

type Position struct {
	X, Y int
}

var (
	// MouseBtnDuration has how many frames in a row a mouse button was pressed:
	// Index of array is equal to mouse button constant.
	MouseBtnDuration [3]uint

	// MousePosition is the position of mouse in screen coordinates.
	MousePosition Position
)

var ScreenCamera Position

type Region

type Region struct {
	X, Y, W, H int
}