ui

package
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 13, 2026 License: AGPL-3.0 Imports: 1 Imported by: 0

Documentation

Overview

Package ui is WittyPlay's server-driven UI (module API 4): what it adds to every app, as data the server checks, merges and renders (WittyMediaServer docs/SDUI-MODULES.md). sdui.json at the repository's root is written from UI and held equal to it by a test.

The games pages themselves are the server's own (Games, each games library, a game's page), drawn from the library. What WittyPlay adds is the one thing only it knows: which consoles this server plays, and how (a core installed, or a standalone emulator set up). It's a row on the Games page, a page of its own, a section for the page editor, and its settings.

Index

Constants

View Source
const (
	SourceConsoles = Module + ".consoles"
	// SettingShowConsoles, for the server: the row on the Games page is shown.
	SettingShowConsoles = "showConsoles"
	// SettingOnlyPlayable, for each profile: list only the consoles that play here.
	SettingOnlyPlayable = "onlyPlayable"
)

The source and its settings, by the names the helper answers (rpc/sdui.go).

View Source
const (
	SourceRecent      = Module + ".recent"
	SourceCollections = Module + ".collections"
	SourceFriends     = Module + ".friends"
	SourceRooms       = Module + ".rooms"
	SourceRoom        = Module + ".room"
	SourceSaveStates  = Module + ".saveStates"
	SourceMemories    = Module + ".memories"
	SourceControllers = Module + ".controllers"
	// Answered by the server for its Forms: the profile's two choices as switches, and an
	// administrator's choice of a Kids profile's friends (user: the profile's ID).
	SourcePrivacy     = Module + ".privacy"
	SourceKidsFriends = Module + ".kidsFriends"
)

WittyPlay Online's sources (WittyMediaServer docs/plans/DESIGN-2-SDUI-GAPS.md, section 6). Friends and a room's players are people: person cards, round, with a line and a badge. They're about this server's profiles, saves and running games, so the server answers them (its wittyplay_online.go) through each profile's limits; they're declared here so that pages, editors and the checks know them.

View Source
const (
	PageOnline      = Module + "-online"
	PageControllers = Module + "-controllers"
	PageQuick       = Module + "-quick"
	PageRoom        = Module + "-room"
	PageMemory      = Module + "-memory"
	PageKeep        = Module + "-keep"
	PagePrivacy     = Module + "-privacy"
	PageKids        = Module + "-kids"
)

WittyPlay Online's pages (Design 2: docs/design-2/canvas/Play.dc.html in WittyMediaServer, and the boards in docs/design-2/images/play and gaps/GB2_7). All of it is the catalogue's own components over the sources above, so every app draws it; what only a device knows (its controllers' batteries, "press any button") the app adds itself.

View Source
const Module = "wittyplay"

Module is WittyPlay's ID.

Variables

This section is empty.

Functions

func UI

func UI() *sdui.Module

UI is WittyPlay's SDUI.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL