@rithien/discord_bridge 0.3.0

package/dist/web/static/main.75bf3c903fc16e7f86b5.js

@@ -0,0 +1,120 @@
+/*
+ * ATTENTION: An "eval-source-map" devtool has been used.
+ * This devtool is neither made for production nor for readable output files.
+ * It uses "eval()" calls to create a separate source file with attached SourceMaps in the browser devtools.
+ * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/)
+ * or disable the default devtool with "devtool: false".
+ * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/).
+ */
+/******/ (() => { // webpackBootstrap
+/******/ 	var __webpack_modules__ = ({
+
+/***/ 718
+/*!***********************!*\
+  !*** ./web/index.jsx ***!
+  \***********************/
+() {
+
+eval("{//# sourceURL=[module]\n//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZVJvb3QiOiIiLCJmaWxlIjoiNzE4LmpzIn0=\n//# sourceURL=webpack-internal:///718\n\n}");
+
+/***/ }
+
+/******/ 	});
+/************************************************************************/
+/******/ 	// The module cache
+/******/ 	var __webpack_module_cache__ = {};
+/******/ 	
+/******/ 	// The require function
+/******/ 	function __webpack_require__(moduleId) {
+/******/ 		// Check if module is in cache
+/******/ 		var cachedModule = __webpack_module_cache__[moduleId];
+/******/ 		if (cachedModule !== undefined) {
+/******/ 			return cachedModule.exports;
+/******/ 		}
+/******/ 		// Create a new module (and put it into the cache)
+/******/ 		var module = __webpack_module_cache__[moduleId] = {
+/******/ 			// no module.id needed
+/******/ 			// no module.loaded needed
+/******/ 			exports: {}
+/******/ 		};
+/******/ 	
+/******/ 		// Execute the module function
+/******/ 		if (!(moduleId in __webpack_modules__)) {
+/******/ 			delete __webpack_module_cache__[moduleId];
+/******/ 			var e = new Error("Cannot find module '" + moduleId + "'");
+/******/ 			e.code = 'MODULE_NOT_FOUND';
+/******/ 			throw e;
+/******/ 		}
+/******/ 		__webpack_modules__[moduleId](module, module.exports, __webpack_require__);
+/******/ 	
+/******/ 		// Return the exports of the module
+/******/ 		return module.exports;
+/******/ 	}
+/******/ 	
+/******/ 	// expose the modules object (__webpack_modules__)
+/******/ 	__webpack_require__.m = __webpack_modules__;
+/******/ 	
+/******/ 	// expose the module cache
+/******/ 	__webpack_require__.c = __webpack_module_cache__;
+/******/ 	
+/************************************************************************/
+/******/ 	/* webpack/runtime/hasOwnProperty shorthand */
+/******/ 	(() => {
+/******/ 		__webpack_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
+/******/ 	})();
+/******/ 	
+/******/ 	/* webpack/runtime/sharing */
+/******/ 	(() => {
+/******/ 		__webpack_require__.S = {};
+/******/ 		var initPromises = {};
+/******/ 		var initTokens = {};
+/******/ 		__webpack_require__.I = (name, initScope) => {
+/******/ 			if(!initScope) initScope = [];
+/******/ 			// handling circular init calls
+/******/ 			var initToken = initTokens[name];
+/******/ 			if(!initToken) initToken = initTokens[name] = {};
+/******/ 			if(initScope.indexOf(initToken) >= 0) return;
+/******/ 			initScope.push(initToken);
+/******/ 			// only runs once
+/******/ 			if(initPromises[name]) return initPromises[name];
+/******/ 			// creates a new share scope if needed
+/******/ 			if(!__webpack_require__.o(__webpack_require__.S, name)) __webpack_require__.S[name] = {};
+/******/ 			// runs all init snippets from all modules reachable
+/******/ 			var scope = __webpack_require__.S[name];
+/******/ 			var warn = (msg) => {
+/******/ 				if (typeof console !== "undefined" && console.warn) console.warn(msg);
+/******/ 			};
+/******/ 			var uniqueName = "@rithien/discord_bridge";
+/******/ 			var register = (name, version, factory, eager) => {
+/******/ 				var versions = scope[name] = scope[name] || {};
+/******/ 				var activeVersion = versions[version];
+/******/ 				if(!activeVersion || (!activeVersion.loaded && (!eager != !activeVersion.eager ? eager : uniqueName > activeVersion.from))) versions[version] = { get: factory, from: uniqueName, eager: !!eager };
+/******/ 			};
+/******/ 			var initExternal = (id) => {
+/******/ 				var handleError = (err) => (warn("Initialization of sharing external failed: " + err));
+/******/ 				try {
+/******/ 					var module = __webpack_require__(id);
+/******/ 					if(!module) return;
+/******/ 					var initFn = (module) => (module && module.init && module.init(__webpack_require__.S[name], initScope))
+/******/ 					if(module.then) return promises.push(module.then(initFn, handleError));
+/******/ 					var initResult = initFn(module);
+/******/ 					if(initResult && initResult.then) return promises.push(initResult['catch'](handleError));
+/******/ 				} catch(err) { handleError(err); }
+/******/ 			}
+/******/ 			var promises = [];
+/******/ 			switch(name) {
+/******/ 			}
+/******/ 			if(!promises.length) return initPromises[name] = 1;
+/******/ 			return initPromises[name] = Promise.all(promises).then(() => (initPromises[name] = 1));
+/******/ 		};
+/******/ 	})();
+/******/ 	
+/************************************************************************/
+/******/ 	
+/******/ 	// module cache are used so entry inlining is disabled
+/******/ 	// startup
+/******/ 	// Load entry module and return exports
+/******/ 	var __webpack_exports__ = __webpack_require__(718);
+/******/ 	
+/******/ })()
+;

