SignPuddle 3 Interface API

Interface

SignPuddle 3 organizes user interface elements into interface collections. Interface collections are available in three different forms: database, plain text files, and JSON objects

Databases

Each collection is available as an SQLite database. These databases are the primary source and all edits are directly applied to the database.

table entry

• key

• message

• description

• icon

• user

• created_at

• updated_at

Plain Text Files

Each collection is available as a plain text field where each entry occupies its own line. Each entry contains multiple fields that are divided by tab characters. The plain text files are designed for easy import and export from the databases.

key /t message /t description /t icon /t user /t created_at /t updated_at

JSON Data files

The interface JSON data file is an object. Each key contains an object with three properties: message, description, icon, and updated_at.

{ “name”: “en-US-interface-sp3”, “data”: { “key.example.one”: { “message”: “example message”, “description”: “example description”, “icon”: “example”, “updated_at”: “date-time” } } }