mirror of
https://github.com/Dingo-Shenanigans/ReSkate.git
synced 2026-10-23 19:56:00 +02:00
AyeZeeBB
6d542536e1
A mod with a reskate-plugin.json is a plugin: Luau scripts that run in their own VM, with only
the reskate API ReSkate registers for them. Luau 0.741 is vendored in External/luau (the VM and
compiler only: no native code generation, no loadstring, io or C modules).
- Limits: 64 MB of memory, 50 ms a call, 2 ms a tick on average (over it for 3 s stops it),
more than 5 errors in 10 s stops it, 50 log lines a second. A plugin over a limit cannot catch
it in a pcall and carry on.
- API: reskate.log, on (load, unload, tick, level_loaded, level_unloading), timers, the level,
its own package's files and JSON, require inside the package; console.command and print
("console"); storage get, set, add and keys ("storage"), 1 MB in
%LOCALAPPDATA%\ReSkate\Plugins\<mod>\storage.json.
- Found every 2 s among the mods mods.json leaves on: switching a mod, or changing a plugin's
files, loads, unloads or reloads it without a restart. A package holding a program is refused.
- plugin list, commands, reload, off and on in the console. A plugin cannot take a name of
ReSkate's own commands.
- Tests: DINGOSDK_BUILD_PLUGIN_TESTS, including plugins written to break the sandbox.
17 lines
715 B
C++
17 lines
715 B
C++
#pragma once
|
|
#include "plugin_vm.h"
|
|
|
|
// Inside the plugin host only: the reskate API a plugin's VM gets.
|
|
namespace dingosdk::plugins {
|
|
struct Api {
|
|
// The `reskate` table, `print` and `require`, before the VM is sandboxed.
|
|
static void install(Plugin& plugin, lua_State* L);
|
|
};
|
|
// A file's bytes when it is a regular file no larger than `most`; otherwise empty, and `error`
|
|
// says why ("not found" when there is none).
|
|
std::string read_package_file(const std::filesystem::path& file, std::size_t most, std::string& error);
|
|
// JSON and Lua values, both ways. Throws std::runtime_error on a value JSON cannot hold.
|
|
Json lua_to_json(lua_State* L, int index);
|
|
void push_json(lua_State* L, const Json& value);
|
|
}
|