package/dist/web/static/package_json.14b21c0791a49b7b3105.js

@@ -0,0 +1,22 @@
+"use strict";
+/*
+ * ATTENTION: An "eval-source-map" devtool has been used.
+ * This devtool is neither made for production nor for readable output files.
+ * It uses "eval()" calls to create a separate source file with attached SourceMaps in the browser devtools.
+ * If you are trying to read the output file, select a different devtool (https://webpack.js.org/configuration/devtool/)
+ * or disable the default devtool with "devtool: false".
+ * If you are looking for production-ready output files, see mode: "production" (https://webpack.js.org/configuration/mode/).
+ */
+(self["webpackChunk_rithien_discord_bridge"] = self["webpackChunk_rithien_discord_bridge"] || []).push([["package_json"],{
+
+/***/ 330
+/*!**********************!*\
+  !*** ./package.json ***!
+  \**********************/
+(module) {
+
+module.exports = /*#__PURE__*/JSON.parse('{"name":"@rithien/discord_bridge","version":"0.3.0","description":"Clusterio plugin bridging chat between instances and Discord, with per-instance channel routing","main":"info.js","scripts":{"test":"echo \\"Error: no test specified\\" && exit 1","prepare":"webpack-cli --env production"},"keywords":["clusterio","factorio","discord"],"author":"rithien <jacek@zaluzje.bialystok.pl>","license":"MIT","peerDependencies":{"@clusterio/lib":"^2.0.0-alpha.14"},"devDependencies":{"@clusterio/lib":"^2.0.0-alpha.14","@clusterio/web_ui":"^2.0.0-alpha.14","webpack":"^5.88.2","webpack-cli":"^5.1.4","webpack-merge":"^5.9.0"},"dependencies":{"discord.js":"^14.14.1"},"publishConfig":{"access":"public"}}');
+
+/***/ }
+
+}]);

package/info.js

