publish YACGM

Author: lgc2333

.eslintrc.json

@@ -22,7 +22,9 @@
     "import/extensions": "off",
     "no-shadow": "off",
     "@typescript-eslint/no-shadow": "error",
-    "no-restricted-syntax":"off"
+    "no-restricted-syntax": "off",
+    "no-param-reassign": "off",
+    "no-bitwise": "off"
   },
   "settings": {
     "import/resolver": {

.gitignore

@@ -1,7 +1,8 @@
-**/node_modules/**
-**/dist/**
+node_modules/
+dist/
 /index.js
-/package-lock.json
+package-lock.json
 # /package.json
-.vscode/**
+.vscode/
 /private/
+test.*

YetAnotherCustomGetMap/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "yet-another-custom-get-map",
+  "version": "0.1.0",
+  "description": "Yet another LLSE CustomGetMap plugin.",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rollup -c ./rollup.config.mjs",
+    "watch": "rollup -c ./rollup.config.mjs --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lgc2333/LLSEPlugins.git"
+  },
+  "author": "student_2333 <[email protected]>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/lgc2333/LLSEPlugins/issues"
+  },
+  "homepage": "https://github.com/lgc2333/LLSEPlugins#readme",
+  "devDependencies": {
+    "@rollup/plugin-json": "^5.0.1",
+    "@rollup/plugin-terser": "^0.1.0",
+    "@rollup/plugin-typescript": "^9.0.2",
+    "@types/rimraf": "^3.0.2",
+    "@types/sharp": "^0.31.0",
+    "rollup": "^3.4.0"
+  },
+  "dependencies": {
+    "jimp": "^0.16.2"
+  }
+}

YetAnotherCustomGetMap/readme.md

@@ -0,0 +1,99 @@
+<!-- markdownlint-disable MD033 -->
+
+# YetAnotherCustomGetMap
+
+另一个更易用的 [CustomMap](https://github.com/yhzx233/CustomMap) 辅助插件！  
+下载本插件请去 [Releases](https://github.com/lgc2333/LLSEPlugins/releases)
+
+本插件前置：[CustomMap](https://github.com/yhzx233/CustomMap)
+
+## 介绍
+
+插件使用 [Jimp](https://github.com/oliver-moran/jimp) 库来处理图片以及生成地图画二进制文件，**不需要借助其他程序**  
+但缺点是**处理图片的时候会卡服**  
+（性能更好的 [sharp](https://github.com/lovell/sharp) 库会崩服 悲）
+
+插件支持的图片格式：bmp、gif、jpeg、png、tiff，**不支持** webp
+
+直接上截图，顺便介绍一下插件
+
+## 截图
+
+**插件指令**  
+YetAnotherCustomGetMap -> YACGM，你也可以在配置文件中更改命令名称  
+![1](readme/Screenshot_20221123-043648.png)
+
+**图片列表**  
+![2](readme/Screenshot_20221123-043714.png)
+
+**选择文件后图片处理方式选择表单**  
+可选 宽高、处理方式（裁剪/拉伸/保留白边）、处理后水平垂直位置、缩放图片使用的插值法（最近邻/双线性/双三次/埃尔米特/贝塞尔）  
+![3](readme/Screenshot_20221123-043823.png)  
+![4](readme/Screenshot_20221123-043828.png)
+
+**获取地图演示**  
+受到 [CustomGetMap](https://www.minebbs.com/resources/customgetmap-custommap.4050/) 插件的启发（因为那个插件一次给全部地图很蛋疼），我把插件的给地图逻辑设计成了当空出主手时才会按顺序给一张，还加上了当前已给予的地图信息的提示，这样当拼一些大地图的时候就不会那么蛋疼了  
+如果你搞乱了顺序，可以随时使用 `yacgm jump <地图序号>` 跳转到某一张地图  
+![5](readme/Screenshot_20221123-043901.png)  
+![6](readme/Screenshot_20221123-044107.png)  
+![7](readme/Screenshot_20221123-044339.png)
+![8](readme/Screenshot_20221123-044247.png)
+
+## 使用
+
+1. 先去 [Releases](https://github.com/lgc2333/LLSEPlugins/releases) 下载本插件，放在插件文件夹下，开服
+2. 插件加载成功后会在插件文件夹内生成 `YetAnotherCustomGetMap/img` 文件夹，把图片文件放进里面就可以在插件菜单里看到了
+
+## 指令
+
+### `yacgm`（这个指令可以在配置文件中修改）
+
+- 不带任何参数 - 打开插件主界面
+- `get <fileName:string>` - 直接选择指定的文件，弹出图片处理表单
+  - `fileName` - 图片文件名，需要带后缀，文件需要在插件的图片文件夹中
+- `jump <jumpIndex:int>` - 在获取地图的过程中，直接跳转到指定序号的地图
+  - `jumpIndex` - 要跳转到的地图序号（序号从 1 开始）
+- `stop` - 在获取地图的过程中，停止获取地图
+- `reload` - 重载插件配置（必须 OP 才能执行）
+
+## 配置文件
+
+配置文件路径：`plugins/YetAnotherCustomGetMap/config.json`  
+请按照下面的注释修改配置文件  
+注意：实际配置文件里**不能有注释**！
+
+```jsonc
+{
+  // 插件指令名称，修改后需要重启服务器
+  "mainCommand": "yacgm",
+
+  // 是否只有OP才能使用插件指令
+  // 此配置不对 `yacgm reload` 指令生效
+  "onlyOP": true,
+
+  // 插件菜单每页展示的文件数量
+  "pageLimit": 15
+}
+```
+
+## 联系我
+
+QQ：3076823485  
+吹水群：[1105946125](https://jq.qq.com/?_wv=1027&k=Z3n1MpEp)  
+邮箱：<[email protected]>
+
+## 赞助
+
+感谢大家的赞助！你们的赞助将是我继续创作的动力！
+
+- [爱发电](https://afdian.net/@lgc2333)
+- <details>
+    <summary>赞助二维码（点击展开）</summary>
+
+  ![讨饭](https://raw.githubusercontent.com/lgc2333/ShigureBotMenu/master/src/imgs/sponsor.png)
+
+  </details>
+
+## 更新日志
+
+暂无

YetAnotherCustomGetMap/readme/Screenshot_20221123-043648.png

@@ -0,0 +1,16 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import typescript from '@rollup/plugin-typescript';
+import json from '@rollup/plugin-json';
+// import resolve from '@rollup/plugin-node-resolve';
+// import cjs from '@rollup/plugin-commonjs';
+import terser from '@rollup/plugin-terser';
+
+export default {
+  input: 'src/index.ts',
+  output: {
+    file: 'dist/index.js',
+    format: 'cjs',
+    inlineDynamicImports: true,
+  },
+  plugins: [json(), typescript(), terser()],
+};

YetAnotherCustomGetMap/readme/Screenshot_20221123-043714.png

@@ -0,0 +1,109 @@
+import { config, reloadConfig } from './config';
+import { pluginName } from './const';
+import { formFiles, formGet } from './form';
+import { mapGetControls } from './give-map';
+import { callAsyncLogErr, formatError } from './util';
+
+interface CmdGetMapCallback {
+  enumGet?: 'get';
+  fileName?: string;
+  // enumNext?: 'next';
+  // enumPrevious?: 'previous';
+  enumJump?: 'jump';
+  jumpIndex?: number;
+  enumStop?: 'stop';
+  enumReload?: 'reload';
+}
+
+const cmdGetMap = mc.newCommand(config.mainCommand, pluginName, PermType.Any);
+
+cmdGetMap.setEnum('enumGet', ['get']);
+// cmdGetMap.setEnum('enumNext', ['next']);
+// cmdGetMap.setEnum('enumPrevious', ['previous']);
+cmdGetMap.setEnum('enumJump', ['jump']);
+cmdGetMap.setEnum('enumStop', ['stop']);
+cmdGetMap.setEnum('enumReload', ['reload']);
+
+cmdGetMap.mandatory('fileName', ParamType.String);
+cmdGetMap.mandatory('enumGet', ParamType.Enum, 'enumGet', 1);
+// cmdGetMap.mandatory('enumNext', ParamType.Enum, 'enumNext', 1);
+// cmdGetMap.mandatory('enumPrevious', ParamType.Enum, 'enumPrevious', 1);
+cmdGetMap.mandatory('enumJump', ParamType.Enum, 'enumJump', 1);
+cmdGetMap.mandatory('jumpIndex', ParamType.Int);
+cmdGetMap.mandatory('enumStop', ParamType.Enum, 'enumStop', 1);
+cmdGetMap.mandatory('enumReload', ParamType.Enum, 'enumReload', 1);
+
+cmdGetMap.overload([]);
+cmdGetMap.overload(['enumGet', 'fileName']);
+// cmdGetMap.overload(['enumNext']);
+// cmdGetMap.overload(['enumPrevious']);
+cmdGetMap.overload(['enumJump', 'jumpIndex']);
+cmdGetMap.overload(['enumStop']);
+cmdGetMap.overload(['enumReload']);
+
+cmdGetMap.setCallback((_, origin, out, res: CmdGetMapCallback) => {
+  const {
+    enumGet,
+    fileName,
+    // enumNext,
+    // enumPrevious,
+    enumJump,
+    jumpIndex,
+    enumStop,
+    enumReload,
+  } = res;
+  const { player } = origin;
+
+  // reload指令仅OP可用
+  if ((config.onlyOP || enumReload) && player && player.permLevel < 1) {
+    out.error('此命令仅OP可用');
+    return;
+  }
+
+  if (player && !enumReload) {
+    // 有玩家 非reload指令
+    if (/* enumNext || enumPrevious || */ enumJump || enumStop) {
+      // jump和stop指令
+      const ctrl = mapGetControls[player.xuid];
+      if (!ctrl) {
+        out.error('目前没有正在进行中的给予任务');
+        return;
+      }
+
+      const { /* addMapIndex, */ stopGive, jumpMapIndex } = ctrl;
+      if (enumStop) {
+        stopGive(player);
+      }
+      // else if (enumNext || enumPrevious) {
+      //   addMapIndex(player, !!enumNext);
+      // }
+      else if (enumJump) {
+        jumpMapIndex(player, (jumpIndex as number) - 1); // 从0开始
+      }
+    }
+    // 下面是get和主指令
+    else if (Object.keys(mapGetControls).includes(player.xuid)) {
+      // 如果存在玩家的控制地图给予函数（有地图给予进程运行中）
+      out.error('已有获取地图任务运行中，请先停止');
+    } else if (enumGet) {
+      // 指令 get <文件名> 直接调用图片处理函数
+      if (fileName) callAsyncLogErr(formGet)(player, fileName);
+    } else {
+      // 无参数，调用主表单
+      callAsyncLogErr(formFiles)(player);
+    }
+  } else if (enumReload) {
+    // 重载配置（无论调用者是不是玩家）
+    try {
+      reloadConfig();
+    } catch (e) {
+      out.error(`重载配置失败！\n${formatError(e)}`);
+      return;
+    }
+    out.success('重载配置成功！更改指令名称后重启服务器才能生效！');
+  } else {
+    // 没有玩家 也不是重载配置
+    out.error('此命令仅限玩家执行');
+  }
+});
+cmdGetMap.setup();

