Documentation

Basic syntax

Assembly

Our assembler functions as follows:

A program is divided into lines
A line is divided into tokens separated by spaces
Each line is processed as a list of tokens

Token type	Description	Identifier	Syntax
Register	One of the 32 registers in the CPU	R	`rN` where `N` is the index
Number	A number, 16 bits. Cannot be negative (yet).	N	`0xN`, `0bN`, `0oN`, `0dN`/`N` where N is the number in hexadecimal, binary, octal or decimal
Boolean	A true or false value, a single bit.	B	`true` or `false`
Identifier	A piece of text. Usually either a label or a specific instruction	N/A	N/A
Label	An alias or line marker; pre-processing tool to not have to use numbers everywhere	N/A	`>name:` for aliases, `'name:` for line markers. Remove : for use

In the file for an instruction, the instruction will be written as instruction data:RN -> test:R. This would mean that “data” (the name is used for the description) is a register or a number.

Instructions

No-op. Does nothing, takes 1 cycle.
Drop. Free up a register for the assembler to use temporarily.
Assignment. Puts a value into a register.
Calculate. Puts the result of an operation. This instruction may use temporary registers, and a warning will be printed.
Set Palette. Sets the palette to a passed value.
Set Palette Color. Sets a color in the current palette.
Set Pixel. Sets a pixel on the screen.
Draw Sprite. Draws a sprite according to many parameters
Draw Rectangle. Draws a rectangle on the screen.
Test condition. Compare two values
Jump if. Jump to an instruction if something is true
Jump or Call. Jump to an instruction unconditionally
Return. Return after a call.
Create entity. Create a new entity.
Write to RAM. Write a number to CPU RAM.
Read from RAM. Read a number from CPU RAM.
Write range of registers to RAM.
Read range of registers from RAM.
Copy RAM. Copy part of CPU RAM into itself.
Load resource. Load a resource from the general bank.
Push resource. Push a resource into the general bank.
Request components. Request a or all components from the current entity.
Push components. Push a or all components from the current entity.
Entity meta-instructions. Delete or skip the current entity
Delete components. Remove components from the current entity
Get internal numbers. Get a variety of internal numbers for manipulation.
Set internal numbers. Set a variety of internal numbers for manipulation.
Input. Get player input.
Set sound values. Set audio output values.