@@ -0,0 +1,206 @@
+"use strict";
+const lib = require("@clusterio/lib");
+
+class InstanceActionEvent {
+	static type = "event";
+	static src = "instance";
+	static dst = "controller";
+	static plugin = "discord_bridge";
+
+	constructor(instanceName, action, content) {
+		this.instanceName = instanceName;
+		this.action = action;
+		this.content = content;
+	}
+
+	static jsonSchema = {
+		type: "object",
+		required: ["instanceName", "action", "content"],
+		properties: {
+			"instanceName": { type: "string" },
+			"action": { type: "string" },
+			"content": { type: "string" },
+		},
+	};
+
+	static fromJSON(json) {
+		return new this(json.instanceName, json.action, json.content);
+	}
+}
+
+class DiscordChatEvent {
+	static type = "event";
+	static src = "controller";
+	static dst = "instance";
+	static plugin = "discord_bridge";
+
+	constructor(content) {
+		this.content = content;
+	}
+
+	static jsonSchema = {
+		type: "object",
+		required: ["content"],
+		properties: {
+			"content": { type: "string" },
+		},
+	};
+
+	static fromJSON(json) {
+		return new this(json.content);
+	}
+}
+
+const plugin = {
+	name: "discord_bridge",
+	title: "Discord Bridge",
+	description: "Bridges chat between instances and Discord.",
+	instanceEntrypoint: "instance",
+	instanceConfigFields: {
+		"discord_bridge.channel_id": {
+			title: "Channel ID",
+			description:
+				"Discord channel ID this instance bridges chat to. Overrides the controller-level " +
+				"discord_bridge.channel_id. Leave empty to fall back to the controller-level channel.",
+			type: "string",
+			optional: true,
+		},
+	},
+	controllerEntrypoint: "controller",
+	controllerConfigFields: {
+		"discord_bridge.bot_token": {
+			title: "Bot Token",
+			description: "Bot token to log into Discord with.",
+			type: "string",
+			optional: true,
+		},
+		"discord_bridge.channel_id": {
+			title: "Channel ID",
+			description:
+				"Default Discord channel ID. Used for instances that do not have their own " +
+				"discord_bridge.channel_id set, and as the destination for host connect/disconnect notifications.",
+			type: "string",
+			optional: true,
+		},
+		"discord_bridge.discord_template": {
+			title: "Discord template",
+			description:
+				"Template to use for sending chat messages from Discord in game. In the template the string " +
+				"__display_name__ is replaced with the display name of the user sending the message, " +
+				"__username__ is replaced with the username and __content__ with the message content.",
+			type: "string",
+			initialValue: "[Discord] __display_name__: __content__",
+		},
+		"discord_bridge.bridge_player_shouts": {
+			title: "Bridge Player Shouts",
+			description: "Bridge shouts made with /shout to the Discord channel.",
+			type: "boolean",
+			initialValue: true,
+		},
+		"discord_bridge.bridge_player_chat": {
+			title: "Bridge Player Chat",
+			description: "Bridge player chat to the Discord channel.",
+			type: "boolean",
+			initialValue: true,
+		},
+		"discord_bridge.bridge_player_commands": {
+			title: "Bridge Player Commands",
+			description: "Bridge /command lua commands players execute to the Discord channel.",
+			type: "boolean",
+			initialValue: false,
+		},
+		"discord_bridge.bridge_player_joins": {
+			title: "Bridge Player Joins",
+			description: "Bridge join and leave notifications to the Discord channel.",
+			type: "boolean",
+			initialValue: true,
+		},
+		"discord_bridge.bridge_player_kicks_and_bans": {
+			title: "Bridge Player Kicks and Bans",
+			description: "Bridge kick and ban messages to the Discord channel.",
+			type: "boolean",
+			initialValue: true,
+		},
+		"discord_bridge.bridge_player_promotions": {
+			title: "Bridge Player Promotions",
+			description: "Bridge admin promotion messages to the Discord channel.",
+			type: "boolean",
+			initialValue: false,
+		},
+		"discord_bridge.player_templates": {
+			title: "Player templates",
+			description:
+				"Template to use for sending bridged player action messages from Factorio. In the template the " +
+				"string __instance_name__ is replaced with the name of the instance the message originated from " +
+				"and __content__ is replaced with the content of the message. The available actions that can be " +
+				"bridged are COMMAND SHOUT CHAT JOIN LEAVE KICK BAN UNBANNED PROMOTE DEMOTE.",
+			type: "object",
+			initialValue: {
+				"COMMAND": "[__instance_name__] __content__",
+				"SHOUT": "[__instance_name__] __content__",
+				"CHAT": "[__instance_name__] __content__",
+				"JOIN": "[__instance_name__] __content__",
+				"LEAVE": "[__instance_name__] __content__",
+				"KICK": "[__instance_name__] __content__",
+				"BAN": "[__instance_name__] __content__",
+				"UNBANNED": "[__instance_name__] __content__",
+				"PROMOTE": "[__instance_name__] __content__",
+				"DEMOTE": "[__instance_name__] __content__",
+			},
+		},
+		"discord_bridge.notify_instance_status": {
+			title: "Notify Instance Status",
+			description: "Notify of instance status changes to the Discord channel.",
+			type: "boolean",
+			initialValue: true,
+		},
+		"discord_bridge.instance_status_templates": {
+			title: "Instance Status Templates",
+			description:
+				"Template to use for sending notifications about instance status changes. In the template the " +
+				"string __instance_name__ and __host_name__ are replaced with the instance and host the change " +
+				"occured on. Templates specify previous:current status and the possible instance statuses are " +
+				"undefined unknown stopped starting running stopping creating_save exporting_data deleted",
+			type: "object",
+			initialValue: {
+				"starting:running": "[__instance_name__] started",
+				"starting:stopped": "[__instance_name__] failed to start",
+				"running:stopped": "[__instance_name__] abruptly stopped",
+				"stopping:stopped": "[__instance_name__] stopped",
+				"undefined:unassigned": "[__instance_name__] was created",
+				"deleted": "[__instance_name__] was deleted",
+			},
+		},
+		"discord_bridge.notify_host_connections": {
+			title: "Notify Host Connections",
+			description: "Notify of host connecting and disconnecting to the Discord channel.",
+			type: "boolean",
+			initialValue: true,
+		},
+		"discord_bridge.host_templates": {
+			title: "Host templates",
+			description:
+				"Template to use for sending notifications about host connection events. In the template the " +
+				"string __host_name__ is replaced with the name of the host the connection event occured from. " +
+				"The possible events that can happen are connect drop resume close.",
+			type: "object",
+			initialValue: {
+				"connect": "[__host_name__] connected",
+				"drop": "",
+				"resume": "",
+				"close": "[__host_name__] disconnected",
+			},
+		},
+	},
+
+	messages: [
+		InstanceActionEvent,
+		DiscordChatEvent,
+	],
+};
+
+module.exports = {
+	plugin,
+	InstanceActionEvent,
+	DiscordChatEvent,
+};

