Documentation
¶
Overview ¶
Package panorama holds the renderer that draws mods' interfaces in the player's game. A host whose own interface script receives the screens may compile Drawing from src/draw.ts into that script, and Hud from src/hud.ts to hide the parts of the game's HUD the screens list. A host that draws mods' own layouts installs src/layout.ts, built as an IIFE with the global name Modlock, as scripts/modlock/layout.js, which those layouts include. Vendoring this package delivers the source beside the ui protocol it reads. A page may draw the same screens in a browser on browser/dom.ts, the stand-in for game panels, which applies layout style sheets with browser/sheets.ts, with the layout rules in browser/panels.css. Every file these sources import is embedded, so a vendored copy builds.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Layout []byte
Layout is the renderer's layout, which a client content package installs as panorama/layout/modlock/ui.xml beside the built renderer script.
var Sources embed.FS
Sources holds the drawing's, the hud's and the layout library's TypeScript source and the drawing's browser stand-in.
Functions ¶
func AppendPacked ¶ added in v0.1.8
AppendPacked appends data one character per byte. Printable ASCII other than the backslash stands for itself, and every other byte for U+0100 plus the byte, so a page title carries it without whitespace, control or escape characters the browser could fold. A byte takes at most two UTF-8 bytes.
func AppendPackedLine ¶ added in v0.1.8
AppendPackedLine appends one binary frame as the line the relay page carries into a Panorama page title: "~<sequence>:<packed>\n". The relay splits the packed text into acknowledged title parts without reading it, and src/packed.ts reads the bytes back.
Types ¶
This section is empty.
Source Files