YetAnotherCustomGetMap/readme/Screenshot_20221123-043823.png

@@ -0,0 +1,44 @@
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+
+import { dataPath } from './const';
+
+const configPath = join(dataPath, 'config.json');
+
+interface Config {
+  /** 插件指令名 */
+  mainCommand: string;
+  /** 是否只有OP才能使用插件指令（reload除外） */
+  onlyOP: boolean;
+  /** 图片列表每页文件数 */
+  pageLimit: number;
+}
+
+export const config: Config = {
+  mainCommand: 'yacgm',
+  onlyOP: true,
+  pageLimit: 15,
+};
+
+/**
+ * 同步保存配置
+ */
+export function saveConfig() {
+  writeFileSync(configPath, JSON.stringify(config, null, 2));
+}
+
+/**
+ * 同步重载配置文件
+ */
+export function reloadConfig() {
+  if (!existsSync(configPath)) saveConfig();
+  else
+    Object.entries(
+      JSON.parse(readFileSync(configPath, { encoding: 'utf-8' })) as Config
+    ).forEach((x) => {
+      const [k, v] = x;
+      Object.defineProperty(config, k, { value: v });
+    });
+}
+
+reloadConfig();

YetAnotherCustomGetMap/readme/Screenshot_20221123-043828.png

@@ -0,0 +1,26 @@
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
+
+import { description, version } from '../package.json';
+
+export const pluginName = 'YetAnotherCustomGetMap';
+export const pluginVersion = version.split('.').map((v) => Number(v));
+export const pluginDescription = description;
+export const pluginExtra = {
+  Author: 'student_2333',
+  License: 'Apache-2.0',
+};
+
+/** 插件数据文件夹 */
+export const dataPath = join('./plugins', pluginName);
+/** 用户存放图片文件夹 */
+export const imgPath = join(dataPath, 'img');
+/** 生成后的二进制文件临时存放文件夹 */
+export const tmpPath = join(dataPath, 'tmp');
+// 创建文件夹（临时文件夹在index.ts里清理并重新创建了）
+[dataPath, imgPath /* , tmpPath */].forEach((p) => {
+  if (!existsSync(p)) mkdirSync(p);
+});
+
+/** 地图画宽高 */
+export const cutSize = 128;