QCherry: Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

2026-09-21T20:41:00Z

Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

← Older revision		Revision as of 20:41, 21 September 2026
Line 1:		Line 1:
	= Resource data storage =		= Resource data storage =
	'''Server-side; since 0.1.4 ~~(in development, not public 0.1.3)~~.'''		'''Server-side; since 0.1.4.'''

	Three resource-scoped persistence functions support map saves and Lua exports. They do not expose arbitrary filesystem paths or MySQL connections.		Three resource-scoped persistence functions support map saves and Lua exports. They do not expose arbitrary filesystem paths or MySQL connections.

QCherry: Document Map Editor, saved maps, static scene deployment and Lua APIs since 0.1.4

2026-09-20T18:19:34Z

Document Map Editor, saved maps, static scene deployment and Lua APIs since 0.1.4

New page

= Resource data storage =
'''Server-side; since 0.1.4 (in development, not public 0.1.3).'''

Three resource-scoped persistence functions support map saves and Lua exports. They do not expose arbitrary filesystem paths or MySQL connections.

{| class="wikitable"
! Function !! Return !! File in the calling resource
|-
| [[readResourceData]]<code>(key)</code> || JSON text string, or false for missing/invalid/unreadable data || <code>.storage/data-KEY.json</code>
|-
| [[writeResourceData]]<code>(key, json)</code> || boolean success; json must be a nonempty valid JSON string || <code>.storage/data-KEY.json</code>
|-
| [[writeResourceText]]<code>(key, text)</code> || boolean success; writes nonempty text without validating/executing Lua || <code>.storage/data-KEY.lua</code>
|}

Keys contain 1-64 ASCII letters, digits, underscores or hyphens. Pass a key only, '''not''' a path, prefix <code>data-</code> or extension. Each resource can access only its own storage root. <code>readResourceData</code> reads JSON only; it does not read a writeResourceText Lua export. No matching generic Lua-text read function is exposed here.

== Example ==
<syntaxhighlight lang="lua">
local json = toJSON({format="my-layout", version=1, objects={}})
if json and writeResourceData("layout", json) then
outputDebugString("Layout saved")
else
outputDebugString("Layout save failed", 1)
end
local saved = readResourceData("layout")
local layout = saved and fromJSON(saved)
-- Validate your own schema before using layout; JSON validity is not a schema check.

local exported = writeResourceText("layout_export", "MapScene = {}\n")
-- This only writes text. It neither starts a resource nor executes that text.
</syntaxhighlight>

== Safety and limits ==
Maximum payload size: 1048576 bytes (1 MiB) per file. Before writing, the current storage directory is checked: a write is refused if existing regular files already total more than 64 MiB or their count exceeds 512; backups/temp files also count. These are pre-write admission checks, not a reservation of space for the incoming file and backup. Filesystem errors can also cause false. The map editor adds a stricter 1000000-byte transfer limit.

Writes use a temporary file and replacement, retaining one <code>.bak</code> copy when overwriting an existing destination. Keep independent backups; this is not a database transaction across multiple keys or an unlimited revision archive. Path traversal and symlink/junction escapes are rejected. Never accept untrusted client text as executable exported Lua; writeResourceText does not validate its content for you.

The functions validate storage/JSON, not gameplay permissions: server scripts must authorize who may submit data, validate schema and bound request sizes/rates. The editor implements those checks and a named-map session lock. See [[Map editor]] for its filenames and [[Map scene deployment]] for the explicit publication step.
[[Category:Lua API]]

Resource data storage - Revision history

QCherry: Release 0.1.4 BUILD133 / Protocol 36 and document authenticated event origin

QCherry: Document Map Editor, saved maps, static scene deployment and Lua APIs since 0.1.4