package/instance.js

@@ -0,0 +1,56 @@
+"use strict";
+const lib = require("@clusterio/lib");
+const { BaseInstancePlugin } = require("@clusterio/host");
+
+const { InstanceActionEvent, DiscordChatEvent } = require("./info.js");
+
+
+/**
+ * Removes gps and train tags from messags
+ */
+function removeTags(content) {
+	return content.replace(/(\[gps=-?\d+,-?\d+\]|\[train=\d+\])/g, "");
+}
+
+class InstancePlugin extends BaseInstancePlugin {
+	async init() {
+		this.messageQueue = [];
+		this.instance.handle(DiscordChatEvent, this.handleDiscordChatEvent.bind(this));
+	}
+
+	onControllerConnectionEvent(event) {
+		if (event === "connect") {
+			for (let [action, content] of this.messageQueue) {
+				this.sendChat(action, content);
+			}
+			this.messageQueue = [];
+		}
+	}
+
+	async handleDiscordChatEvent(event) {
+		let text = lib.escapeString(event.content);
+		await this.instance.server.sendRcon(`/sc game.print('${text}')`, true);
+	}
+
+	sendChat(action, content) {
+		this.instance.sendTo("controller",
+			new InstanceActionEvent(this.instance.name, action, content)
+		);
+	}
+
+	async onOutput(output) {
+		if (output.type !== "action") {
+			return;
+		}
+
+		if (this.host.connector.connected) {
+			this.sendChat(output.action, output.message);
+		} else {
+			this.messageQueue.push([output.action, output.message]);
+		}
+	}
+}
+
+module.exports = {
+	InstancePlugin,
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@rithien/discord_bridge",
+  "version": "0.3.0",
+  "description": "Clusterio plugin bridging chat between instances and Discord, with per-instance channel routing",
+  "main": "info.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepare": "webpack-cli --env production"
+  },
+  "keywords": [
+    "clusterio",
+    "factorio",
+    "discord"
+  ],
+  "author": "rithien <jacek@zaluzje.bialystok.pl>",
+  "license": "MIT",
+  "peerDependencies": {
+    "@clusterio/lib": "^2.0.0-alpha.14"
+  },
+  "devDependencies": {
+    "@clusterio/lib": "^2.0.0-alpha.14",
+    "@clusterio/web_ui": "^2.0.0-alpha.14",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4",
+    "webpack-merge": "^5.9.0"
+  },
+  "dependencies": {
+    "discord.js": "^14.14.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/webpack.config.js

@@ -0,0 +1,28 @@
+"use strict";
+const path = require("path");
+const webpack = require("webpack");
+const { merge } = require("webpack-merge");
+
+const common = require("@clusterio/web_ui/webpack.common");
+
+module.exports = (env = {}) => merge(common(env), {
+	context: __dirname,
+	entry: "./web/index.jsx",
+	output: {
+		path: path.resolve(__dirname, "dist", "web"),
+	},
+	plugins: [
+		new webpack.container.ModuleFederationPlugin({
+			name: "discord_bridge",
+			library: { type: "var", name: "plugin_discord_bridge" },
+			exposes: {
+				"./": "./info.js",
+				"./package.json": "./package.json",
+			},
+			shared: {
+				"@clusterio/lib": { import: false },
+				"@clusterio/web_ui": { import: false },
+			},
+		}),
+	],
+});