From 7b04080e9e86731cb97779a77e1e5a8598af983e Mon Sep 17 00:00:00 2001 From: dylan <> Date: Sun, 14 May 2023 13:44:22 -0700 Subject: [PATCH] Update manual --- manual.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/manual.md b/manual.md index c35dc4a..ad6ddf6 100644 --- a/manual.md +++ b/manual.md @@ -1,6 +1,6 @@ # Faux Manual -This document is up-to-date as of May 13, 2023. +This document is up-to-date as of May 14, 2023. Faux is a [fantasy console](https://en.wikipedia.org/wiki/Fantasy_video_game_console) heavily inspired by [PICO-8](https://www.lexaloffle.com/pico-8.php), but with several alternative design choices. It is probably nowhere near as resource efficient either. @@ -12,7 +12,7 @@ Glad you asked. Probably the most important difference is that cartridges are written in JavaScript rather than Lua. -Another huge design difference, is that a Faux cartridge is made up of up to 16 "sheets". Each sheet can store a certain amount of data in a specific format. Sheets can be used to hold sprite data, map data, code, and eventually music/sfx, fonts, and other types of data. +Another huge design difference is that rather than having a fixed amount of sprite/map/music data, a Faux cartridge is made up of up to 16 "sheets". Each sheet can store a certain amount of data in a specific format. Sheets can be used to hold sprite data, map data, code, and eventually music/sfx, fonts, and other types of data. The first sheet must always be a code sheet and must return an object with three properties: `init`, `update`, and `draw`, each of which should be a function. ## Code @@ -37,7 +37,7 @@ And math symbols: - `camera(x: number, y: number)` draws everything from here on with an offset of (-x, -y). - `sprsht(sheet: number)` sets the current spritesheet used for drawing sprites with the `spr` function below. - `spr(x: number, y: number, sprite: number)` draws the given sprite from the current spritesheet at (x,y). -- `txt(x: number, y: number, text: string)` draws the given text at (x,y). +- `txt(x: number, y: number, text: string, color?: number)` draws the given text at (x,y) in the provided color (or white if none provided). - `rectfill(x: number, y: number, w: number, h: number, color: number)` fills a rectangle with the given color with a top-left corner at (x,y) and a width of w and a height of h. - `rect(x: number, y: number, w: number, h: number, color: number)` outlines a rectangle with the given color with a top-left corner at (x,y) and a width of w and a height of h. - `circfill(x: number, y: number, r: number, color: number)` fills a circle with the given color with a center at (x,y) and a radius of r.