mirror of
https://github.com/PHIDIAS0303/ExpCluster.git
synced 2026-11-21 07:33:12 +09:00
Merge branch 'main' into aperx
This commit is contained in:
commit
02a5b69616
115 files changed
+5014
-1456
No files matched your search
@@ -1,3 +1 @@
|
||||
webpack.config.js
|
||||
dist/web/build
|
||||
dist/browser
|
||||
# Without an .npmignore pnpm packs using the repository .gitignore, which leaves out dist/
|
||||
+138
-121
@@ -1,6 +1,6 @@
|
||||
import * as lib from "@clusterio/lib";
|
||||
import * as path from "node:path";
|
||||
import type { Controller, ControllerPluginContext } from "@clusterio/controller";
|
||||
import type { ControllerPluginContext } from "@clusterio/controller";
|
||||
import { RoleMetaRecord } from "@expcluster/roles";
|
||||
import { GroupRecord, GroupPermissions, RoleMappingRecord } from "@expcluster/permission-groups";
|
||||
import { ControllerPlugin as RolesPlugin } from "@expcluster/roles/dist/node/controller.js";
|
||||
@@ -9,149 +9,79 @@ import * as messages from "./messages.js";
|
||||
import { features, pruneFeatureValues, validateFeatureValues } from "./features.js";
|
||||
import { SeedRole, SeedGroup, seedRoles, seedGroups, flattenSeedPermissions } from "./seed.js";
|
||||
|
||||
export class ControllerPlugin {
|
||||
private constructor(
|
||||
public controller: Controller,
|
||||
public logger: lib.Logger,
|
||||
public name: string,
|
||||
public features: lib.SubscribableDatastore<messages.FeatureRecord>,
|
||||
) {}
|
||||
export default async function (context: ControllerPluginContext) {
|
||||
const { controller, logger, plugin } = context;
|
||||
const databaseDirectory = controller.config.get("controller.database_directory");
|
||||
const featureStore = new lib.SubscribableDatastore(
|
||||
...await new lib.JsonIdDatastoreProvider(
|
||||
path.join(databaseDirectory, "exp_scenario", "features.json"),
|
||||
messages.FeatureRecord.fromJSON.bind(messages.FeatureRecord),
|
||||
).bootstrap()
|
||||
);
|
||||
const playerStore = new lib.SubscribableDatastore(
|
||||
...await new lib.JsonIdDatastoreProvider(
|
||||
path.join(databaseDirectory, "exp_scenario", "players.json"),
|
||||
messages.PlayerRecord.fromJSON.bind(messages.PlayerRecord),
|
||||
).bootstrap()
|
||||
);
|
||||
|
||||
static async fromContext(context: ControllerPluginContext) {
|
||||
const controller = context.controller;
|
||||
const databaseDirectory = controller.config.get("controller.database_directory");
|
||||
const features = new lib.SubscribableDatastore(
|
||||
...await new lib.JsonIdDatastoreProvider(
|
||||
path.join(databaseDirectory, "exp_scenario", "features.json"),
|
||||
messages.FeatureRecord.fromJSON.bind(messages.FeatureRecord),
|
||||
).bootstrap()
|
||||
type PlayerSettings = Pick<messages.PlayerRecord, "joinMessage" | "locale" | "toolbar">;
|
||||
|
||||
/** Change some settings of a player, empty values are removed and so is a record left empty */
|
||||
function updatePlayer(name: string, changes: PlayerSettings) {
|
||||
const old = playerStore.get(name);
|
||||
const settings: PlayerSettings = {
|
||||
joinMessage: old?.joinMessage, locale: old?.locale, toolbar: old?.toolbar, ...changes,
|
||||
};
|
||||
const record = new messages.PlayerRecord(
|
||||
name, settings.joinMessage || undefined, settings.locale || undefined, settings.toolbar || undefined,
|
||||
);
|
||||
|
||||
const plugin = new ControllerPlugin(controller, context.logger, context.plugin.name, features);
|
||||
plugin.reconcileFeatures();
|
||||
|
||||
controller.subscriptions.handle(messages.FeatureUpdatedEvent, plugin.handleFeatureSubscription.bind(plugin));
|
||||
features.on("update", plugin.featuresUpdated.bind(plugin));
|
||||
|
||||
controller.handle(messages.SeedRequest, plugin.handleSeedRequest.bind(plugin));
|
||||
controller.handle(messages.FeatureListRequest, plugin.handleFeatureListRequest.bind(plugin));
|
||||
controller.handle(messages.FeatureUpdateRequest, plugin.handleFeatureUpdateRequest.bind(plugin));
|
||||
|
||||
controller.hooks.shutdown.attach(plugin.name, plugin.onShutdown.bind(plugin));
|
||||
return plugin;
|
||||
}
|
||||
|
||||
async onShutdown() {
|
||||
await this.features.save();
|
||||
if (record.joinMessage || record.locale || record.toolbar) {
|
||||
playerStore.set(record);
|
||||
} else if (old) {
|
||||
playerStore.delete(old);
|
||||
}
|
||||
}
|
||||
|
||||
/** Add new features, delete removed ones, and drop stored values which no longer fit a field */
|
||||
reconcileFeatures() {
|
||||
function reconcileFeatures() {
|
||||
const declared = new Map(features.map(feature => [feature.name, feature]));
|
||||
for (const record of this.features.values()) {
|
||||
for (const record of featureStore.values()) {
|
||||
const feature = declared.get(record.id);
|
||||
if (!feature) {
|
||||
this.logger.warn(`Dropping stored config of removed feature ${record.id}`);
|
||||
this.features.delete(record);
|
||||
logger.warn(`Dropping stored config of removed feature ${record.id}`);
|
||||
featureStore.delete(record);
|
||||
continue;
|
||||
}
|
||||
|
||||
const { kept, dropped } = pruneFeatureValues(feature, record.values);
|
||||
if (dropped.length) {
|
||||
this.logger.warn(`Dropping stored values of ${record.id} which no longer match a setting: ${dropped.join(", ")}`);
|
||||
this.features.set(new messages.FeatureRecord(record.id, record.enabled, kept));
|
||||
logger.warn(`Dropping stored values of ${record.id} which no longer match a setting: ${dropped.join(", ")}`);
|
||||
featureStore.set(new messages.FeatureRecord(record.id, record.enabled, kept));
|
||||
}
|
||||
}
|
||||
|
||||
const missing = features.filter(feature => !this.features.has(feature.name));
|
||||
const missing = features.filter(feature => !featureStore.has(feature.name));
|
||||
if (missing.length) {
|
||||
this.features.setMany(missing.map(feature => new messages.FeatureRecord(feature.name, true)));
|
||||
featureStore.setMany(missing.map(feature => new messages.FeatureRecord(feature.name, true)));
|
||||
}
|
||||
}
|
||||
|
||||
featuresUpdated(updates: messages.FeatureRecord[]) {
|
||||
this.controller.subscriptions.broadcast(new messages.FeatureUpdatedEvent(updates));
|
||||
}
|
||||
|
||||
async handleFeatureSubscription(request: lib.SubscriptionRequest) {
|
||||
const updates = [...this.features.values()].filter(feature => feature.updatedAtMs > request.lastRequestTimeMs);
|
||||
return updates.length ? new messages.FeatureUpdatedEvent(updates) : null;
|
||||
}
|
||||
|
||||
async handleFeatureListRequest() {
|
||||
return [...this.features.values()];
|
||||
}
|
||||
|
||||
async handleFeatureUpdateRequest(request: messages.FeatureUpdateRequest) {
|
||||
let values;
|
||||
try {
|
||||
values = validateFeatureValues(request.id, request.values);
|
||||
} catch (err: any) {
|
||||
throw new lib.RequestError(err.message);
|
||||
}
|
||||
|
||||
const feature = new messages.FeatureRecord(request.id, request.enabled, values);
|
||||
this.features.set(feature);
|
||||
return feature;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the roles and permission groups the scenario shipped with.
|
||||
*
|
||||
* Roles which already exist by name are reused and only gain the seed
|
||||
* permissions, groups which already exist by name are reset to the seed.
|
||||
*/
|
||||
async handleSeedRequest() {
|
||||
const rolesPlugin = RolesPlugin.get(this.controller);
|
||||
const groupsPlugin = GroupsPlugin.get(this.controller);
|
||||
if (!rolesPlugin || !groupsPlugin) {
|
||||
throw new lib.RequestError("Seeding requires the exp_roles and exp_groups plugins");
|
||||
}
|
||||
|
||||
const roleIds = new Map<string, number>();
|
||||
for (const [index, seedRole] of seedRoles.entries()) {
|
||||
const role = this.seedRole(seedRole);
|
||||
if (!role) {
|
||||
continue;
|
||||
}
|
||||
|
||||
roleIds.set(seedRole.name, role.id);
|
||||
rolesPlugin.roleMeta.set(new RoleMetaRecord(
|
||||
role.id,
|
||||
index + 1,
|
||||
seedRole.priority ?? 0,
|
||||
seedRole.shortHand,
|
||||
"",
|
||||
seedRole.color,
|
||||
seedRole.autoAssignHours === undefined ? null : seedRole.autoAssignHours * 3600000,
|
||||
seedRole.blockAutoAssign ?? false,
|
||||
));
|
||||
}
|
||||
|
||||
const groupIds = new Map<string, number>();
|
||||
for (const seedGroup of seedGroups) {
|
||||
groupIds.set(seedGroup.name, this.seedGroup(groupsPlugin, seedGroup).id);
|
||||
}
|
||||
|
||||
this.seedRoleMappings(groupsPlugin, roleIds, groupIds);
|
||||
this.logger.info(`Seeded ${roleIds.size} roles and ${groupIds.size} permission groups`);
|
||||
}
|
||||
|
||||
/** Find or create the clusterio role for a seed role, returns undefined if it has no role to use. */
|
||||
seedRole(seedRole: SeedRole) {
|
||||
const roles = this.controller.roles;
|
||||
function ensureRole(seedRole: SeedRole) {
|
||||
const roles = controller.roles;
|
||||
if (seedRole.isAdmin) {
|
||||
return roles.get(lib.Role.DefaultAdminRoleId);
|
||||
}
|
||||
if (seedRole.isDefault) {
|
||||
const defaultRoleId = this.controller.config.get("controller.default_role_id");
|
||||
const defaultRoleId = controller.config.get("controller.default_role_id");
|
||||
return defaultRoleId !== null ? roles.get(defaultRoleId) : undefined;
|
||||
}
|
||||
|
||||
const permissions = flattenSeedPermissions(seedRole);
|
||||
for (const permission of permissions) {
|
||||
if (!lib.permissions.has(permission)) {
|
||||
this.logger.warn(`Seed role ${seedRole.name} grants unknown permission ${permission}`);
|
||||
logger.warn(`Seed role ${seedRole.name} grants unknown permission ${permission}`);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -163,19 +93,19 @@ export class ControllerPlugin {
|
||||
} else {
|
||||
const id = Math.max(5, ...[...roles.keys()].map(other => other + 1));
|
||||
role = new lib.Role(id, seedRole.name, "", permissions);
|
||||
this.logger.info(`Created role ${seedRole.name}`);
|
||||
logger.info(`Created role ${seedRole.name}`);
|
||||
}
|
||||
roles.set(role);
|
||||
return role;
|
||||
}
|
||||
|
||||
/** Find or create the permission group for a seed group. */
|
||||
seedGroup(groupsPlugin: GroupsPlugin, seedGroup: SeedGroup) {
|
||||
function ensureGroup(groupsPlugin: GroupsPlugin, seedGroup: SeedGroup) {
|
||||
const permissions = new GroupPermissions(seedGroup.isBlacklist, [...seedGroup.inputActions]);
|
||||
const existing = [...groupsPlugin.groups.values()].find(other => other.name === seedGroup.name);
|
||||
const group = new GroupRecord(existing?.id ?? newId(groupsPlugin.groups), seedGroup.name, permissions);
|
||||
if (!existing) {
|
||||
this.logger.info(`Created permission group ${seedGroup.name}`);
|
||||
logger.info(`Created permission group ${seedGroup.name}`);
|
||||
}
|
||||
groupsPlugin.groups.set(group);
|
||||
return group;
|
||||
@@ -188,7 +118,7 @@ export class ControllerPlugin {
|
||||
* priorities follow how exp_roles picks a player's highest role: role
|
||||
* priority first, then the role order.
|
||||
*/
|
||||
seedRoleMappings(groupsPlugin: GroupsPlugin, roleIds: Map<string, number>, groupIds: Map<string, number>) {
|
||||
function seedRoleMappings(groupsPlugin: GroupsPlugin, roleIds: Map<string, number>, groupIds: Map<string, number>) {
|
||||
// Lowest role first, so the mapping priority rises with the role
|
||||
const ranked = seedRoles
|
||||
.filter(seedRole => seedRole.group !== undefined && roleIds.has(seedRole.name))
|
||||
@@ -227,12 +157,99 @@ export class ControllerPlugin {
|
||||
}
|
||||
|
||||
groupsPlugin.roleMappings.setMany(mappings);
|
||||
return mappings;
|
||||
}
|
||||
}
|
||||
|
||||
export default async function (context: ControllerPluginContext) {
|
||||
await ControllerPlugin.fromContext(context);
|
||||
reconcileFeatures();
|
||||
|
||||
controller.subscriptions.handle(messages.FeatureUpdatedEvent, async request => {
|
||||
const updates = [...featureStore.values()].filter(feature => feature.updatedAtMs > request.lastRequestTimeMs);
|
||||
return updates.length ? new messages.FeatureUpdatedEvent(updates) : null;
|
||||
});
|
||||
featureStore.on("update", updates => {
|
||||
controller.subscriptions.broadcast(new messages.FeatureUpdatedEvent(updates));
|
||||
});
|
||||
|
||||
/**
|
||||
* Create the roles and permission groups the scenario shipped with.
|
||||
*
|
||||
* Roles which already exist by name are reused and only gain the seed
|
||||
* permissions, groups which already exist by name are reset to the seed.
|
||||
*/
|
||||
controller.handle(messages.SeedRequest, async () => {
|
||||
const rolesPlugin = RolesPlugin.get(controller);
|
||||
const groupsPlugin = GroupsPlugin.get(controller);
|
||||
if (!rolesPlugin || !groupsPlugin) {
|
||||
throw new lib.RequestError("Seeding requires the exp_roles and exp_groups plugins");
|
||||
}
|
||||
|
||||
const roleIds = new Map<string, number>();
|
||||
for (const [index, seed] of seedRoles.entries()) {
|
||||
const role = ensureRole(seed);
|
||||
if (!role) {
|
||||
continue;
|
||||
}
|
||||
|
||||
roleIds.set(seed.name, role.id);
|
||||
rolesPlugin.roleMeta.set(new RoleMetaRecord(
|
||||
role.id,
|
||||
index + 1,
|
||||
seed.priority ?? 0,
|
||||
seed.shortHand,
|
||||
"",
|
||||
seed.color,
|
||||
seed.autoAssignHours === undefined ? null : seed.autoAssignHours * 3600000,
|
||||
seed.blockAutoAssign ?? false,
|
||||
));
|
||||
}
|
||||
|
||||
const groupIds = new Map<string, number>();
|
||||
for (const seed of seedGroups) {
|
||||
groupIds.set(seed.name, ensureGroup(groupsPlugin, seed).id);
|
||||
}
|
||||
|
||||
seedRoleMappings(groupsPlugin, roleIds, groupIds);
|
||||
logger.info(`Seeded ${roleIds.size} roles and ${groupIds.size} permission groups`);
|
||||
});
|
||||
|
||||
controller.handle(messages.FeatureListRequest, async () => [...featureStore.values()]);
|
||||
|
||||
controller.handle(messages.FeatureUpdateRequest, async (request: messages.FeatureUpdateRequest) => {
|
||||
let values;
|
||||
try {
|
||||
values = validateFeatureValues(request.id, request.values);
|
||||
} catch (err: any) {
|
||||
throw new lib.RequestError(err.message);
|
||||
}
|
||||
|
||||
const feature = new messages.FeatureRecord(request.id, request.enabled, values);
|
||||
featureStore.set(feature);
|
||||
return feature;
|
||||
});
|
||||
|
||||
controller.handle(messages.PlayerGetRequest, async (request: messages.PlayerGetRequest) => (
|
||||
playerStore.get(request.playerName) ?? new messages.PlayerRecord(request.playerName)
|
||||
));
|
||||
|
||||
controller.handle(messages.JoinMessageSetRequest, async (request: messages.JoinMessageSetRequest) => {
|
||||
updatePlayer(request.playerName, { joinMessage: request.message?.trim() });
|
||||
});
|
||||
|
||||
controller.handle(messages.PlayerLocaleEvent, async (event: messages.PlayerLocaleEvent) => {
|
||||
updatePlayer(event.playerName, { locale: event.locale });
|
||||
});
|
||||
|
||||
controller.handle(messages.PlayerToolbarEvent, async (event: messages.PlayerToolbarEvent) => {
|
||||
updatePlayer(event.playerName, { toolbar: event.toolbar });
|
||||
});
|
||||
|
||||
controller.hooks.save.attach(plugin.name, async () => {
|
||||
await playerStore.save();
|
||||
});
|
||||
|
||||
controller.hooks.shutdown.attach(plugin.name, async () => {
|
||||
await featureStore.save();
|
||||
await playerStore.save();
|
||||
});
|
||||
}
|
||||
|
||||
function newId(datastore: { has(id: number): boolean }) {
|
||||
|
||||
@@ -81,6 +81,19 @@ export const features: Feature[] = [
|
||||
str("command_prefix", "Command prefix", "Prefix for chat commands, and for key words to reply to everyone", "!"),
|
||||
],
|
||||
},
|
||||
{
|
||||
name: "community_details",
|
||||
title: "Community Details",
|
||||
description: "The community name and links shown in chat, the readme, help bubbles, and the greeting. These are always used, the switch has no effect",
|
||||
fields: [
|
||||
str("community_name", "Community name", "Name of the community", "Explosive Gaming"),
|
||||
str("discord", "Discord", "Invite link to the Discord server", "https://discord.explosivegaming.nl"),
|
||||
str("website", "Website", "Link to the website", "https://www.explosivegaming.nl"),
|
||||
str("status", "Status page", "Link to the server status page", "https://status.explosivegaming.nl"),
|
||||
str("github", "GitHub", "Link to the source code", "https://github.com/explosivegaming/ExpCluster"),
|
||||
str("patreon", "Patreon", "Link to donate", "https://www.patreon.com/ExpGaming"),
|
||||
],
|
||||
},
|
||||
{
|
||||
name: "custom_start",
|
||||
title: "Custom Start",
|
||||
@@ -161,6 +174,12 @@ export const features: Feature[] = [
|
||||
num("rocket_launch_display_rate", "Rocket log interval", "After the first few launches, log every this many rockets", 500, 1, "rockets"),
|
||||
],
|
||||
},
|
||||
{
|
||||
name: "greetings",
|
||||
title: "Greetings",
|
||||
description: "Greet players when they join and show the join message they set, the messages are edited on the user page",
|
||||
fields: [],
|
||||
},
|
||||
{
|
||||
name: "help_bubbles",
|
||||
title: "Help Bubbles",
|
||||
|
||||
@@ -8,6 +8,8 @@ declare module "@clusterio/lib" {
|
||||
"exp_scenario.config.view": never;
|
||||
"exp_scenario.config.edit": never;
|
||||
"exp_scenario.seed": never;
|
||||
"exp_scenario.join_message.set": never;
|
||||
"exp_scenario.join_message.set_other": never;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,6 +25,10 @@ export const plugin: lib.PluginDeclaration = {
|
||||
messages.FeatureUpdatedEvent,
|
||||
messages.FeatureListRequest,
|
||||
messages.FeatureUpdateRequest,
|
||||
messages.PlayerGetRequest,
|
||||
messages.JoinMessageSetRequest,
|
||||
messages.PlayerLocaleEvent,
|
||||
messages.PlayerToolbarEvent,
|
||||
],
|
||||
|
||||
permissions: [
|
||||
@@ -42,6 +48,16 @@ export const plugin: lib.PluginDeclaration = {
|
||||
title: "Seed ExpScenario roles and groups",
|
||||
description: "Create the roles and permission groups the scenario shipped with",
|
||||
},
|
||||
{
|
||||
name: "exp_scenario.join_message.set",
|
||||
title: "Set own join message",
|
||||
description: "Set the message shown to everyone when you join, in game this is /set-join-message",
|
||||
},
|
||||
{
|
||||
name: "exp_scenario.join_message.set_other",
|
||||
title: "Set join messages of others",
|
||||
description: "Set the message shown to everyone when another user joins",
|
||||
},
|
||||
],
|
||||
|
||||
webEntrypoint: "./web",
|
||||
|
||||
+104
-58
@@ -1,86 +1,132 @@
|
||||
import type { Instance, InstancePluginContext } from "@clusterio/host";
|
||||
import type { InstancePluginContext } from "@clusterio/host";
|
||||
import * as lib from "@clusterio/lib";
|
||||
import * as messages from "./messages.js";
|
||||
import { features, FeatureValue } from "./features.js";
|
||||
|
||||
/** Sends feature config to the lua side, see module/features.lua. */
|
||||
export class InstancePlugin {
|
||||
/** Sent by the lua side when a player sets or removes their join message, see module/control/greetings.lua */
|
||||
export type IpcJoinMessageSet = { player_name: string, message?: string };
|
||||
/** Sent by the lua side when a player asks for their join message */
|
||||
export type IpcJoinMessageGet = { player_name: string };
|
||||
/** Sent by the lua side when a player joins or changes language, see module/control/player_settings.lua */
|
||||
export type IpcLocale = { player_name: string, locale: string };
|
||||
/** Sent by the lua side when a player leaves */
|
||||
export type IpcToolbar = { player_name: string, toolbar: string };
|
||||
|
||||
/** Json as a lua expression for a table, inside a long bracket the json does not contain */
|
||||
export function luaJson(value: unknown) {
|
||||
const json = JSON.stringify(value);
|
||||
let level = "=";
|
||||
while (json.includes(`]${level}]`)) {
|
||||
level += "=";
|
||||
}
|
||||
return `helpers.json_to_table[${level}[${json}]${level}]`;
|
||||
}
|
||||
|
||||
/** Sends feature config and player settings to the lua side, see module/features.lua. */
|
||||
export default async function (context: InstancePluginContext) {
|
||||
const { instance, logger, plugin } = context;
|
||||
/** Rcon is up and the lua side can take updates */
|
||||
started = false;
|
||||
|
||||
private constructor(
|
||||
public instance: Instance,
|
||||
public logger: lib.Logger,
|
||||
public name: string,
|
||||
) {}
|
||||
|
||||
static async fromContext(context: InstancePluginContext) {
|
||||
const instance = context.instance;
|
||||
const plugin = new InstancePlugin(instance, context.logger, context.plugin.name);
|
||||
|
||||
instance.handle(messages.FeatureUpdatedEvent, plugin.handleFeatureUpdatedEvent.bind(plugin));
|
||||
instance.hooks.start.attach(plugin.name, plugin.onStart.bind(plugin));
|
||||
instance.hooks.exit.attach(plugin.name, plugin.onExit.bind(plugin));
|
||||
instance.hooks.controllerConnectionEvent.attach(plugin.name, plugin.onControllerConnectionEvent.bind(plugin));
|
||||
return plugin;
|
||||
}
|
||||
|
||||
async onStart() {
|
||||
this.started = true;
|
||||
await this.syncFeatures();
|
||||
}
|
||||
|
||||
async onExit() {
|
||||
this.started = false;
|
||||
}
|
||||
|
||||
/** A new session means the controller restarted and forgot the subscription. */
|
||||
async onControllerConnectionEvent(event: "connect" | "drop" | "resume" | "close") {
|
||||
if (event === "connect" && this.started) {
|
||||
await this.syncFeatures();
|
||||
}
|
||||
}
|
||||
let started = false;
|
||||
/** Enabled state of features which need it on this side, by name */
|
||||
const featureEnabled = new Map<string, boolean>();
|
||||
|
||||
/** Subscribe, then send every feature */
|
||||
async syncFeatures() {
|
||||
await this.instance.sendTo("controller", new lib.SubscriptionRequest(
|
||||
async function syncFeatures() {
|
||||
await instance.sendTo("controller", new lib.SubscriptionRequest(
|
||||
`exp_scenario:${messages.FeatureUpdatedEvent.name}`, "subscribe", Date.now(),
|
||||
));
|
||||
const features = await this.instance.sendTo("controller", new messages.FeatureListRequest());
|
||||
await this.luaSendFeatures(features);
|
||||
}
|
||||
|
||||
async handleFeatureUpdatedEvent(event: messages.FeatureUpdatedEvent) {
|
||||
if (this.started) {
|
||||
await this.luaSendFeatures(event.updates.filter(feature => !feature.isDeleted));
|
||||
}
|
||||
const records = await instance.sendTo("controller", new messages.FeatureListRequest());
|
||||
await luaSendFeatures(records);
|
||||
}
|
||||
|
||||
/** Every value of each feature is sent, so the lua side sets them all */
|
||||
async luaSendFeatures(records: messages.FeatureRecord[]) {
|
||||
async function luaSendFeatures(records: messages.FeatureRecord[]) {
|
||||
if (!records.length) {
|
||||
return;
|
||||
}
|
||||
|
||||
const updates = records.map(record => {
|
||||
featureEnabled.set(record.id, record.enabled);
|
||||
const values: Record<string, FeatureValue> = { enabled: record.enabled };
|
||||
for (const field of features.find(feature => feature.name === record.id)?.fields ?? []) {
|
||||
values[field.name] = field.name in record.values ? record.values[field.name] : field.default;
|
||||
}
|
||||
return { name: record.id, values };
|
||||
});
|
||||
const json = JSON.stringify(updates);
|
||||
// Pick a long bracket the json does not contain
|
||||
let level = "=";
|
||||
while (json.includes(`]${level}]`)) {
|
||||
level += "=";
|
||||
await instance.sendRcon(`/sc exp_scenario.features.receive_update(${luaJson(updates)})`, true);
|
||||
}
|
||||
|
||||
/** Run lua with the player as `p` if they are still in the game, the data is available as `d` */
|
||||
async function luaWithPlayer(name: string, data: Record<string, unknown>, code: string) {
|
||||
if (instance.status !== "running") {
|
||||
return;
|
||||
}
|
||||
await this.instance.sendRcon(
|
||||
`/sc exp_scenario.features.receive_update(helpers.json_to_table[${level}[${json}]${level}])`, true,
|
||||
await instance.sendRcon(
|
||||
`/sc local d = ${luaJson({ ...data, name })} local p = game.get_player(d.name) if p then ${code} end`, true,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
export default async function (context: InstancePluginContext) {
|
||||
await InstancePlugin.fromContext(context);
|
||||
async function onPlayerJoin(name: string) {
|
||||
const record = await instance.sendTo("controller", new messages.PlayerGetRequest(name));
|
||||
if (record.joinMessage && featureEnabled.get("greetings") !== false) {
|
||||
await luaWithPlayer(name, { message: record.joinMessage }, "game.print(d.message, { color = p.color })");
|
||||
}
|
||||
if (record.toolbar) {
|
||||
await luaWithPlayer(
|
||||
name, { toolbar: record.toolbar }, "exp_scenario.player_settings.receive_toolbar(d.name, d.toolbar)",
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
instance.handle(messages.FeatureUpdatedEvent, async event => {
|
||||
if (started) {
|
||||
await luaSendFeatures(event.updates.filter(feature => !feature.isDeleted));
|
||||
}
|
||||
});
|
||||
|
||||
instance.server.handle("exp_scenario:join_message_set", async (event: IpcJoinMessageSet) => {
|
||||
const request = new messages.JoinMessageSetRequest(event.player_name, event.message ?? null);
|
||||
await instance.sendTo("controller", request);
|
||||
});
|
||||
|
||||
instance.server.handle("exp_scenario:join_message_get", async (event: IpcJoinMessageGet) => {
|
||||
const record = await instance.sendTo("controller", new messages.PlayerGetRequest(event.player_name));
|
||||
await luaWithPlayer(
|
||||
event.player_name,
|
||||
record.joinMessage ? { message: record.joinMessage } : {},
|
||||
"p.print(d.message and { \"exp_greetings.message-get\", d.message } or { \"exp_greetings.message-none\" })",
|
||||
);
|
||||
});
|
||||
|
||||
instance.server.handle("exp_scenario:locale", async (event: IpcLocale) => {
|
||||
instance.sendTo("controller", new messages.PlayerLocaleEvent(event.player_name, event.locale));
|
||||
});
|
||||
|
||||
instance.server.handle("exp_scenario:toolbar", async (event: IpcToolbar) => {
|
||||
instance.sendTo("controller", new messages.PlayerToolbarEvent(event.player_name, event.toolbar));
|
||||
});
|
||||
|
||||
instance.hooks.playerEvent.attach(plugin.name, async event => {
|
||||
if (event.type === "join") {
|
||||
await onPlayerJoin(event.name).catch(err => logger.error(
|
||||
`Error sending the settings of ${event.name}:\n${err.stack ?? err.message}`,
|
||||
));
|
||||
}
|
||||
});
|
||||
|
||||
instance.hooks.start.attach(plugin.name, async () => {
|
||||
started = true;
|
||||
await syncFeatures();
|
||||
});
|
||||
|
||||
instance.hooks.exit.attach(plugin.name, async () => {
|
||||
started = false;
|
||||
});
|
||||
|
||||
// A new session means the controller restarted and forgot the subscription
|
||||
instance.hooks.controllerConnectionEvent.attach(plugin.name, async event => {
|
||||
if (event === "connect" && started) {
|
||||
await syncFeatures();
|
||||
}
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* Country of each Factorio locale without a region in its code, used for the
|
||||
* flag. Languages spoken across many countries or without one, such as ar,
|
||||
* ca, eo, and eu, are left out and get no flag.
|
||||
*/
|
||||
const localeCountries: Record<string, string> = {
|
||||
af: "ZA", be: "BY", bg: "BG", cs: "CZ", da: "DK", de: "DE", el: "GR", en: "GB", et: "EE",
|
||||
fa: "IR", fi: "FI", fil: "PH", fr: "FR", he: "IL", hr: "HR", hu: "HU", id: "ID", is: "IS",
|
||||
it: "IT", ja: "JP", ka: "GE", kk: "KZ", ko: "KR", lt: "LT", lv: "LV", nl: "NL", no: "NO",
|
||||
pl: "PL", ro: "RO", ru: "RU", sk: "SK", sl: "SI", sq: "AL", sr: "RS", th: "TH", tr: "TR",
|
||||
uk: "UA", vi: "VN",
|
||||
};
|
||||
|
||||
/** Flag emoji for a Factorio locale such as "de" or "pt-BR", empty when it has no obvious country. */
|
||||
export function localeFlag(locale: string) {
|
||||
const [language, region] = locale.split("-");
|
||||
const country = region ?? localeCountries[language];
|
||||
if (!country || !/^[A-Z]{2}$/.test(country)) {
|
||||
return "";
|
||||
}
|
||||
// Regional indicator symbols start at U+1F1E6 for A
|
||||
return String.fromCodePoint(...[...country].map(letter => 0x1F1E6 + letter.charCodeAt(0) - 65));
|
||||
}
|
||||
|
||||
/** English name of a locale, the code itself when it is not known. */
|
||||
export function localeName(locale: string) {
|
||||
try {
|
||||
return new Intl.DisplayNames(["en"], { type: "language" }).of(locale) ?? locale;
|
||||
} catch {
|
||||
return locale;
|
||||
}
|
||||
}
|
||||
@@ -126,3 +126,187 @@ export class FeatureUpdateRequest {
|
||||
return new this(json.id, json.enabled, json.values);
|
||||
}
|
||||
}
|
||||
|
||||
/** Settings of a player kept by the controller, by player name. Only set values are stored. */
|
||||
export class PlayerRecord {
|
||||
constructor(
|
||||
/** Name of the player */
|
||||
public id: string,
|
||||
/** Shown to everyone when the player joins */
|
||||
public joinMessage?: string,
|
||||
/** The language of their game, such as "en" or "pt-BR" */
|
||||
public locale?: string,
|
||||
/** Toolbar state from Gui.toolbar.get_state, json compressed with helpers.encode_string */
|
||||
public toolbar?: string,
|
||||
public updatedAtMs: number = 0,
|
||||
public isDeleted: boolean = false,
|
||||
) {}
|
||||
|
||||
static jsonSchema = Type.Object({
|
||||
id: Type.String(),
|
||||
join_message: Type.Optional(Type.String()),
|
||||
locale: Type.Optional(Type.String()),
|
||||
toolbar: Type.Optional(Type.String()),
|
||||
updated_at_ms: Type.Optional(Type.Number()),
|
||||
is_deleted: Type.Optional(Type.Boolean()),
|
||||
});
|
||||
|
||||
toJSON() {
|
||||
const json: Static<typeof PlayerRecord.jsonSchema> = { id: this.id };
|
||||
if (this.joinMessage) {
|
||||
json.join_message = this.joinMessage;
|
||||
}
|
||||
if (this.locale) {
|
||||
json.locale = this.locale;
|
||||
}
|
||||
if (this.toolbar) {
|
||||
json.toolbar = this.toolbar;
|
||||
}
|
||||
if (this.updatedAtMs) {
|
||||
json.updated_at_ms = this.updatedAtMs;
|
||||
}
|
||||
if (this.isDeleted) {
|
||||
json.is_deleted = true;
|
||||
}
|
||||
return json;
|
||||
}
|
||||
|
||||
static fromJSON(json: Static<typeof this.jsonSchema>) {
|
||||
return new this(
|
||||
json.id,
|
||||
json.join_message,
|
||||
json.locale,
|
||||
json.toolbar,
|
||||
json.updated_at_ms ?? 0,
|
||||
json.is_deleted ?? false,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/** Users may always read their own settings, otherwise they need to be able to see users. */
|
||||
function selfOrPermission(permission: lib.PermissionName) {
|
||||
return (user: lib.IUser, message: lib.MessageRequest) => {
|
||||
const playerName = (message.data as { player_name: string }).player_name;
|
||||
if (user.name.toLowerCase() !== playerName.toLowerCase()) {
|
||||
user.checkPermission(permission);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/** Get the settings of a player, an empty record when nothing is stored. */
|
||||
export class PlayerGetRequest {
|
||||
declare ["constructor"]: typeof PlayerGetRequest;
|
||||
static plugin = "exp_scenario" as const;
|
||||
static type = "request" as const;
|
||||
static src = ["control", "instance"] as const;
|
||||
static dst = "controller" as const;
|
||||
static permission = selfOrPermission("core.user.get");
|
||||
static Response = PlayerRecord;
|
||||
|
||||
constructor(
|
||||
public playerName: string,
|
||||
) {}
|
||||
|
||||
static jsonSchema = Type.Object({
|
||||
player_name: Type.String(),
|
||||
});
|
||||
|
||||
toJSON() {
|
||||
return { player_name: this.playerName };
|
||||
}
|
||||
|
||||
static fromJSON(json: Static<typeof this.jsonSchema>) {
|
||||
return new this(json.player_name);
|
||||
}
|
||||
}
|
||||
|
||||
export const joinMessageMaxLength = 255;
|
||||
|
||||
/** Set or clear (null or empty) the join message of a player. */
|
||||
export class JoinMessageSetRequest {
|
||||
declare ["constructor"]: typeof JoinMessageSetRequest;
|
||||
static plugin = "exp_scenario" as const;
|
||||
static type = "request" as const;
|
||||
static src = ["control", "instance"] as const;
|
||||
static dst = "controller" as const;
|
||||
static permission(user: lib.IUser, message: lib.MessageRequest) {
|
||||
const playerName = (message.data as { player_name: string }).player_name;
|
||||
if (user.name.toLowerCase() === playerName.toLowerCase()) {
|
||||
user.checkPermission("exp_scenario.join_message.set");
|
||||
} else {
|
||||
user.checkPermission("exp_scenario.join_message.set_other");
|
||||
}
|
||||
}
|
||||
|
||||
constructor(
|
||||
public playerName: string,
|
||||
public message: string | null,
|
||||
) {}
|
||||
|
||||
static jsonSchema = Type.Object({
|
||||
player_name: Type.String(),
|
||||
message: Type.Union([Type.String({ maxLength: joinMessageMaxLength }), Type.Null()]),
|
||||
});
|
||||
|
||||
toJSON() {
|
||||
return { player_name: this.playerName, message: this.message };
|
||||
}
|
||||
|
||||
static fromJSON(json: Static<typeof this.jsonSchema>) {
|
||||
return new this(json.player_name, json.message);
|
||||
}
|
||||
}
|
||||
|
||||
/** The language a player's game uses, sent when they join and when they change it. */
|
||||
export class PlayerLocaleEvent {
|
||||
declare ["constructor"]: typeof PlayerLocaleEvent;
|
||||
static plugin = "exp_scenario" as const;
|
||||
static type = "event" as const;
|
||||
static src = "instance" as const;
|
||||
static dst = "controller" as const;
|
||||
|
||||
constructor(
|
||||
public playerName: string,
|
||||
public locale: string,
|
||||
) {}
|
||||
|
||||
static jsonSchema = Type.Object({
|
||||
player_name: Type.String(),
|
||||
locale: Type.String(),
|
||||
});
|
||||
|
||||
toJSON() {
|
||||
return { player_name: this.playerName, locale: this.locale };
|
||||
}
|
||||
|
||||
static fromJSON(json: Static<typeof this.jsonSchema>) {
|
||||
return new this(json.player_name, json.locale);
|
||||
}
|
||||
}
|
||||
|
||||
/** The toolbar of a player, sent when they leave. */
|
||||
export class PlayerToolbarEvent {
|
||||
declare ["constructor"]: typeof PlayerToolbarEvent;
|
||||
static plugin = "exp_scenario" as const;
|
||||
static type = "event" as const;
|
||||
static src = "instance" as const;
|
||||
static dst = "controller" as const;
|
||||
|
||||
constructor(
|
||||
public playerName: string,
|
||||
public toolbar: string,
|
||||
) {}
|
||||
|
||||
static jsonSchema = Type.Object({
|
||||
player_name: Type.String(),
|
||||
toolbar: Type.String(),
|
||||
});
|
||||
|
||||
toJSON() {
|
||||
return { player_name: this.playerName, toolbar: this.toolbar };
|
||||
}
|
||||
|
||||
static fromJSON(json: Static<typeof this.jsonSchema>) {
|
||||
return new this(json.player_name, json.toolbar);
|
||||
}
|
||||
}
|
||||
@@ -9,4 +9,4 @@ add_static("Gui", require("modules/exp_gui"))
|
||||
|
||||
add_static("Roles", require("modules/exp_roles"))
|
||||
add_static("Datastore", require("modules.exp_legacy.expcore.datastore"))
|
||||
add_static("External", require("modules.exp_legacy.expcore.external"))
|
||||
add_static("ExpServerList", require("modules/exp_server_list"))
|
||||
@@ -5,50 +5,56 @@ Adds a commands that allows you to request a player move to another server
|
||||
local Async = require("modules/exp_util/async")
|
||||
local Commands = require("modules/exp_commands")
|
||||
|
||||
local External = require("modules.exp_legacy.expcore.external") --- @dep expcore.external
|
||||
local request_connection_async = Async.register(External.request_connection)
|
||||
local ExpServerList = require("modules/exp_server_list")
|
||||
local request_connection_async = Async.register(ExpServerList.request_connection)
|
||||
|
||||
local concat = table.concat
|
||||
|
||||
--- Convert a server name into a server id, is not an Commands.InputParser because it does not accept addresses
|
||||
--- @param server string
|
||||
--- @return boolean, LocalisedString # True for success
|
||||
local function get_server_id(server)
|
||||
local servers = External.get_servers_filtered(server)
|
||||
local current_server = External.get_current_server()
|
||||
local current_version = current_server.version
|
||||
--- Find the one server matching a name, is not an Commands.InputParser because it does not accept addresses
|
||||
--- @param search string
|
||||
--- @return boolean, LocalisedString | ExpServerList.Server # True for success
|
||||
local function find_server(search)
|
||||
local current_server = ExpServerList.get_current() --- @cast current_server -nil
|
||||
local found = ExpServerList.find_servers(search)
|
||||
|
||||
local server_names_before, server_names = {}, {}
|
||||
local server_count_before, server_count = 0, 0
|
||||
for next_server_id, server_details in pairs(servers) do
|
||||
server_count_before = server_count_before + 1
|
||||
server_names_before[server_count_before] = server_details.name
|
||||
if server_details.version == current_version then
|
||||
server_count = server_count + 1
|
||||
server_names[server_count] = server_details.name
|
||||
else
|
||||
servers[next_server_id] = nil
|
||||
local names_all, names = {}, {}
|
||||
local matching = {} --- @type ExpServerList.Server[]
|
||||
for index, server in ipairs(found) do
|
||||
names_all[index] = server.name
|
||||
if server.factorio_version == current_server.factorio_version then
|
||||
matching[#matching + 1] = server
|
||||
names[#names + 1] = server.name
|
||||
end
|
||||
end
|
||||
|
||||
if server_count > 1 then
|
||||
return false, { "exp-commands_connect.too-many-matching", concat(server_names, ", ") }
|
||||
elseif server_count == 1 then
|
||||
local server_id, server_details = next(servers) --- @cast server_details -nil
|
||||
local status = External.get_server_status(server_id)
|
||||
if server_id == current_server.id then
|
||||
return false, { "exp-commands_connect.same-server", server_details.name }
|
||||
elseif status == "Offline" then
|
||||
return false, { "exp-commands_connect.offline", server_details.name }
|
||||
if #matching > 1 then
|
||||
return false, { "exp-commands_connect.too-many-matching", concat(names, ", ") }
|
||||
elseif #matching == 1 then
|
||||
local server = matching[1]
|
||||
if server.id == current_server.id then
|
||||
return false, { "exp-commands_connect.same-server", server.name }
|
||||
elseif not ExpServerList.is_online(server) then
|
||||
return false, { "exp-commands_connect.offline", server.name }
|
||||
end
|
||||
return true, server_id --[[@as string]]
|
||||
elseif server_count_before > 0 then
|
||||
return false, { "exp-commands_connect.wrong-version", concat(server_names_before, ", ") }
|
||||
return true, server
|
||||
elseif #found > 0 then
|
||||
return false, { "exp-commands_connect.wrong-version", concat(names_all, ", ") }
|
||||
else
|
||||
return false, { "exp-commands_connect.none-matching" }
|
||||
end
|
||||
end
|
||||
|
||||
--- Resolve the server argument to a server, or leave it as an address
|
||||
--- @param server string
|
||||
--- @param is_address boolean?
|
||||
--- @return boolean, LocalisedString | ExpServerList.Server | string # True for success
|
||||
local function resolve_server(server, is_address)
|
||||
if is_address or not ExpServerList.is_synced() then
|
||||
return true, server
|
||||
end
|
||||
return find_server(server)
|
||||
end
|
||||
|
||||
--- Connect to a different server
|
||||
Commands.new("connect", { "exp-commands_connect.description" })
|
||||
:argument("server", { "exp-commands_connect.arg-server" }, Commands.types.string)
|
||||
@@ -57,15 +63,12 @@ Commands.new("connect", { "exp-commands_connect.description" })
|
||||
:register(function(player, server, is_address)
|
||||
--- @cast server string
|
||||
--- @cast is_address boolean?
|
||||
if not is_address and External.valid() then
|
||||
local success, result = get_server_id(server)
|
||||
if not success then
|
||||
return Commands.status.invalid_input(result)
|
||||
end
|
||||
server = result
|
||||
local success, result = resolve_server(server, is_address)
|
||||
if not success then
|
||||
return Commands.status.invalid_input(result)
|
||||
end
|
||||
|
||||
request_connection_async(player, server, true)
|
||||
request_connection_async(player, result, true)
|
||||
end)
|
||||
|
||||
--- Connect another player to a different server
|
||||
@@ -78,15 +81,12 @@ Commands.new("connect-player", { "exp-commands_connect.description-player" })
|
||||
--- @cast other_player LuaPlayer
|
||||
--- @cast server string
|
||||
--- @cast is_address boolean?
|
||||
if not is_address and External.valid() then
|
||||
local success, result = get_server_id(server)
|
||||
if not success then
|
||||
return Commands.status.invalid_input(result)
|
||||
end
|
||||
server = result
|
||||
local success, result = resolve_server(server, is_address)
|
||||
if not success then
|
||||
return Commands.status.invalid_input(result)
|
||||
end
|
||||
|
||||
request_connection_async(other_player, server)
|
||||
request_connection_async(other_player, result)
|
||||
end)
|
||||
|
||||
--- Connect all players to a different server
|
||||
@@ -97,15 +97,12 @@ Commands.new("connect-all", { "exp-commands_connect.description-all" })
|
||||
:register(function(player, server, is_address)
|
||||
--- @cast server string
|
||||
--- @cast is_address boolean?
|
||||
if not is_address and External.valid() then
|
||||
local success, result = get_server_id(server)
|
||||
if not success then
|
||||
return Commands.status.invalid_input(result)
|
||||
end
|
||||
server = result
|
||||
local success, result = resolve_server(server, is_address)
|
||||
if not success then
|
||||
return Commands.status.invalid_input(result)
|
||||
end
|
||||
|
||||
for _, next_player in pairs(game.connected_players) do
|
||||
request_connection_async(next_player, server)
|
||||
request_connection_async(next_player, result)
|
||||
end
|
||||
end)
|
||||
@@ -4,7 +4,7 @@
|
||||
local ExpUtil = require("modules/exp_util")
|
||||
local Feature = require("modules/exp_scenario/features")
|
||||
local Async = require("modules/exp_util/async")
|
||||
local config_server_detail = require("modules.exp_legacy.config.server_detail") --- @dep config.server_detail
|
||||
local community_details = require("modules/exp_scenario/config/community_details").config
|
||||
|
||||
local floor = math.floor
|
||||
local random = math.random
|
||||
@@ -20,6 +20,15 @@ local send_message_async =
|
||||
end
|
||||
end)
|
||||
|
||||
--- Reply with a link from community_details, read when the reply is sent
|
||||
--- @param key string
|
||||
--- @return fun(): LocalisedString
|
||||
local function server_link(key)
|
||||
return function()
|
||||
return { "info." .. key, community_details[key] }
|
||||
end
|
||||
end
|
||||
|
||||
local afk_time_units = {
|
||||
minutes = true,
|
||||
seconds = true,
|
||||
@@ -28,13 +37,13 @@ local afk_time_units = {
|
||||
return Feature.register("chat_auto_reply", {
|
||||
--- @type table<string, LocalisedString | fun(player: LuaPlayer, is_command: boolean): LocalisedString>
|
||||
messages = { -- will trigger when ever the word is said
|
||||
["discord"] = { "info.discord", config_server_detail["discord"] },
|
||||
["expgaming"] = { "info.website", config_server_detail["website"] },
|
||||
["website"] = { "info.website", config_server_detail["website"] },
|
||||
["status"] = { "info.status", config_server_detail["status"] },
|
||||
["github"] = { "info.github", config_server_detail["github"] },
|
||||
["patreon"] = { "info.patreon", config_server_detail["patreon"] },
|
||||
["donate"] = { "info.patreon", config_server_detail["patreon"] },
|
||||
["discord"] = server_link("discord"),
|
||||
["expgaming"] = server_link("website"),
|
||||
["website"] = server_link("website"),
|
||||
["status"] = server_link("status"),
|
||||
["github"] = server_link("github"),
|
||||
["patreon"] = server_link("patreon"),
|
||||
["donate"] = server_link("patreon"),
|
||||
["command"] = { "info.custom-commands" },
|
||||
["commands"] = { "info.custom-commands" },
|
||||
["softmod"] = { "info.softmod" },
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
--- Names and links of the community, shown in chat, the readme, and the greeting
|
||||
-- @config Community-Details
|
||||
|
||||
local Feature = require("modules/exp_scenario/features")
|
||||
|
||||
--- The values are always used, disabling the feature changes nothing
|
||||
return Feature.register("community_details", {
|
||||
community_name = "Explosive Gaming",
|
||||
discord = "https://discord.explosivegaming.nl",
|
||||
website = "https://www.explosivegaming.nl",
|
||||
status = "https://status.explosivegaming.nl",
|
||||
github = "https://github.com/explosivegaming/ExpCluster",
|
||||
patreon = "https://www.patreon.com/ExpGaming",
|
||||
})
|
||||
@@ -52,11 +52,13 @@ add(require("modules/exp_scenario/control/discord_alerts"))
|
||||
add(require("modules/exp_scenario/control/features"))
|
||||
add(require("modules/exp_scenario/control/extra_logging"))
|
||||
add(require("modules/exp_scenario/control/fast_deconstruction"))
|
||||
add(require("modules/exp_scenario/control/greetings"))
|
||||
add(require("modules/exp_scenario/control/help_bubbles"))
|
||||
add(require("modules/exp_scenario/control/inserter_pickup"))
|
||||
add(require("modules/exp_scenario/control/inventory_clear"))
|
||||
add(require("modules/exp_scenario/control/mine_depletion"))
|
||||
add(require("modules/exp_scenario/control/nuke_protection"))
|
||||
add(require("modules/exp_scenario/control/player_settings"))
|
||||
add(require("modules/exp_scenario/control/pollution_grading"))
|
||||
add(require("modules/exp_scenario/control/popups"))
|
||||
add(require("modules/exp_scenario/control/protection"))
|
||||
|
||||
@@ -5,10 +5,14 @@ Makes trees which are marked for decon "decay" quickly to allow faster building
|
||||
local Gui = require("modules/exp_gui")
|
||||
local Async = require("modules/exp_util/async")
|
||||
local Roles = require("modules/exp_roles")
|
||||
local Storage = require("modules/exp_util/storage")
|
||||
|
||||
local PlayerData = require("modules.exp_legacy.expcore.player_data")
|
||||
local HasEnabledDecon = PlayerData.Settings:combine("HasEnabledDecon")
|
||||
HasEnabledDecon:set_default(false)
|
||||
--- Players who toggled fast decon on, by player index
|
||||
--- @type table<number, true>
|
||||
local enabled_players = {}
|
||||
Storage.register(enabled_players, function(tbl)
|
||||
enabled_players = tbl
|
||||
end)
|
||||
|
||||
local random = math.random
|
||||
local floor = math.floor
|
||||
@@ -58,7 +62,7 @@ local remove_trees_async =
|
||||
--- @return "fast" | "allow" | "disallow"
|
||||
local function get_permission(player)
|
||||
if Roles.player_has_permission(player, "exp_scenario.decon.fast_trees") then
|
||||
return HasEnabledDecon:get(player) and "fast" or "allow"
|
||||
return enabled_players[player.index] and "fast" or "allow"
|
||||
elseif Roles.player_has_permission(player, "exp_scenario.decon.standard") then
|
||||
return "allow"
|
||||
else
|
||||
@@ -105,7 +109,7 @@ Gui.toolbar.create_button{
|
||||
end
|
||||
}:on_click(function(def, player, element)
|
||||
local state = Gui.toolbar.get_button_toggled_state(def, player)
|
||||
HasEnabledDecon:set(player, state)
|
||||
enabled_players[player.index] = state or nil
|
||||
player.print{ "exp_fast-decon.chat-toggle", state and { "exp_fast-decon.chat-enabled" } or { "exp_fast-decon.chat-disabled" } }
|
||||
end)
|
||||
|
||||
@@ -164,8 +168,7 @@ local function on_entity_damaged(event)
|
||||
end
|
||||
|
||||
-- Mark the entity to be removed
|
||||
local allow = get_player_cache(driver.index)
|
||||
if allow == "fast" and HasEnabledDecon:get(driver) then
|
||||
if get_player_cache(driver.index).permission == "fast" then
|
||||
event.entity.destroy()
|
||||
else
|
||||
event.entity.order_deconstruction(event.force, driver)
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
--[[-- Control - Greetings
|
||||
Greets players when they join, and lets players set a message shown to everyone when they join
|
||||
|
||||
The join messages are kept by the controller, the instance plugin prints them when a player joins
|
||||
]]
|
||||
|
||||
local Commands = require("modules/exp_commands")
|
||||
local Feature = require("modules/exp_scenario/features")
|
||||
local clusterio_api = require("modules/clusterio/api")
|
||||
local community_details = require("modules/exp_scenario/config/community_details").config
|
||||
|
||||
local feature = Feature.register("greetings")
|
||||
|
||||
--- @param event EventData.on_player_joined_game
|
||||
local function on_player_joined_game(event)
|
||||
local player = assert(game.get_player(event.player_index))
|
||||
player.print{ "exp_greetings.greet", community_details.community_name, community_details.discord }
|
||||
end
|
||||
|
||||
--- Set your custom join message, or show it when no message is given
|
||||
Commands.new("set-join-message", { "exp_greetings.description-set" })
|
||||
:optional("message", { "exp_greetings.arg-message" }, Commands.types.string_max_length(255))
|
||||
:enable_auto_concatenation()
|
||||
:add_aliases{ "join-message" }
|
||||
:add_flags{ feature = feature }
|
||||
:register(function(player, message)
|
||||
--- @cast message string?
|
||||
if message then
|
||||
clusterio_api.send_json("exp_scenario:join_message_set", { player_name = player.name, message = message })
|
||||
return Commands.status.success{ "exp_greetings.message-set" }
|
||||
end
|
||||
-- The instance plugin prints the message
|
||||
clusterio_api.send_json("exp_scenario:join_message_get", { player_name = player.name })
|
||||
end)
|
||||
|
||||
--- Removes your custom join message
|
||||
Commands.new("remove-join-message", { "exp_greetings.description-remove" })
|
||||
:add_flags{ feature = feature }
|
||||
:register(function(player)
|
||||
clusterio_api.send_json("exp_scenario:join_message_set", { player_name = player.name })
|
||||
return Commands.status.success{ "exp_greetings.message-cleared" }
|
||||
end)
|
||||
|
||||
local e = defines.events
|
||||
|
||||
return feature:guard{
|
||||
events = {
|
||||
[e.on_player_joined_game] = on_player_joined_game,
|
||||
},
|
||||
}
|
||||
@@ -5,7 +5,7 @@ Adds friendly biters that walk around and give helpful messages
|
||||
local Async = require("modules/exp_util/async")
|
||||
local Storage = require("modules/exp_util/storage")
|
||||
local Feature = require("modules/exp_scenario/features")
|
||||
local config_server_detail = require("modules.exp_legacy.config.server_detail")
|
||||
local community_details = require("modules/exp_scenario/config/community_details").config
|
||||
|
||||
local feature = Feature.register("help_bubbles")
|
||||
|
||||
@@ -16,19 +16,22 @@ local locations = {
|
||||
["Spawn"] = {
|
||||
spawn_position = { x = 0, y = 0 },
|
||||
spawn_surface = "nauvis",
|
||||
entity_name = "behemoth-biter",
|
||||
messages = {
|
||||
{ "info.website", config_server_detail["website"] },
|
||||
{ "info.read-readme" },
|
||||
{ "info.discord", config_server_detail["discord"] },
|
||||
{ "info.softmod" },
|
||||
{ "info.redmew" },
|
||||
{ "info.custom-commands" },
|
||||
{ "info.status", config_server_detail["status"] },
|
||||
{ "info.lhd" },
|
||||
{ "info.github", config_server_detail["github"] },
|
||||
{ "info.patreon", config_server_detail["patreon"] },
|
||||
},
|
||||
entity_name = "small-biter",
|
||||
--- Built each cycle so changes to community_details show without a restart
|
||||
messages = function()
|
||||
return {
|
||||
{ "info.website", community_details.website },
|
||||
{ "info.read-readme" },
|
||||
{ "info.discord", community_details.discord },
|
||||
{ "info.softmod" },
|
||||
{ "info.redmew" },
|
||||
{ "info.custom-commands" },
|
||||
{ "info.status", community_details.status },
|
||||
{ "info.lhd" },
|
||||
{ "info.github", community_details.github },
|
||||
{ "info.patreon", community_details.patreon },
|
||||
}
|
||||
end,
|
||||
}
|
||||
|
||||
}
|
||||
@@ -41,7 +44,8 @@ end)
|
||||
|
||||
--- @class speech_bubble_task_param
|
||||
--- @field entity LuaEntity
|
||||
--- @field messages LocalisedString[]
|
||||
--- @field messages LocalisedString[]?
|
||||
--- @field location string? Used when there are no messages, a key of locations
|
||||
--- @field previous_message LuaEntity?
|
||||
--- @field current_message_index number
|
||||
|
||||
@@ -60,8 +64,9 @@ local speech_bubble_task =
|
||||
return Async.status.complete()
|
||||
end
|
||||
|
||||
local messages = task.messages or locations[task.location].messages()
|
||||
local index = task.current_message_index
|
||||
if index > #task.messages then
|
||||
if index > #messages then
|
||||
index = 1
|
||||
end
|
||||
|
||||
@@ -71,7 +76,7 @@ local speech_bubble_task =
|
||||
end
|
||||
|
||||
speech_bubble_param.source = entity
|
||||
speech_bubble_param.text = task.messages[index]
|
||||
speech_bubble_param.text = messages[index]
|
||||
task.previous_message = entity.surface.create_entity(speech_bubble_param)
|
||||
|
||||
task.current_message_index = index + 1
|
||||
@@ -114,7 +119,11 @@ local function check_persistent_locations()
|
||||
goto continue
|
||||
end
|
||||
|
||||
persistent_locations[name] = register_entity(entity, location.messages)
|
||||
persistent_locations[name] = speech_bubble_task{
|
||||
entity = entity,
|
||||
location = name,
|
||||
current_message_index = 1,
|
||||
}
|
||||
::continue::
|
||||
end
|
||||
end
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
--[[-- Control - Player Settings
|
||||
Sends settings of players to the controller, which keeps them between servers
|
||||
|
||||
The toolbar is sent compressed when a player leaves, the instance plugin
|
||||
calls receive_toolbar with it when they join again
|
||||
]]
|
||||
|
||||
local Gui = require("modules/exp_gui")
|
||||
local clusterio_api = require("modules/clusterio/api")
|
||||
|
||||
--- @param event EventData.on_player_joined_game | EventData.on_player_locale_changed
|
||||
local function send_locale(event)
|
||||
local player = assert(game.get_player(event.player_index))
|
||||
clusterio_api.send_json("exp_scenario:locale", { player_name = player.name, locale = player.locale })
|
||||
end
|
||||
|
||||
--- @param event EventData.on_player_left_game
|
||||
local function send_toolbar(event)
|
||||
local player = assert(game.get_player(event.player_index))
|
||||
local success, state = pcall(Gui.toolbar.get_state, player)
|
||||
if not success then
|
||||
log("[WARNING] Could not read the toolbar of " .. player.name .. ": " .. tostring(state))
|
||||
return
|
||||
end
|
||||
local toolbar = helpers.encode_string(helpers.table_to_json(state))
|
||||
clusterio_api.send_json("exp_scenario:toolbar", { player_name = player.name, toolbar = toolbar })
|
||||
end
|
||||
|
||||
--- @param toolbar string
|
||||
--- @return Gui.ToolbarState?
|
||||
local function decode_toolbar(toolbar)
|
||||
local json = helpers.decode_string(toolbar)
|
||||
local state = json and helpers.json_to_table(json)
|
||||
if type(state) == "table" and type(state.order) == "table" and type(state.open) == "table"
|
||||
and type(state.visible) == "boolean" then
|
||||
return state --[[@as Gui.ToolbarState]]
|
||||
end
|
||||
end
|
||||
|
||||
--- Restore the toolbar of a player, called over rcon by the instance plugin
|
||||
--- @param player_name string
|
||||
--- @param toolbar string From send_toolbar
|
||||
local function receive_toolbar(player_name, toolbar)
|
||||
local player = game.get_player(player_name)
|
||||
if not player or not player.connected then
|
||||
return
|
||||
end
|
||||
|
||||
-- Stored states can name buttons which no longer exist
|
||||
local success, err = pcall(function()
|
||||
local state = assert(decode_toolbar(toolbar), "invalid toolbar state")
|
||||
Gui.toolbar.set_state(player, state)
|
||||
end)
|
||||
if not success then
|
||||
log("[WARNING] Could not restore the toolbar of " .. player_name .. ": " .. tostring(err))
|
||||
end
|
||||
end
|
||||
|
||||
local e = defines.events
|
||||
|
||||
return {
|
||||
events = {
|
||||
[e.on_player_joined_game] = send_locale,
|
||||
[e.on_player_locale_changed] = send_locale,
|
||||
[e.on_player_left_game] = send_toolbar,
|
||||
},
|
||||
receive_toolbar = receive_toolbar,
|
||||
}
|
||||
@@ -3,4 +3,5 @@
|
||||
-- Access using `/sc exp_scenario.features.foo()`
|
||||
exp_scenario = {
|
||||
features = require("modules/exp_scenario/features"),
|
||||
player_settings = require("modules/exp_scenario/control/player_settings"),
|
||||
}
|
||||
@@ -7,8 +7,8 @@ local Gui = require("modules/exp_gui")
|
||||
local Roles = require("modules/exp_roles")
|
||||
local Commands = require("modules/exp_commands")
|
||||
local PlayerData = require("modules.exp_legacy.expcore.player_data")
|
||||
local External = require("modules.exp_legacy.expcore.external")
|
||||
local config_server_detail = require("modules.exp_legacy.config.server_detail") --- @dep config.server_detail
|
||||
local ExpServerList = require("modules/exp_server_list")
|
||||
local community = require("modules/exp_scenario/config/community_details").config
|
||||
|
||||
local format_number = require("util").format_number
|
||||
local format_time = ExpUtil.format_time_factory_locale{ format = "long", days = true, hours = true, minutes = true }
|
||||
@@ -16,16 +16,33 @@ local format_time = ExpUtil.format_time_factory_locale{ format = "long", days =
|
||||
local frame_width = 595
|
||||
local title_width = 270
|
||||
local scroll_height = 275
|
||||
local description_length = 120
|
||||
|
||||
--- Cut a string to a number of bytes without splitting a utf8 character
|
||||
--- @param str string
|
||||
--- @param length number
|
||||
--- @return string
|
||||
local function shorten(str, length)
|
||||
if #str <= length then
|
||||
return str
|
||||
end
|
||||
local next_byte = str:byte(length + 1)
|
||||
while length > 0 and next_byte >= 0x80 and next_byte < 0xC0 do
|
||||
length = length - 1
|
||||
next_byte = str:byte(length + 1)
|
||||
end
|
||||
return str:sub(1, length) .. "..."
|
||||
end
|
||||
|
||||
--- @class ExpGui_Readme.elements
|
||||
local Elements = {}
|
||||
|
||||
--- @type table<number, { caption: LocalisedString, tooltip: LocalisedString, element: ExpElement }>
|
||||
--- @type table<number, { caption: LocalisedString, tooltip: LocalisedString | (fun(): LocalisedString), element: ExpElement }>
|
||||
local tabs = {}
|
||||
|
||||
--- Register a readme tab
|
||||
--- @param caption LocalisedString
|
||||
--- @param tooltip LocalisedString
|
||||
--- @param tooltip LocalisedString | fun(): LocalisedString Functions are called when the readme opens
|
||||
--- @param element ExpElement
|
||||
local function define_tab(caption, tooltip, element)
|
||||
tabs[#tabs + 1] = { caption = caption, tooltip = tooltip, element = element }
|
||||
@@ -84,16 +101,17 @@ Elements.sub_content = Gui.define("readme/sub_content")
|
||||
} --[[@as any]]
|
||||
|
||||
--- @class ExpGui_Readme.elements.join_server.elements
|
||||
--- @field server_id string
|
||||
--- @field server_id number
|
||||
|
||||
--- Join server button
|
||||
--- @class ExpGui_Readme.elements.join_server: ExpElement
|
||||
--- @field data table<LuaGuiElement, ExpGui_Readme.elements.join_server.elements>
|
||||
--- @overload fun(parent: LuaGuiElement, server_id: string, wrong_version: string?): LuaGuiElement
|
||||
--- @overload fun(parent: LuaGuiElement, server: ExpServerList.Server): LuaGuiElement
|
||||
Elements.join_server = Gui.define("readme/join_server")
|
||||
:track_all_elements()
|
||||
:draw(function(def, parent, server_id, wrong_version)
|
||||
:draw(function(def, parent, server)
|
||||
--- @cast def ExpGui_Readme.elements.join_server
|
||||
--- @cast server ExpServerList.Server
|
||||
local flow = parent.add{
|
||||
type = "flow",
|
||||
}
|
||||
@@ -106,10 +124,10 @@ Elements.join_server = Gui.define("readme/join_server")
|
||||
}
|
||||
|
||||
def.data[button] = {
|
||||
server_id = server_id,
|
||||
server_id = server.id,
|
||||
}
|
||||
|
||||
Elements.join_server.refresh(button, wrong_version)
|
||||
Elements.join_server.refresh(button, server)
|
||||
return button
|
||||
end)
|
||||
:style{
|
||||
@@ -118,22 +136,33 @@ Elements.join_server = Gui.define("readme/join_server")
|
||||
}
|
||||
:on_click(function(def, player, button)
|
||||
--- @cast def ExpGui_Readme.elements.join_server
|
||||
local server_id = def.data[button].server_id
|
||||
External.request_connection(player, server_id, true)
|
||||
local server = ExpServerList.get_server(def.data[button].server_id)
|
||||
if server and ExpServerList.is_online(server) then
|
||||
ExpServerList.request_connection(player, server, true)
|
||||
end
|
||||
end) --[[@as any]]
|
||||
|
||||
--- Refresh join server button
|
||||
--- @param button LuaGuiElement
|
||||
--- @param wrong_version string?
|
||||
function Elements.join_server.refresh(button, wrong_version)
|
||||
local server_id = Elements.join_server.data[button].server_id
|
||||
local status = External.get_server_status(server_id) or "Offline"
|
||||
|
||||
if wrong_version then
|
||||
status = "Version"
|
||||
--- @param server ExpServerList.Server?
|
||||
function Elements.join_server.refresh(button, server)
|
||||
local current = ExpServerList.get_current()
|
||||
local status, detail = "Online", nil
|
||||
if not server or not ExpServerList.is_online(server) then
|
||||
status = "Offline"
|
||||
elseif current and server.id == current.id then
|
||||
status = "Current"
|
||||
elseif current and server.factorio_version ~= current.factorio_version then
|
||||
status, detail = "Version", server.factorio_version
|
||||
elseif server.has_password then
|
||||
status = "Password"
|
||||
elseif current and server.mod_pack_name ~= current.mod_pack_name then
|
||||
status, detail = "Modded", server.mod_pack_name
|
||||
end
|
||||
|
||||
button.tooltip = { "exp-gui_readme.servers-connect-" .. status, wrong_version }
|
||||
-- Factorio drops nil parameters, which would shift the player count into __1__
|
||||
local player_count = server and server.player_count or 0
|
||||
button.tooltip = { "exp-gui_readme.servers-connect-" .. status, detail or "", player_count }
|
||||
|
||||
if status == "Offline" or status == "Current" then
|
||||
button.enabled = false
|
||||
@@ -162,40 +191,35 @@ function Elements.join_server.refresh(button, wrong_version)
|
||||
end
|
||||
end
|
||||
|
||||
--- Refresh all online join buttons
|
||||
--- Refresh all join buttons
|
||||
function Elements.join_server.refresh_all()
|
||||
if not External.valid() then
|
||||
return
|
||||
end
|
||||
|
||||
local current_version = External.get_current_server().version
|
||||
|
||||
for _, button in Elements.join_server:tracked_elements() do
|
||||
local server_id = Elements.join_server.data[button].server_id
|
||||
local server = External.get_servers()[server_id]
|
||||
|
||||
if server then
|
||||
Elements.join_server.refresh(button, current_version ~= server.version and server.version or nil)
|
||||
end
|
||||
Elements.join_server.refresh(button, ExpServerList.get_server(server_id))
|
||||
end
|
||||
end
|
||||
|
||||
--- Welcome tab
|
||||
define_tab(
|
||||
{ "exp-gui_readme.welcome-tab" },
|
||||
{ "exp-gui_readme.welcome-tooltip", config_server_detail["community_name"] },
|
||||
function() return { "exp-gui_readme.welcome-tooltip", community.community_name } end,
|
||||
Gui.define("readme/welcome")
|
||||
:draw(function(_, parent)
|
||||
local player = Gui.get_player(parent)
|
||||
|
||||
local server_details = {
|
||||
name = config_server_detail["community_name"] .. " S0 - Local",
|
||||
welcome = "Failed to load description: disconnected from external api.",
|
||||
name = community.community_name .. " S0 - Local",
|
||||
welcome = "Failed to load description: disconnected from the controller.",
|
||||
reset_time = "Not Set",
|
||||
}
|
||||
|
||||
if External.valid() then
|
||||
server_details = External.get_current_server()
|
||||
local current = ExpServerList.get_current()
|
||||
if current then
|
||||
server_details = {
|
||||
name = current.name,
|
||||
welcome = current.welcome ~= "" and current.welcome or { "exp-gui_readme.welcome-default" },
|
||||
reset_time = current.reset_time ~= "" and current.reset_time or "Not Set",
|
||||
}
|
||||
end
|
||||
|
||||
local container = parent.add{ type = "flow", direction = "vertical" }
|
||||
@@ -206,7 +230,7 @@ define_tab(
|
||||
local center_flow = top_flow.add{ type = "flow", direction = "vertical" }
|
||||
center_flow.style.horizontal_align = "center"
|
||||
|
||||
Gui.elements.title_label(center_flow, 62, { "exp-gui_readme.welcome-title", server_details.name })
|
||||
Gui.elements.centered_label(center_flow, 380, { "exp-gui_readme.welcome-title", server_details.name })
|
||||
Gui.elements.centered_label(center_flow, 380, server_details.welcome)
|
||||
|
||||
top_flow.add{ type = "sprite", sprite = "file/modules/exp_scenario/gui/logo.png" }
|
||||
@@ -224,7 +248,7 @@ define_tab(
|
||||
frame_width,
|
||||
{
|
||||
"exp-gui_readme.welcome-general",
|
||||
config_server_detail["community_name"],
|
||||
community.community_name,
|
||||
format_time(game.tick),
|
||||
server_details.reset_time,
|
||||
}
|
||||
@@ -317,28 +341,19 @@ define_tab(
|
||||
local scroll_pane = Elements.title_table_scroll(container)
|
||||
scroll_pane.style.maximal_height = scroll_height + 20
|
||||
|
||||
if External.valid() then
|
||||
local current_version = External.get_current_server().version
|
||||
|
||||
local factorio_servers = Elements.title_table(scroll_pane, 225, { "exp-gui_readme.servers-factorio" }, 3)
|
||||
|
||||
for server_id, server in pairs(External.get_servers()) do
|
||||
Gui.elements.centered_label(factorio_servers, 110, server.short_name)
|
||||
Gui.elements.centered_label(factorio_servers, 436, server.description)
|
||||
Elements.join_server(factorio_servers, server_id, current_version ~= server.version and server.version or nil)
|
||||
end
|
||||
else
|
||||
local factorio_servers = Elements.title_table(scroll_pane, 225, { "exp-gui_readme.servers-factorio" }, 2)
|
||||
for i = 1, 8 do
|
||||
Gui.elements.centered_label(factorio_servers, 110, { "exp-gui_readme.servers-" .. i })
|
||||
Gui.elements.centered_label(factorio_servers, 460, { "exp-gui_readme.servers-d" .. i })
|
||||
end
|
||||
local factorio_servers = Elements.title_table(scroll_pane, 225, { "exp-gui_readme.servers-factorio" }, 3)
|
||||
for _, server in ipairs(ExpServerList.get_servers()) do
|
||||
local description = shorten(server.description, description_length)
|
||||
local tooltip = description ~= server.description and server.description or nil
|
||||
Gui.elements.centered_label(factorio_servers, 110, server.display_name)
|
||||
Gui.elements.centered_label(factorio_servers, 436, description, tooltip)
|
||||
Elements.join_server(factorio_servers, server)
|
||||
end
|
||||
|
||||
local external_links = Elements.title_table(scroll_pane, 235, { "exp-gui_readme.servers-external" }, 2)
|
||||
for _, key in ipairs{ "discord", "website", "patreon", "status", "github" } do
|
||||
Gui.elements.centered_label(external_links, 110, key:gsub("^%l", string.upper))
|
||||
Gui.elements.centered_label(external_links, 460, config_server_detail[key], { "exp-gui_readme.servers-open-in-browser" })
|
||||
Gui.elements.centered_label(external_links, 460, community[key], { "exp-gui_readme.servers-open-in-browser" })
|
||||
end
|
||||
|
||||
return container
|
||||
@@ -636,11 +651,16 @@ Elements.container = Gui.define("readme/container")
|
||||
}
|
||||
|
||||
for _, tab in ipairs(tabs) do
|
||||
local tooltip = tab.tooltip
|
||||
if type(tooltip) == "function" then
|
||||
tooltip = tooltip()
|
||||
end
|
||||
|
||||
local gui_tab = pane.add{
|
||||
type = "tab",
|
||||
style = "frame_tab",
|
||||
caption = tab.caption,
|
||||
tooltip = tab.tooltip,
|
||||
tooltip = tooltip,
|
||||
}
|
||||
|
||||
pane.add_tab(gui_tab, tab.element(pane))
|
||||
@@ -707,8 +727,6 @@ return {
|
||||
[e.on_player_created] = open_readme,
|
||||
[e.on_player_joined_game] = clear_readme,
|
||||
[e.on_player_respawned] = clear_readme,
|
||||
[ExpServerList.on_servers_updated] = Elements.join_server.refresh_all,
|
||||
},
|
||||
on_nth_tick = {
|
||||
[60 * 60] = Elements.join_server.refresh_all,
|
||||
}
|
||||
}
|
||||
@@ -320,6 +320,7 @@ main-tooltip=Information
|
||||
welcome-tab=Welcome
|
||||
welcome-tooltip=Welcome to __1__
|
||||
welcome-title=Welcome to __1__
|
||||
welcome-default=Thanks for playing on our server, we hope you enjoy your stay.
|
||||
welcome-general=Welcome to __1__; we host many Factorio servers. While you are here, we ask you to follow our rules. You can find these in the tab above. You can also find our custom commands and links to our other servers. This map has been online for __2__.\nPlease note that our servers reset periodically, the next reset is: __3__
|
||||
welcome-roles=We run a custom role system to help protect the work of others. As a result you may not be able to use your deconstruction planner yet or drop items on the ground. Roles also give you access to some custom features such as adding tasks to our task list or making new warp points.\nYou have been assigned the roles: __1__
|
||||
welcome-chat=Chatting can be difficult for new players because it’s different than other games! It’s very simple, the button you need to press is the “GRAVE/TILDE” key (which is located under the “ESC key”). If you would like to change the key, go to your Controls tab in options.\nThe setting you need to change is “Toggle chat (and Lua console)” you currently have it set to "__CONTROL__toggle-console__"
|
||||
@@ -350,28 +351,12 @@ servers-general=This is only one of our Factorio servers, we host many others as
|
||||
servers-factorio=Factorio Servers
|
||||
servers-external=External Links
|
||||
servers-open-in-browser=Open in your browser
|
||||
servers-1=S1 Public
|
||||
servers-d1=This is our 48 hour reset server.
|
||||
servers-2=S2 Off
|
||||
servers-d2=This server is closed.
|
||||
servers-3=S3 Weekly
|
||||
servers-d3=This is our weekly reset server.
|
||||
servers-4=S4 Monthly
|
||||
servers-d4=This is our monthly reset server.
|
||||
servers-5=S5 Modded
|
||||
servers-d5=This is our modded server, see Discord for details.
|
||||
servers-6=S6 Donator
|
||||
servers-d6=This is our donator only server, online when requested.
|
||||
servers-7=S7 Event
|
||||
servers-d7=This is our event server, we try to run events at least once per week.
|
||||
servers-8=S8 T̷-̶s̶-̴:̷
|
||||
servers-d8=N̵o̴ ̶o̷-̶e̵ ̴k̸n̷-̶w̵s̸ ̴w̷h̷a̶-̶ ̷h̴a̴p̷p̴e̷n̷s̸ ̷o̶n̴ ̷t̶h̴-̶s̶ ̷s̷e̶r̸v̸e̴r̷,̶ ̸i̸t̴ ̷m̶-̸g̴h̶t̷ ̸n̸-̶t̵ ̷e̴v̸e̸n̶t̷ ̵-̷x̴i̵s̶t̸.̸
|
||||
servers-connect-Offline=Server is currently offline
|
||||
servers-connect-Current=This is your current server
|
||||
servers-connect-Version=Server is on a different version: __1__
|
||||
servers-connect-Password=Server requires a password
|
||||
servers-connect-Modded=Server requires mods to be downloaded
|
||||
servers-connect-Online=Server is online
|
||||
servers-connect-Password=Server requires a password\nPlayers online: __2__
|
||||
servers-connect-Modded=Server uses the __1__ mod pack, mods may need to be downloaded\nPlayers online: __2__
|
||||
servers-connect-Online=Server is online\nPlayers online: __2__
|
||||
backers-tab=Backers
|
||||
backers-tooltip=People who have helped make our server
|
||||
backers-general=We would like to thank all our staff and backers who have helped our community grow. Our staff have helped to keep our servers safe from trolls and a fun place to play. Our backers have helped us to cover our running costs and provide a great community for us all to enjoy together.
|
||||
@@ -601,6 +586,16 @@ chat-enabled=enabled
|
||||
chat-disabled=disabled
|
||||
chat-toggle=Fast decon has been __1__
|
||||
|
||||
[exp_greetings]
|
||||
description-set=Sets / Gets your custom join message.
|
||||
description-remove=Removes you custom join message.
|
||||
arg-message=Your custom join message.
|
||||
greet=[color=0,1,0] Welcome to __1__ community server! If you like the server join our discord: __2__ [/color]
|
||||
message-set=Your join message has been updated.
|
||||
message-get=Your join message is: __1__
|
||||
message-cleared=Your join message has been cleared.
|
||||
message-none=You have not set a join message.
|
||||
|
||||
[exp_nuke-protection]
|
||||
chat-found=You cannot have __1__ in your inventory, so it was placed into the chests at spawn.
|
||||
|
||||
|
||||
@@ -339,22 +339,6 @@ servers-tab=伺服器
|
||||
servers-tooltip=到其他伺服器及網站的連結
|
||||
servers-general=這是其中一個伺服器。你可以在下方找到其他同樣是由我們運行的伺服器資料。
|
||||
servers-factorio=異星工廠伺服器
|
||||
servers-1=S1 公共
|
||||
servers-d1=這個服務器每兩日重設。
|
||||
servers-2=S2 -
|
||||
servers-d2=這個服務器沒在營運。
|
||||
servers-3=S3 周
|
||||
servers-d3=這個服務器每週重設。
|
||||
servers-4=S4 月
|
||||
servers-d4=這個服務器每月重設。
|
||||
servers-5=S5 模組
|
||||
servers-d5=這個服務器運行模組,可在 Discord 中得到更多資訊。
|
||||
servers-6=S6 Donator
|
||||
servers-d6=這個服務器為支持者運行,可在 Discord 中得到更多資訊。
|
||||
servers-7=S7 項目
|
||||
servers-d7=這個服務器只在有項目期間運行。
|
||||
servers-8=S8 T̷-̶s̶-̴:̷
|
||||
servers-d8=N̵o̴ ̶o̷-̶e̵ ̴k̸n̷-̶w̵s̸ ̴w̷h̷a̶-̶ ̷h̴a̴p̷p̴e̷n̷s̸ ̷o̶n̴ ̷t̶h̴-̶s̶ ̷s̷e̶r̸v̸e̴r̷,̶ ̸i̸t̴ ̷m̶-̸g̴h̶t̷ ̸n̸-̶t̵ ̷e̴v̸e̸n̶t̷ ̵-̷x̴i̵s̶t̸。̸
|
||||
servers-connect-Offline=該服務器目前沒有在運行
|
||||
servers-connect-Current=你目前所在的伺服器
|
||||
servers-connect-Version=該服務器運行不同的遊戲版本: __1__
|
||||
@@ -594,6 +578,16 @@ chat-enabled=啟用
|
||||
chat-disabled=停用
|
||||
chat-toggle=樹木快速拆除已 __1__
|
||||
|
||||
[exp_greetings]
|
||||
description-set=設定 / 取得你的加入信息。
|
||||
description-remove=移除你的加入信息。
|
||||
arg-message=你的加入信息。
|
||||
greet=[color=0,1,0] 歡迎來到 __1__ 的服務器! 若果你喜歡本服務器可加入 Discord: __2__ [/color]
|
||||
message-set=你的加入信息已更新。
|
||||
message-get=你的加入信息為: __1__
|
||||
message-cleared=你的加入信息已清除。
|
||||
message-none=你沒有設定加入信息。
|
||||
|
||||
[exp_nuke-protection]
|
||||
chat-found=你的用戶組不允許你有 __1__ ,所以該物品已放在出生點的箱子。
|
||||
|
||||
|
||||
@@ -339,22 +339,6 @@ servers-tab=伺服器
|
||||
servers-tooltip=到其他伺服器及網站的連結
|
||||
servers-general=這是其中一個伺服器。你可以在下方找到其他同樣是由我們運行的伺服器資料。
|
||||
servers-factorio=異星工廠伺服器
|
||||
servers-1=S1 公共
|
||||
servers-d1=這個服務器每兩日重設。
|
||||
servers-2=S2 -
|
||||
servers-d2=這個服務器沒在營運。
|
||||
servers-3=S3 周
|
||||
servers-d3=這個服務器每週重設。
|
||||
servers-4=S4 月
|
||||
servers-d4=這個服務器每月重設。
|
||||
servers-5=S5 模組
|
||||
servers-d5=這個服務器運行模組,可在 Discord 中得到更多資訊。
|
||||
servers-6=S6 Donator
|
||||
servers-d6=這個服務器為支持者運行,可在 Discord 中得到更多資訊。
|
||||
servers-7=S7 項目
|
||||
servers-d7=這個服務器只在有項目期間運行。
|
||||
servers-8=S8 T̷-̶s̶-̴:̷
|
||||
servers-d8=N̵o̴ ̶o̷-̶e̵ ̴k̸n̷-̶w̵s̸ ̴w̷h̷a̶-̶ ̷h̴a̴p̷p̴e̷n̷s̸ ̷o̶n̴ ̷t̶h̴-̶s̶ ̷s̷e̶r̸v̸e̴r̷,̶ ̸i̸t̴ ̷m̶-̸g̴h̶t̷ ̸n̸-̶t̵ ̷e̴v̸e̸n̶t̷ ̵-̷x̴i̵s̶t̸。̸
|
||||
servers-connect-Offline=該服務器目前沒有在運行
|
||||
servers-connect-Current=你目前所在的伺服器
|
||||
servers-connect-Version=該服務器運行不同的遊戲版本: __1__
|
||||
@@ -594,6 +578,16 @@ chat-enabled=啟用
|
||||
chat-disabled=停用
|
||||
chat-toggle=樹木快速拆除已 __1__
|
||||
|
||||
[exp_greetings]
|
||||
description-set=設定 / 取得你的加入信息。
|
||||
description-remove=移除你的加入信息。
|
||||
arg-message=你的加入信息。
|
||||
greet=[color=0,1,0] 歡迎來到 __1__ 的服務器! 若果你喜歡本服務器可加入 Discord: __2__ [/color]
|
||||
message-set=你的加入信息已更新。
|
||||
message-get=你的加入信息為: __1__
|
||||
message-cleared=你的加入信息已清除。
|
||||
message-none=你沒有設定加入信息。
|
||||
|
||||
[exp_nuke-protection]
|
||||
chat-found=你的用戶組不允許你有 __1__ ,所以該物品已放在出生點的箱子。
|
||||
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
"exp_util": "*",
|
||||
"exp_roles": "*",
|
||||
"exp_reports": "*",
|
||||
"exp_server_list": "*",
|
||||
"exp_gui": "*",
|
||||
"exp_commands": "*"
|
||||
}
|
||||
|
||||
@@ -13,13 +13,21 @@
|
||||
"coverage": "tap --coverage-report=text test/*.test.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18"
|
||||
"node": ">=22"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@clusterio/controller": "workspace:^",
|
||||
"@clusterio/host": "workspace:^",
|
||||
"@clusterio/lib": "workspace:^"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@clusterio/controller": {
|
||||
"optional": true
|
||||
},
|
||||
"@clusterio/host": {
|
||||
"optional": true
|
||||
}
|
||||
},
|
||||
"devDependencies": {
|
||||
"@clusterio/controller": "workspace:^",
|
||||
"@clusterio/host": "workspace:^",
|
||||
@@ -43,6 +51,7 @@
|
||||
"@expcluster/lib_gui": "workspace:^",
|
||||
"@expcluster/permission-groups": "workspace:^",
|
||||
"@expcluster/roles": "workspace:^",
|
||||
"@expcluster/server-list": "workspace:^",
|
||||
"@sinclair/typebox": "catalog:"
|
||||
},
|
||||
"publishConfig": {
|
||||
|
||||
@@ -87,6 +87,7 @@ export const seedRoles: SeedRole[] = [
|
||||
"exp_scenario.command.tag_clear.always",
|
||||
"exp_scenario.command.spawn.always",
|
||||
"exp_scenario.command.clear_reports",
|
||||
"exp_scenario.join_message.set_other",
|
||||
"exp_scenario.command.clear_inventory",
|
||||
"exp_scenario.command.kill_enemies",
|
||||
"exp_scenario.command.remove_enemies",
|
||||
@@ -193,6 +194,7 @@ export const seedRoles: SeedRole[] = [
|
||||
"exp_scenario.command.unjail",
|
||||
"exp_scenario.command.set_join_message",
|
||||
"exp_scenario.command.remove_join_message",
|
||||
"exp_scenario.join_message.set",
|
||||
],
|
||||
},
|
||||
{
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
import t from "tap";
|
||||
import path from "node:path";
|
||||
import * as lib from "@clusterio/lib";
|
||||
import { Controller } from "@clusterio/controller";
|
||||
import { ControllerPlugin } from "../dist/node/controller.js";
|
||||
import entrypoint from "../dist/node/controller.js";
|
||||
import * as messages from "../dist/node/messages.js";
|
||||
import { seedRoles, seedGroups } from "../dist/node/seed.js";
|
||||
import { features } from "../dist/node/features.js";
|
||||
@@ -29,7 +30,7 @@ t.after(() => {
|
||||
lib.logger.silent = false;
|
||||
});
|
||||
|
||||
/** Build the plugin around a real controller, which is side effect free while not started. */
|
||||
/** Run the plugin on a real controller, which is side effect free while not started, returns the handlers it registered. */
|
||||
async function startPlugin(t2, { withPlugins = true, databaseDirectory = t2.testdir() } = {}) {
|
||||
const controllerConfig = new lib.ControllerConfig("controller", {
|
||||
"controller.database_directory": databaseDirectory,
|
||||
@@ -45,42 +46,77 @@ async function startPlugin(t2, { withPlugins = true, databaseDirectory = t2.test
|
||||
}
|
||||
}
|
||||
|
||||
const plugin = await ControllerPlugin.fromContext({ plugin: { name: "exp_scenario" }, controller, logger });
|
||||
return { plugin, controller };
|
||||
const handlers = new Map();
|
||||
const handle = controller.handle.bind(controller);
|
||||
controller.handle = (Class, handler) => {
|
||||
handlers.set(Class, handler);
|
||||
handle(Class, handler);
|
||||
};
|
||||
const subscriptionHandle = controller.subscriptions.handle.bind(controller.subscriptions);
|
||||
controller.subscriptions.handle = (Class, handler) => {
|
||||
handlers.set(Class, handler);
|
||||
subscriptionHandle(Class, handler);
|
||||
};
|
||||
|
||||
await entrypoint({ plugin: { name: "exp_scenario" }, controller, logger });
|
||||
return {
|
||||
controller,
|
||||
seed: () => handlers.get(messages.SeedRequest)(new messages.SeedRequest()),
|
||||
listFeatures: () => handlers.get(messages.FeatureListRequest)(new messages.FeatureListRequest()),
|
||||
updateFeature: request => handlers.get(messages.FeatureUpdateRequest)(request),
|
||||
featureSubscription: request => handlers.get(messages.FeatureUpdatedEvent)(request),
|
||||
shutdown: () => controller.hooks.shutdown.invoke(),
|
||||
save: () => controller.hooks.save.invoke(),
|
||||
/** Call the handler of a message as it would be called for a request or event */
|
||||
send: message => handlers.get(message.constructor)(message),
|
||||
};
|
||||
}
|
||||
|
||||
/** Write the stored features as a previous run would have left them. */
|
||||
async function storeFeatures(databaseDirectory, records) {
|
||||
await new lib.JsonIdDatastoreProvider(
|
||||
path.join(databaseDirectory, "exp_scenario", "features.json"),
|
||||
messages.FeatureRecord.fromJSON.bind(messages.FeatureRecord),
|
||||
).save(new Map(records.map(record => [record.id, record])));
|
||||
}
|
||||
|
||||
/** The feature record with the given id. */
|
||||
async function getFeature(listFeatures, id) {
|
||||
return (await listFeatures()).find(record => record.id === id);
|
||||
}
|
||||
|
||||
const byName = (datastore, name) => [...datastore.values()].find(other => other.name === name);
|
||||
|
||||
t.test("class ControllerPlugin", t2 => {
|
||||
t2.test(".handleSeedRequest() throws when the seeded plugins are missing", async t3 => {
|
||||
const { plugin } = await startPlugin(t3, { withPlugins: false });
|
||||
t.test("controller plugin", t2 => {
|
||||
t2.test("SeedRequest throws when the seeded plugins are missing", async t3 => {
|
||||
const { seed } = await startPlugin(t3, { withPlugins: false });
|
||||
await t3.rejects(
|
||||
plugin.handleSeedRequest(),
|
||||
seed(),
|
||||
{ message: "Seeding requires the exp_roles and exp_groups plugins" },
|
||||
"the request is rejected",
|
||||
);
|
||||
});
|
||||
|
||||
t2.test(".handleSeedRequest() creates the roles and reuses them by name", async t3 => {
|
||||
const { plugin, controller } = await startPlugin(t3);
|
||||
t2.test("SeedRequest creates the roles and reuses them by name", async t3 => {
|
||||
const { seed, controller } = await startPlugin(t3);
|
||||
const rolesPlugin = RolesPlugin.get(controller);
|
||||
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
t3.strictSame(controller.roles.size, seedRoles.length, "every seed role exists");
|
||||
|
||||
const moderator = byName(controller.roles, "Moderator");
|
||||
t3.ok(moderator.permissions.has("exp_scenario.command.jail"), "parent permissions are flattened in");
|
||||
t3.strictSame(rolesPlugin.roleMeta.get(moderator.id).shortHand, "Mod", "the role properties match the seed");
|
||||
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
t3.strictSame(controller.roles.size, seedRoles.length, "seeding again reuses the roles");
|
||||
});
|
||||
|
||||
t2.test(".handleSeedRequest() creates the groups and resets them by name", async t3 => {
|
||||
const { plugin, controller } = await startPlugin(t3);
|
||||
t2.test("SeedRequest creates the groups and resets them by name", async t3 => {
|
||||
const { seed, controller } = await startPlugin(t3);
|
||||
const groupsPlugin = GroupsPlugin.get(controller);
|
||||
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
t3.strictSame(groupsPlugin.groups.size, seedGroups.length, "every seed group exists");
|
||||
|
||||
const restricted = byName(groupsPlugin.groups, "Restricted");
|
||||
@@ -89,7 +125,7 @@ t.test("class ControllerPlugin", t2 => {
|
||||
|
||||
const admin = byName(groupsPlugin.groups, "Admin");
|
||||
groupsPlugin.groups.set(new GroupRecord(admin.id, admin.name, new GroupPermissions(true, [])));
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
t3.strictSame(groupsPlugin.groups.size, seedGroups.length, "seeding again reuses the groups");
|
||||
t3.ok(
|
||||
byName(groupsPlugin.groups, "Admin").permissions.permissions.includes("toggle_map_editor"),
|
||||
@@ -97,11 +133,11 @@ t.test("class ControllerPlugin", t2 => {
|
||||
);
|
||||
});
|
||||
|
||||
t2.test(".handleSeedRequest() maps each role onto its group by rank", async t3 => {
|
||||
const { plugin, controller } = await startPlugin(t3);
|
||||
t2.test("SeedRequest maps each role onto its group by rank", async t3 => {
|
||||
const { seed, controller } = await startPlugin(t3);
|
||||
const groupsPlugin = GroupsPlugin.get(controller);
|
||||
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
const mapped = seedRoles.filter(role => role.group !== undefined);
|
||||
t3.strictSame(groupsPlugin.roleMappings.size, mapped.length, "every role with a group is mapped");
|
||||
|
||||
@@ -119,76 +155,180 @@ t.test("class ControllerPlugin", t2 => {
|
||||
t3.strictSame(priorities.length, new Set(priorities).size, "priorities are unique");
|
||||
});
|
||||
|
||||
t2.test(".handleSeedRequest() reuses mappings and keeps clear of other mappings", async t3 => {
|
||||
const { plugin, controller } = await startPlugin(t3);
|
||||
t2.test("SeedRequest reuses mappings and keeps clear of other mappings", async t3 => {
|
||||
const { seed, controller } = await startPlugin(t3);
|
||||
const groupsPlugin = GroupsPlugin.get(controller);
|
||||
|
||||
groupsPlugin.roleMappings.set(new RoleMappingRecord(99, new Set([0, 1]), 5, 2, true));
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
const first = new Map([...groupsPlugin.roleMappings.values()].map(mapping => [mapping.id, mapping.priority]));
|
||||
|
||||
await plugin.handleSeedRequest();
|
||||
await seed();
|
||||
const second = new Map([...groupsPlugin.roleMappings.values()].map(mapping => [mapping.id, mapping.priority]));
|
||||
t3.strictSame(second, first, "seeding again reuses the mappings");
|
||||
t3.strictSame(groupsPlugin.roleMappings.get(99).priority, 2, "other mappings are left alone");
|
||||
t3.notOk([...first.values()].filter(priority => priority === 2).length > 1, "seed priorities skip taken ones");
|
||||
});
|
||||
|
||||
t2.test(".fromContext() adds every feature with its defaults", async t3 => {
|
||||
const { plugin } = await startPlugin(t3, { withPlugins: false });
|
||||
const records = await plugin.handleFeatureListRequest();
|
||||
t2.test("startup adds every feature with its defaults", async t3 => {
|
||||
const { listFeatures } = await startPlugin(t3, { withPlugins: false });
|
||||
const records = await listFeatures();
|
||||
t3.strictSame(records.map(record => record.id), features.map(feature => feature.name), "one record per feature");
|
||||
t3.ok(records.every(record => record.enabled && !Object.keys(record.values).length), "enabled with no overrides");
|
||||
});
|
||||
|
||||
t2.test(".reconcileFeatures() drops stored values and features which no longer exist", async t3 => {
|
||||
t2.test("startup drops stored values and features which no longer exist", async t3 => {
|
||||
const databaseDirectory = t3.testdir();
|
||||
const { plugin } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
plugin.features.set(new messages.FeatureRecord("afk_kick", false, { afk_minutes: 5, trust_time: 600 }));
|
||||
plugin.features.set(new messages.FeatureRecord("gone", true, {}));
|
||||
await plugin.onShutdown();
|
||||
await storeFeatures(databaseDirectory, [
|
||||
new messages.FeatureRecord("afk_kick", false, { afk_minutes: 5, trust_time: 600 }),
|
||||
new messages.FeatureRecord("gone", true, {}),
|
||||
]);
|
||||
|
||||
const { plugin: restarted } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
const record = restarted.features.get("afk_kick");
|
||||
const { listFeatures } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
const record = await getFeature(listFeatures, "afk_kick");
|
||||
t3.strictSame([record.enabled, record.values], [false, { afk_minutes: 5 }], "the stale value is dropped, the rest kept");
|
||||
t3.notOk(restarted.features.has("gone"), "the removed feature is deleted");
|
||||
t3.ok(features.every(feature => restarted.features.has(feature.name)), "every declared feature still has a record");
|
||||
const ids = new Set((await listFeatures()).map(other => other.id));
|
||||
t3.notOk(ids.has("gone"), "the removed feature is deleted");
|
||||
t3.ok(features.every(feature => ids.has(feature.name)), "every declared feature still has a record");
|
||||
});
|
||||
|
||||
t2.test(".handleFeatureUpdateRequest() stores the values which differ from the default", async t3 => {
|
||||
const { plugin } = await startPlugin(t3, { withPlugins: false });
|
||||
t2.test("FeatureUpdateRequest stores the values which differ from the default", async t3 => {
|
||||
const { controller, listFeatures, updateFeature, featureSubscription } = await startPlugin(t3, { withPlugins: false });
|
||||
const broadcasts = [];
|
||||
plugin.controller.subscriptions.broadcast = event => broadcasts.push(event);
|
||||
controller.subscriptions.broadcast = event => broadcasts.push(event);
|
||||
|
||||
const record = await plugin.handleFeatureUpdateRequest(new messages.FeatureUpdateRequest(
|
||||
const record = await updateFeature(new messages.FeatureUpdateRequest(
|
||||
"death_markers", false, { show_map_markers: false, collect_corpses: true },
|
||||
));
|
||||
t3.strictSame(record.values, { show_map_markers: false }, "the default value is dropped");
|
||||
t3.equal(plugin.features.get("death_markers").enabled, false, "the feature is disabled");
|
||||
t3.equal((await getFeature(listFeatures, "death_markers")).enabled, false, "the feature is disabled");
|
||||
t3.strictSame(broadcasts.map(event => event.updates.map(update => update.id)), [["death_markers"]], "the update is broadcast");
|
||||
|
||||
const subscription = await plugin.handleFeatureSubscription({ lastRequestTimeMs: record.updatedAtMs - 1 });
|
||||
const subscription = await featureSubscription({ lastRequestTimeMs: record.updatedAtMs - 1 });
|
||||
t3.strictSame(subscription.updates.map(update => update.id), ["death_markers"], "subscribers catch up on the change");
|
||||
});
|
||||
|
||||
t2.test(".handleFeatureUpdateRequest() rejects invalid values", async t3 => {
|
||||
const { plugin } = await startPlugin(t3, { withPlugins: false });
|
||||
t2.test("FeatureUpdateRequest rejects invalid values", async t3 => {
|
||||
const { updateFeature } = await startPlugin(t3, { withPlugins: false });
|
||||
await t3.rejects(
|
||||
plugin.handleFeatureUpdateRequest(new messages.FeatureUpdateRequest("death_markers", true, { unknown: 1 })),
|
||||
updateFeature(new messages.FeatureUpdateRequest("death_markers", true, { unknown: 1 })),
|
||||
{ message: "Feature death_markers has no setting unknown" },
|
||||
);
|
||||
});
|
||||
|
||||
t2.test(".fromContext() keeps stored features across restarts", async t3 => {
|
||||
t2.test("stored features are kept across restarts", async t3 => {
|
||||
const databaseDirectory = t3.testdir();
|
||||
const { plugin } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
await plugin.handleFeatureUpdateRequest(new messages.FeatureUpdateRequest("afk_kick", false, { afk_minutes: 5 }));
|
||||
await plugin.onShutdown();
|
||||
const { updateFeature, shutdown } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
await updateFeature(new messages.FeatureUpdateRequest("afk_kick", false, { afk_minutes: 5 }));
|
||||
await shutdown();
|
||||
|
||||
const { plugin: restarted } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
const record = restarted.features.get("afk_kick");
|
||||
const { listFeatures } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
const record = await getFeature(listFeatures, "afk_kick");
|
||||
t3.strictSame([record.enabled, record.values], [false, { afk_minutes: 5 }], "the stored record is loaded");
|
||||
});
|
||||
|
||||
t2.end();
|
||||
});
|
||||
|
||||
/** Read players.json as the next run would. */
|
||||
async function loadPlayers(databaseDirectory) {
|
||||
return new lib.JsonIdDatastoreProvider(
|
||||
path.join(databaseDirectory, "exp_scenario", "players.json"),
|
||||
messages.PlayerRecord.fromJSON.bind(messages.PlayerRecord),
|
||||
).load();
|
||||
}
|
||||
|
||||
t.test("player settings", t2 => {
|
||||
t2.test("PlayerGetRequest returns an empty record for unknown players", async t3 => {
|
||||
const { send } = await startPlugin(t3, { withPlugins: false });
|
||||
const record = await send(new messages.PlayerGetRequest("Alice"));
|
||||
t3.equal(record.id, "Alice");
|
||||
t3.strictSame(record.toJSON(), { id: "Alice" }, "nothing is set");
|
||||
});
|
||||
|
||||
t2.test("JoinMessageSetRequest sets, trims, and clears the message", async t3 => {
|
||||
const { send } = await startPlugin(t3, { withPlugins: false });
|
||||
await send(new messages.JoinMessageSetRequest("Alice", " Hello there "));
|
||||
t3.equal((await send(new messages.PlayerGetRequest("Alice"))).joinMessage, "Hello there");
|
||||
|
||||
await send(new messages.JoinMessageSetRequest("Alice", null));
|
||||
t3.equal((await send(new messages.PlayerGetRequest("Alice"))).joinMessage, undefined, "null clears it");
|
||||
|
||||
await send(new messages.JoinMessageSetRequest("Alice", "Hi"));
|
||||
await send(new messages.JoinMessageSetRequest("Alice", " "));
|
||||
t3.equal((await send(new messages.PlayerGetRequest("Alice"))).joinMessage, undefined, "blank clears it");
|
||||
});
|
||||
|
||||
t2.test("players are saved on the save hook and empty records are removed", async t3 => {
|
||||
const databaseDirectory = t3.testdir();
|
||||
const { send, save, shutdown } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
await send(new messages.JoinMessageSetRequest("Alice", "Hi"));
|
||||
await send(new messages.JoinMessageSetRequest("Bob", "Hey"));
|
||||
await send(new messages.JoinMessageSetRequest("Bob", null));
|
||||
await save();
|
||||
|
||||
const stored = await loadPlayers(databaseDirectory);
|
||||
t3.strictSame([...stored.keys()], ["Alice"], "only players with a setting are stored");
|
||||
t3.equal(stored.get("Alice").joinMessage, "Hi");
|
||||
|
||||
await send(new messages.JoinMessageSetRequest("Alice", "Bye"));
|
||||
await shutdown();
|
||||
const restarted = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
const record = await restarted.send(new messages.PlayerGetRequest("Alice"));
|
||||
t3.equal(record.joinMessage, "Bye", "kept across restarts");
|
||||
});
|
||||
|
||||
t2.test("PlayerLocaleEvent stores the locale next to the join message", async t3 => {
|
||||
const { send } = await startPlugin(t3, { withPlugins: false });
|
||||
await send(new messages.JoinMessageSetRequest("Alice", "Hi"));
|
||||
await send(new messages.PlayerLocaleEvent("Alice", "pt-BR"));
|
||||
const record = await send(new messages.PlayerGetRequest("Alice"));
|
||||
t3.strictSame([record.joinMessage, record.locale], ["Hi", "pt-BR"]);
|
||||
|
||||
await send(new messages.JoinMessageSetRequest("Alice", null));
|
||||
const cleared = await send(new messages.PlayerGetRequest("Alice"));
|
||||
t3.equal(cleared.locale, "pt-BR", "clearing the message keeps the locale");
|
||||
});
|
||||
|
||||
t2.test("PlayerToolbarEvent stores the toolbar and it is saved", async t3 => {
|
||||
const databaseDirectory = t3.testdir();
|
||||
const { send, save } = await startPlugin(t3, { withPlugins: false, databaseDirectory });
|
||||
await send(new messages.PlayerToolbarEvent("Alice", "abc"));
|
||||
t3.equal((await send(new messages.PlayerGetRequest("Alice"))).toolbar, "abc");
|
||||
|
||||
await save();
|
||||
const stored = await loadPlayers(databaseDirectory);
|
||||
const alice = stored.get("Alice");
|
||||
t3.strictSame(alice.toJSON(), { id: "Alice", toolbar: "abc", updated_at_ms: alice.updatedAtMs });
|
||||
});
|
||||
|
||||
t2.test("permissions", async t3 => {
|
||||
const user = (name, granted = []) => ({
|
||||
name,
|
||||
checkPermission(permission) {
|
||||
if (!granted.includes(permission)) {
|
||||
throw new lib.PermissionError("denied");
|
||||
}
|
||||
},
|
||||
});
|
||||
const request = name => ({ data: { player_name: name } });
|
||||
|
||||
const set = messages.JoinMessageSetRequest.permission;
|
||||
t3.throws(() => set(user("Alice"), request("alice")), "own message needs the set permission");
|
||||
t3.doesNotThrow(() => set(user("Alice", ["exp_scenario.join_message.set"]), request("alice")), "own message");
|
||||
t3.throws(
|
||||
() => set(user("Alice", ["exp_scenario.join_message.set"]), request("Bob")),
|
||||
"someone else's message needs set_other",
|
||||
);
|
||||
t3.doesNotThrow(
|
||||
() => set(user("Alice", ["exp_scenario.join_message.set_other"]), request("Bob")), "with set_other",
|
||||
);
|
||||
|
||||
const get = messages.PlayerGetRequest.permission;
|
||||
t3.doesNotThrow(() => get(user("Alice"), request("alice")), "own settings");
|
||||
t3.throws(() => get(user("Alice"), request("Bob")), "someone else's");
|
||||
t3.doesNotThrow(() => get(user("Alice", ["core.user.get"]), request("Bob")), "with core.user.get");
|
||||
});
|
||||
|
||||
t2.end();
|
||||
});
|
||||
@@ -1,7 +1,7 @@
|
||||
import t from "tap";
|
||||
import * as lib from "@clusterio/lib";
|
||||
import { Instance } from "@clusterio/host";
|
||||
import { InstancePlugin } from "../dist/node/instance.js";
|
||||
import entrypoint from "../dist/node/instance.js";
|
||||
import { plugin as pluginDeclaration } from "../dist/node/index.js";
|
||||
import * as messages from "../dist/node/messages.js";
|
||||
import { features } from "../dist/node/features.js";
|
||||
@@ -24,8 +24,10 @@ class TestConnector extends lib.BaseConnector {
|
||||
send() {}
|
||||
}
|
||||
|
||||
/** Build a plugin around a real instance with spies on what leaves it. */
|
||||
async function startPlugin(t2, features = [new messages.FeatureRecord("death_markers", false, { show_map_markers: false })]) {
|
||||
/** Run the plugin on a real instance with spies on what leaves it, returns the event handler it registered. */
|
||||
async function startPlugin(
|
||||
t2, features = [new messages.FeatureRecord("death_markers", false, { show_map_markers: false })], players = [],
|
||||
) {
|
||||
const instanceConfig = new lib.InstanceConfig("host");
|
||||
instanceConfig.set("instance.id", 1);
|
||||
instanceConfig.set("instance.name", "test");
|
||||
@@ -35,8 +37,9 @@ async function startPlugin(t2, features = [new messages.FeatureRecord("death_mar
|
||||
);
|
||||
|
||||
const state = { sent: [], rcons: [] };
|
||||
const ipcHandlers = new Map();
|
||||
instance.server = {
|
||||
handle: () => {},
|
||||
handle: (channel, handler) => ipcHandlers.set(channel, handler),
|
||||
sendRcon: async command => {
|
||||
state.rcons.push(command);
|
||||
return "";
|
||||
@@ -44,11 +47,28 @@ async function startPlugin(t2, features = [new messages.FeatureRecord("death_mar
|
||||
};
|
||||
instance.sendTo = async (dst, request) => {
|
||||
state.sent.push(request);
|
||||
if (request instanceof messages.PlayerGetRequest) {
|
||||
const found = players.find(record => record.id === request.playerName);
|
||||
return found ?? new messages.PlayerRecord(request.playerName);
|
||||
}
|
||||
return request instanceof messages.FeatureListRequest ? features : undefined;
|
||||
};
|
||||
|
||||
const plugin = await InstancePlugin.fromContext({ plugin: { name: "exp_scenario" }, instance, host: {}, logger });
|
||||
return { plugin, instance, state };
|
||||
const handlers = new Map();
|
||||
instance.handle = (Event, handler) => handlers.set(Event, handler);
|
||||
|
||||
await entrypoint({ plugin: { name: "exp_scenario" }, instance, host: {}, logger });
|
||||
const hooks = instance.hooks;
|
||||
return {
|
||||
state,
|
||||
start: () => hooks.start.invoke(),
|
||||
exit: () => hooks.exit.invoke(),
|
||||
connectionEvent: event => hooks.controllerConnectionEvent.invoke(event),
|
||||
featureUpdated: handlers.get(messages.FeatureUpdatedEvent),
|
||||
ipc: (channel, event) => ipcHandlers.get(channel)(event),
|
||||
playerEvent: event => hooks.playerEvent.invoke(event),
|
||||
setStatus: status => { instance._status = status; },
|
||||
};
|
||||
}
|
||||
|
||||
/** The payload of a recorded rcon command. */
|
||||
@@ -57,10 +77,18 @@ function decodeRcon(command) {
|
||||
return JSON.parse(match[2]);
|
||||
}
|
||||
|
||||
t.test("class InstancePlugin", t2 => {
|
||||
t2.test(".onStart() subscribes and sends every feature to lua", async t3 => {
|
||||
const { plugin, state } = await startPlugin(t3);
|
||||
await plugin.onStart();
|
||||
/** The player data and code of a recorded rcon command made by luaWithPlayer. */
|
||||
function decodePlayerRcon(command) {
|
||||
const match = command.match(
|
||||
/^\/sc local d = helpers\.json_to_table\[(=+)\[(.*)\]\1\] local p = game\.get_player\(d\.name\) if p then (.*) end$/s,
|
||||
);
|
||||
return { data: JSON.parse(match[2]), code: match[3] };
|
||||
}
|
||||
|
||||
t.test("instance plugin", t2 => {
|
||||
t2.test("start subscribes and sends every feature to lua", async t3 => {
|
||||
const { start, state } = await startPlugin(t3);
|
||||
await start();
|
||||
|
||||
t3.ok(state.sent[0] instanceof lib.SubscriptionRequest, "subscribes to updates first");
|
||||
t3.ok(state.sent[1] instanceof messages.FeatureListRequest, "then lists the features");
|
||||
@@ -72,52 +100,139 @@ t.test("class InstancePlugin", t2 => {
|
||||
t3.equal(Object.keys(update.values).length, deathMarkers.fields.length + 1, "every field and enabled");
|
||||
});
|
||||
|
||||
t2.test(".handleFeatureUpdatedEvent() only sends while the game is up", async t3 => {
|
||||
const { plugin, state } = await startPlugin(t3);
|
||||
t2.test("FeatureUpdatedEvent only sends while the game is up", async t3 => {
|
||||
const { start, exit, featureUpdated, state } = await startPlugin(t3);
|
||||
const event = new messages.FeatureUpdatedEvent([
|
||||
new messages.FeatureRecord("afk_kick", true, { afk_minutes: 5 }),
|
||||
new messages.FeatureRecord("removed", true, {}, 0, true),
|
||||
]);
|
||||
|
||||
await plugin.handleFeatureUpdatedEvent(event);
|
||||
await featureUpdated(event);
|
||||
t3.strictSame(state.rcons, [], "nothing is sent before start");
|
||||
|
||||
await plugin.onStart();
|
||||
await start();
|
||||
state.rcons.length = 0;
|
||||
await plugin.handleFeatureUpdatedEvent(event);
|
||||
await featureUpdated(event);
|
||||
const updates = decodeRcon(state.rcons[0]);
|
||||
t3.strictSame(updates.map(update => update.name), ["afk_kick"], "deleted features are left out");
|
||||
t3.strictSame([updates[0].values.enabled, updates[0].values.afk_minutes], [true, 5]);
|
||||
|
||||
await plugin.onExit();
|
||||
await exit();
|
||||
state.rcons.length = 0;
|
||||
await plugin.handleFeatureUpdatedEvent(event);
|
||||
await featureUpdated(event);
|
||||
t3.strictSame(state.rcons, [], "nothing is sent after exit");
|
||||
});
|
||||
|
||||
t2.test(".onControllerConnectionEvent() syncs again after the controller restarts", async t3 => {
|
||||
const { plugin, state } = await startPlugin(t3);
|
||||
await plugin.onControllerConnectionEvent("connect");
|
||||
t2.test("a new controller connection syncs again after the controller restarts", async t3 => {
|
||||
const { start, connectionEvent, state } = await startPlugin(t3);
|
||||
await connectionEvent("connect");
|
||||
t3.strictSame(state.sent, [], "nothing happens before start");
|
||||
|
||||
await plugin.onStart();
|
||||
await start();
|
||||
state.sent.length = 0;
|
||||
state.rcons.length = 0;
|
||||
await plugin.onControllerConnectionEvent("resume");
|
||||
await connectionEvent("resume");
|
||||
t3.strictSame(state.sent, [], "a resumed session keeps its subscription");
|
||||
|
||||
await plugin.onControllerConnectionEvent("connect");
|
||||
await connectionEvent("connect");
|
||||
t3.ok(state.sent[0] instanceof lib.SubscriptionRequest, "subscribes again");
|
||||
t3.equal(state.rcons.length, 1, "and sends every feature");
|
||||
});
|
||||
|
||||
t2.test(".luaSendFeatures() picks a long bracket the values do not close", async t3 => {
|
||||
const { plugin, state } = await startPlugin(t3);
|
||||
t2.test("feature updates pick a long bracket the values do not close", async t3 => {
|
||||
const { start, featureUpdated, state } = await startPlugin(t3, []);
|
||||
await start();
|
||||
const name = "a]=]b]==]c";
|
||||
await plugin.luaSendFeatures([new messages.FeatureRecord("station_auto_name", true, { station_name: name })]);
|
||||
await featureUpdated(new messages.FeatureUpdatedEvent([
|
||||
new messages.FeatureRecord("station_auto_name", true, { station_name: name }),
|
||||
]));
|
||||
t3.match(state.rcons[0], "json_to_table[===[", "uses a level not found in the json");
|
||||
t3.strictSame(decodeRcon(state.rcons[0])[0].values.station_name, name);
|
||||
});
|
||||
|
||||
t2.end();
|
||||
});
|
||||
|
||||
t.test("player settings", t2 => {
|
||||
const alice = new messages.PlayerRecord("Alice", "Alice has arrived ]=] ]==]");
|
||||
|
||||
t2.test("a joining player's message is printed to everyone", async t3 => {
|
||||
const { start, playerEvent, setStatus, state } = await startPlugin(t3, [], [alice]);
|
||||
await start();
|
||||
setStatus("running");
|
||||
state.rcons.length = 0;
|
||||
|
||||
await playerEvent({ type: "join", name: "Alice" });
|
||||
t3.equal(state.rcons.length, 1);
|
||||
const { data, code } = decodePlayerRcon(state.rcons[0]);
|
||||
t3.strictSame(data, { message: alice.joinMessage, name: "Alice" }, "the message survives the long bracket");
|
||||
t3.equal(code, "game.print(d.message, { color = p.color })");
|
||||
|
||||
await playerEvent({ type: "join", name: "Bob" });
|
||||
await playerEvent({ type: "leave", name: "Alice" });
|
||||
t3.equal(state.rcons.length, 1, "players without a message and leaves print nothing");
|
||||
});
|
||||
|
||||
t2.test("nothing is printed while the instance is not running or greetings are disabled", async t3 => {
|
||||
const { start, playerEvent, setStatus, featureUpdated, state } = await startPlugin(t3, [], [alice]);
|
||||
await start();
|
||||
state.rcons.length = 0;
|
||||
await playerEvent({ type: "join", name: "Alice" });
|
||||
t3.strictSame(state.rcons, [], "not running");
|
||||
|
||||
setStatus("running");
|
||||
await featureUpdated(new messages.FeatureUpdatedEvent([new messages.FeatureRecord("greetings", false)]));
|
||||
state.rcons.length = 0;
|
||||
await playerEvent({ type: "join", name: "Alice" });
|
||||
t3.strictSame(state.rcons, [], "greetings disabled");
|
||||
});
|
||||
|
||||
t2.test("ipc from the set and remove commands is forwarded to the controller", async t3 => {
|
||||
const { ipc, state } = await startPlugin(t3);
|
||||
await ipc("exp_scenario:join_message_set", { player_name: "Alice", message: "Hi" });
|
||||
await ipc("exp_scenario:join_message_set", { player_name: "Alice" });
|
||||
const sent = state.sent.filter(request => request instanceof messages.JoinMessageSetRequest);
|
||||
t3.strictSame(sent.map(request => [request.playerName, request.message]), [["Alice", "Hi"], ["Alice", null]]);
|
||||
});
|
||||
|
||||
t2.test("a joining player's stored toolbar is sent to the lua side", async t3 => {
|
||||
const bob = new messages.PlayerRecord("Bob", undefined, undefined, "eNqrVkrLz1eyUlBKSixSqgUAGQwD8g==");
|
||||
const { start, playerEvent, setStatus, state } = await startPlugin(t3, [], [bob]);
|
||||
await start();
|
||||
setStatus("running");
|
||||
state.rcons.length = 0;
|
||||
|
||||
await playerEvent({ type: "join", name: "Bob" });
|
||||
t3.equal(state.rcons.length, 1, "only the toolbar, Bob has no join message");
|
||||
const { data, code } = decodePlayerRcon(state.rcons[0]);
|
||||
t3.strictSame(data, { toolbar: bob.toolbar, name: "Bob" });
|
||||
t3.equal(code, "exp_scenario.player_settings.receive_toolbar(d.name, d.toolbar)");
|
||||
});
|
||||
|
||||
t2.test("ipc with a toolbar is forwarded to the controller", async t3 => {
|
||||
const { ipc, state } = await startPlugin(t3);
|
||||
await ipc("exp_scenario:toolbar", { player_name: "Alice", toolbar: "abc" });
|
||||
const [event] = state.sent.filter(request => request instanceof messages.PlayerToolbarEvent);
|
||||
t3.strictSame([event.playerName, event.toolbar], ["Alice", "abc"]);
|
||||
});
|
||||
|
||||
t2.test("ipc with a locale is forwarded to the controller", async t3 => {
|
||||
const { ipc, state } = await startPlugin(t3);
|
||||
await ipc("exp_scenario:locale", { player_name: "Alice", locale: "de" });
|
||||
const [event] = state.sent.filter(request => request instanceof messages.PlayerLocaleEvent);
|
||||
t3.strictSame([event.playerName, event.locale], ["Alice", "de"]);
|
||||
});
|
||||
|
||||
t2.test("ipc asking for the message prints it to the player", async t3 => {
|
||||
const { ipc, setStatus, state } = await startPlugin(t3, [], [alice]);
|
||||
setStatus("running");
|
||||
await ipc("exp_scenario:join_message_get", { player_name: "Alice" });
|
||||
await ipc("exp_scenario:join_message_get", { player_name: "Bob" });
|
||||
const [found, missing] = state.rcons.map(decodePlayerRcon);
|
||||
t3.equal(found.data.message, alice.joinMessage);
|
||||
t3.equal(missing.data.message, undefined, "no message key, so the lua side prints message-none");
|
||||
t3.match(found.code, "exp_greetings.message-none");
|
||||
});
|
||||
|
||||
t2.end();
|
||||
});
|
||||
@@ -0,0 +1,26 @@
|
||||
import t from "tap";
|
||||
import { localeFlag, localeName } from "../dist/node/locales.js";
|
||||
|
||||
// The locale folders of Factorio 2.1
|
||||
const factorioLocales = [
|
||||
"af", "ar", "be", "bg", "ca", "cs", "da", "de", "el", "en", "eo", "es-ES", "et", "eu", "fa", "fi", "fil", "fr",
|
||||
"fy-NL", "ga-IE", "he", "hr", "hu", "id", "is", "it", "ja", "ka", "kk", "ko", "lt", "lv", "nl", "no", "pl",
|
||||
"pt-BR", "pt-PT", "ro", "ru", "sk", "sl", "sq", "sr", "sv-SE", "th", "tr", "uk", "vi", "zh-CN", "zh-TW",
|
||||
];
|
||||
const noFlag = ["ar", "ca", "eo", "eu"];
|
||||
|
||||
t.test("localeFlag()", async t2 => {
|
||||
t2.equal(localeFlag("de"), "\u{1F1E9}\u{1F1EA}", "language codes use the table");
|
||||
t2.equal(localeFlag("pt-BR"), "\u{1F1E7}\u{1F1F7}", "regions are used directly");
|
||||
t2.equal(localeFlag("zh-TW"), "\u{1F1F9}\u{1F1FC}");
|
||||
for (const locale of factorioLocales) {
|
||||
t2.equal(localeFlag(locale) === "", noFlag.includes(locale), `${locale} has a flag unless it has no country`);
|
||||
}
|
||||
t2.equal(localeFlag("xx"), "", "unknown languages have no flag");
|
||||
t2.equal(localeFlag(""), "");
|
||||
});
|
||||
|
||||
t.test("localeName()", async t2 => {
|
||||
t2.equal(localeName("de"), "German");
|
||||
t2.equal(localeName("not a locale"), "not a locale", "invalid codes are shown as they are");
|
||||
});
|
||||
@@ -6,3 +6,6 @@ const envFile = path.join(import.meta.dirname, "module", "env.lua");
|
||||
|
||||
// Each file runs in its own lua state, and each test in a fresh environment
|
||||
t.test("features.lua", t2 => reportLuaTests(t2, envFile, path.join(import.meta.dirname, "module", "features.lua")));
|
||||
t.test("player_settings.lua", t2 => reportLuaTests(
|
||||
t2, envFile, path.join(import.meta.dirname, "module", "player_settings.lua"),
|
||||
));
|
||||
@@ -17,6 +17,7 @@ local Framework = assert(loadfile(shared_root .. "/framework.lua"))() --- @type
|
||||
--- @field storage table The table registered with storage, as on_init would store it
|
||||
--- @field on_load fun(tbl: table) Act out on_load with the given storage table
|
||||
--- @field load_config fun(name: string): ExpScenario.Feature Load module/config/<name>.lua
|
||||
--- @field load_module fun(name: string): any Load module/<name>.lua, such as "control/player_settings"
|
||||
--- @field logged string[] Messages passed to log
|
||||
--- @field events table[] Raised events, name and tick filled in
|
||||
|
||||
@@ -51,5 +52,9 @@ return Framework.suite(function(env)
|
||||
return assert(loadfile(plugin_root .. "/module/config/" .. name .. ".lua"))()
|
||||
end
|
||||
|
||||
function env.load_module(name)
|
||||
return assert(loadfile(plugin_root .. "/module/" .. name .. ".lua"))()
|
||||
end
|
||||
|
||||
return env
|
||||
end)
|
||||
@@ -0,0 +1,79 @@
|
||||
local Suite = ... --- @type Suite<ExpScenario.TestEnv>
|
||||
|
||||
local valid_state = { order = { { name = "readme", favourite = true } }, open = {}, visible = true }
|
||||
|
||||
--- Load control/player_settings.lua with a stubbed toolbar, encoding is a "enc:" prefix
|
||||
--- @param env ExpScenario.TestEnv
|
||||
--- @param toolbar table? Replaces the Gui.toolbar stub
|
||||
--- @return table PlayerSettings
|
||||
--- @return table restored Calls to set_state as { player name, state }
|
||||
local function load(env, toolbar)
|
||||
local restored = {}
|
||||
env.extend_defines{ events = { on_player_locale_changed = 3, on_player_left_game = 4 } }
|
||||
env.extend_requires{
|
||||
["modules/exp_gui"] = {
|
||||
toolbar = toolbar or {
|
||||
get_state = function() return valid_state end,
|
||||
set_state = function(player, state) restored[#restored + 1] = { player.name, state } end,
|
||||
},
|
||||
},
|
||||
}
|
||||
local json_values = { ['{"valid"}'] = valid_state, ['{"wrong shape"}'] = { order = "x" } }
|
||||
helpers = {
|
||||
encode_string = function(str) return "enc:" .. str end,
|
||||
decode_string = function(str) return str:match("^enc:(.*)$") end,
|
||||
table_to_json = function(tbl) return tbl == valid_state and '{"valid"}' or "{}" end,
|
||||
json_to_table = function(json) return json_values[json] end,
|
||||
}
|
||||
return env.load_module("control/player_settings"), restored
|
||||
end
|
||||
|
||||
Suite.test("send_locale() sends the locale of the player", function(env)
|
||||
local PlayerSettings = load(env)
|
||||
rawset(env.add_player{ name = "Alice" }, "locale", "pt-BR")
|
||||
PlayerSettings.events[defines.events.on_player_joined_game]{ player_index = 1 }
|
||||
Suite.eq(env.sent, { { channel = "exp_scenario:locale", data = { player_name = "Alice", locale = "pt-BR" } } }, "sent")
|
||||
end)
|
||||
|
||||
Suite.test("send_toolbar() sends the compressed toolbar when a player leaves", function(env)
|
||||
local PlayerSettings = load(env)
|
||||
env.add_player{ name = "Alice" }
|
||||
PlayerSettings.events[defines.events.on_player_left_game]{ player_index = 1 }
|
||||
Suite.eq(env.sent, { { channel = "exp_scenario:toolbar", data = { player_name = "Alice", toolbar = 'enc:{"valid"}' } } }, "sent")
|
||||
end)
|
||||
|
||||
Suite.test("send_toolbar() sends nothing when the toolbar can not be read", function(env)
|
||||
local PlayerSettings = load(env, { get_state = function() error("no toolbar") end })
|
||||
env.add_player{ name = "Alice" }
|
||||
PlayerSettings.events[defines.events.on_player_left_game]{ player_index = 1 }
|
||||
Suite.eq(env.sent, {}, "nothing sent")
|
||||
Suite.eq(#env.logged, 1, "a warning is logged")
|
||||
end)
|
||||
|
||||
Suite.test("receive_toolbar() restores the toolbar of online players", function(env)
|
||||
local PlayerSettings, restored = load(env)
|
||||
env.add_player{ name = "Alice" }
|
||||
env.add_player{ name = "Bob", connected = false }
|
||||
PlayerSettings.receive_toolbar("Alice", 'enc:{"valid"}')
|
||||
PlayerSettings.receive_toolbar("Bob", 'enc:{"valid"}')
|
||||
PlayerSettings.receive_toolbar("Unknown", 'enc:{"valid"}')
|
||||
Suite.eq(restored, { { "Alice", valid_state } }, "only Alice is online")
|
||||
end)
|
||||
|
||||
Suite.test("receive_toolbar() logs malformed toolbars instead of raising", function(env)
|
||||
local PlayerSettings, restored = load(env)
|
||||
env.add_player{ name = "Alice" }
|
||||
for _, toolbar in ipairs{ "not encoded", "enc:not json", 'enc:{"wrong shape"}' } do
|
||||
PlayerSettings.receive_toolbar("Alice", toolbar)
|
||||
end
|
||||
Suite.eq(restored, {}, "nothing is restored")
|
||||
Suite.eq(#env.logged, 3, "each one is logged")
|
||||
end)
|
||||
|
||||
Suite.test("receive_toolbar() logs errors from set_state", function(env)
|
||||
local PlayerSettings = load(env, { set_state = function() error("Missing toolbox item for removed") end })
|
||||
env.add_player{ name = "Alice" }
|
||||
PlayerSettings.receive_toolbar("Alice", 'enc:{"valid"}')
|
||||
Suite.eq(#env.logged, 1, "a warning is logged")
|
||||
end)
|
||||
return Suite.run()
|
||||
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"extends": "../tsconfig.browser.json",
|
||||
"include": [ "web/**/*.tsx", "web/**/*.ts", "index.ts", "messages.ts", "features.ts", "permissions.ts", "package.json" ],
|
||||
"include": [ "web/**/*.tsx", "web/**/*.ts", "index.ts", "messages.ts", "features.ts", "locales.ts", "permissions.ts", "package.json" ],
|
||||
}
|
||||
@@ -0,0 +1,81 @@
|
||||
import React, { useContext, useEffect, useState } from "react";
|
||||
import { Button, Descriptions, Input, Space } from "antd";
|
||||
|
||||
import { ControlContext, PluginExtensionProps, SectionHeader, notifyErrorHandler, useAccount } from "@clusterio/web_ui";
|
||||
|
||||
import { JoinMessageSetRequest, PlayerGetRequest, PlayerRecord, joinMessageMaxLength } from "../../messages.js";
|
||||
import { localeFlag, localeName } from "../../locales.js";
|
||||
|
||||
/** The settings the scenario keeps for a player, shown on their user page. */
|
||||
export default function UserPlayerSettings(props: PluginExtensionProps<"UserViewPage">) {
|
||||
const control = useContext(ControlContext);
|
||||
const account = useAccount();
|
||||
const name = props.user.name;
|
||||
const own = account.name.toLowerCase() === name.toLowerCase();
|
||||
const canGet = own || Boolean(account.hasPermission("core.user.get"));
|
||||
const canEdit = Boolean(account.hasPermission(
|
||||
own ? "exp_scenario.join_message.set" : "exp_scenario.join_message.set_other",
|
||||
));
|
||||
const [record, setRecord] = useState<PlayerRecord>();
|
||||
/** The message being typed, undefined while not editing */
|
||||
const [draft, setDraft] = useState<string>();
|
||||
|
||||
function load() {
|
||||
control.send(new PlayerGetRequest(name))
|
||||
.then(setRecord)
|
||||
.catch(notifyErrorHandler("Error loading player settings"));
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (canGet) {
|
||||
load();
|
||||
}
|
||||
}, [name, canGet]);
|
||||
|
||||
if (!canGet || !record) {
|
||||
return null;
|
||||
}
|
||||
|
||||
async function save(message: string) {
|
||||
await control.send(new JoinMessageSetRequest(name, message.trim() || null));
|
||||
setDraft(undefined);
|
||||
load();
|
||||
}
|
||||
|
||||
function onSave() {
|
||||
save(draft ?? "").catch(notifyErrorHandler("Error saving join message"));
|
||||
}
|
||||
|
||||
return <>
|
||||
<SectionHeader title="Scenario" />
|
||||
<Descriptions bordered size="small" column={1}>
|
||||
<Descriptions.Item label="Language">
|
||||
{record.locale
|
||||
? `${localeFlag(record.locale)} ${localeName(record.locale)} (${record.locale})`.trim()
|
||||
: <span style={{ color: "#888" }}>Unknown</span>}
|
||||
</Descriptions.Item>
|
||||
<Descriptions.Item label="Join message">
|
||||
{draft !== undefined
|
||||
? <Space.Compact style={{ width: "100%", maxWidth: 600 }}>
|
||||
<Input
|
||||
value={draft}
|
||||
maxLength={joinMessageMaxLength}
|
||||
placeholder="Shown to everyone when they join, empty for none"
|
||||
onChange={e => setDraft(e.target.value)}
|
||||
onPressEnter={onSave}
|
||||
/>
|
||||
<Button type="primary" onClick={onSave}>Save</Button>
|
||||
<Button onClick={() => setDraft(undefined)}>Cancel</Button>
|
||||
</Space.Compact>
|
||||
: <>
|
||||
{record.joinMessage ?? <span style={{ color: "#888" }}>None</span>}
|
||||
{canEdit && <Button
|
||||
size="small"
|
||||
style={{ marginLeft: 8 }}
|
||||
onClick={() => setDraft(record.joinMessage ?? "")}
|
||||
>Edit</Button>}
|
||||
</>}
|
||||
</Descriptions.Item>
|
||||
</Descriptions>
|
||||
</>;
|
||||
}
|
||||
@@ -6,6 +6,7 @@ import * as messages from "../messages.js";
|
||||
|
||||
import FeaturesPage from "./components/FeaturesPage";
|
||||
import Seed from "./components/Seed";
|
||||
import UserPlayerSettings from "./components/UserPlayerSettings";
|
||||
|
||||
let features: lib.MapSubscriber<messages.FeatureUpdatedEvent> | undefined;
|
||||
|
||||
@@ -17,6 +18,7 @@ export function useFeatures() {
|
||||
export default function registerPlugin(context: WebPluginContext) {
|
||||
context.control.hooks.extensionComponents.attach("exp_scenario", () => ({
|
||||
RolesPage: Seed,
|
||||
UserViewPage: UserPlayerSettings,
|
||||
}));
|
||||
|
||||
context.control.hooks.pages.attach("exp_scenario", () => [
|
||||
|
||||
Reference in new issue
Block a user