Documentation
¶
Overview ¶
Package sandbox runs built mods without a game. A Mod is one WebAssembly module behind the host boundary, kept to modlock-host's imports and limits; a Sandbox runs a session of mods with a stand-in player, as a server would.
Index ¶
Constants ¶
const ManifestFile = "mod.json"
ManifestFile is the manifest's file name in a built mod.
Variables ¶
This section is empty.
Functions ¶
func Interpreter ¶
func Interpreter(runtime wasm.Manifest_Runtime) string
Interpreter names the module in Modlock's host package that runs an interpreted runtime, or is empty for WebAssembly and unknown runtimes.
Types ¶
type Build ¶
type Build struct {
// Manifest is the mod's mod.json.
Manifest *wasm.Manifest
// Entry is the file the manifest names: the module of a WebAssembly mod,
// or the source an interpreter runs.
Entry []byte
}
Build is a built mod as the host reads it.
type Config ¶
type Config struct {
// Mods lists the built mods to run.
Mods []string
// Map names the world the mods start in, or is empty for none.
Map string
// Args are passed to each mod's start handlers.
Args []string
// Interpreters returns the directory that holds the interpreted
// runtimes' modules, such as quickjs.wasm. It is called the first time an
// interpreted mod loads.
Interpreters func(ctx context.Context) (string, error)
// Events receives each event a server would report, on one goroutine.
Events func(*control.HostEvent)
// Settings is the file that keeps the player's settings, or empty to
// keep them for the session only.
Settings string
// Compiled is the directory that keeps compiled modules across sessions,
// so a later session loads the interpreters and an unchanged mod without
// compiling them, or empty to compile each module once per session.
Compiled string
}
Config describes a sandbox session.
type Mod ¶
type Mod struct {
// contains filtered or unexported fields
}
Mod is one instance of a mod's module. It handles one event at a time.
func Load ¶
Load checks that module imports only from modlock and WASI preview 1 and exports memory and modlock_event, then instantiates and initializes it within the host's memory and time limits.
func (*Mod) Deliver ¶
Deliver calls the mod's method with request within the event budget and decodes its answer into response, which is nil for a method that answers nothing. Start gets the start budget instead, since a script mod evaluates its script there. An error the mod returns is the call's error; a trap or an exhausted budget also stops the mod.
type Options ¶
type Options struct {
// Calls answers the mod's host calls, or is nil to answer each with an
// empty reply, as a host with no game would.
Calls func(call *wasm.Call) *wasm.Reply
// Output receives the mod's standard output and error, or is nil to drop
// them.
Output io.Writer
// Cache keeps compiled modules for later loads, or is nil for none.
Cache wazero.CompilationCache
}
Options configure a loaded Mod.
type Sandbox ¶
type Sandbox struct {
// contains filtered or unexported fields
}
Sandbox runs mods without a game, as a server would with one player who never has a hero: it starts each mod, gives it the world and the frame clock, passes the player's commands and button presses to it, and reports its logs, the messages it shows the player and its interface as host events. Host calls that need the game answer empty.
func Start ¶
Start starts the mods in a new sandbox. A mod that fails to load reports the failure and leaves the others running.
func (*Sandbox) Command ¶
Command passes line to the mods as the player's command, as if typed in chat, and reports whether a mod claimed it. A leading slash is optional.
func (*Sandbox) Press ¶
Press presses the button node in the interface mod shows the player in slot, and reports whether the mod is running to receive it.
Source Files