mirror of
https://github.com/Dingo-Shenanigans/ReSkate.git
synced 2026-10-23 22:16: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.
19 lines
842 B
C++
19 lines
842 B
C++
#pragma once
|
|
#include "plugin_host.h"
|
|
#include <filesystem>
|
|
#include <map>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
// Which mods are plugins: the mods mods.json leaves on (Engine/Vfs/mod_list.h) that have a
|
|
// reskate-plugin.json. Reads the disk; run it off the game thread.
|
|
namespace dingosdk::plugins {
|
|
// What check_package_files said about a package, by its fingerprint, so an unchanged package is
|
|
// not read again.
|
|
using FileChecks = std::map<std::string, std::string, std::less<>>;
|
|
std::vector<Candidate> discover(const std::filesystem::path& data_root, FileChecks& checks);
|
|
// Why a package may not load, from its files alone, or empty. A plugin never ships a program: no
|
|
// Windows executable (by its first bytes, whatever its name) and no script Windows runs.
|
|
std::string check_package_files(const std::filesystem::path& directory);
|
|
}
|