mirror of
https://github.com/Dingo-Shenanigans/ReSkate.git
synced 2026-10-28 01:27:07 +01: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.
26 lines
1.1 KiB
C++
26 lines
1.1 KiB
C++
#pragma once
|
|
#include <string>
|
|
#include <string_view>
|
|
|
|
// Plugins in the game (Extension/Plugins): Luau scripts in mods, each in its own sandboxed VM
|
|
// (plugin_vm.h), run on the client tick. A thread looks for plugins every 2 s, so a mod switched
|
|
// on or off, or a plugin's files changed, takes effect without a restart.
|
|
//
|
|
// Every function but start is for the client thread, the one that runs console commands.
|
|
namespace dingosdk::plugins {
|
|
// Once, at startup. Plugins load at the first client tick after discovery finds them.
|
|
bool start() noexcept;
|
|
void on_client_tick() noexcept;
|
|
// The level being played, or empty without one: plugins hear level_loaded and level_unloading.
|
|
void set_level(std::string_view level) noexcept;
|
|
// Runs a plugin's console command when the text starts with one. False when none matched, and
|
|
// the text goes to ReSkate's own commands.
|
|
bool run_console(const std::string& text) noexcept;
|
|
// The `plugin` console commands.
|
|
std::string describe();
|
|
std::string list_commands();
|
|
std::string reload(std::string_view id);
|
|
std::string switch_off(std::string_view id);
|
|
std::string switch_on(std::string_view id);
|
|
}
|