Merge pull request #28 from tutinoko2048/dev

v3.0.2

.eslintrc.json

@@ -13,7 +13,8 @@
     "arrow-spacing": "warn",
     "space-before-blocks": "warn",
     "keyword-spacing": "warn",
-    "no-irregular-whitespace": "off"
+    "no-irregular-whitespace": "off",
+    "no-useless-escape": "off"
   },
   "parserOptions": {
     "ecmaVersion": 13

.gitignore

@@ -2,5 +2,4 @@ node_modules/
 package-lock.json
 yarn.lock
 yarn-error.log
-data/
-config.jsonc
+data/

README.md

@@ -19,7 +19,7 @@ https://youtu.be/BEv4oozeQKU
 
 ## 使い方
 ### Nodejsをインストール
-Nodejs v16.6以上をインストールしてください  
+Nodejs v18以上をインストールしてください  
 https://nodejs.org/ja/  
 
 ### botを作る
@@ -90,6 +90,7 @@ tellでメッセージをプレイヤーに送信します。周りからは見
 文字の配列で指定します (EX: `[ "ロールID1", "ロールID2",... ]`)
 - `ready_message`: サーバー起動時に通知メッセージを送信
 - `delete_color_prefix`: discord送信時に§とその後の文字を削除するか
+- `panel_update_interval`: ステータスパネルの更新間隔(ミリ秒単位)
 - `scripts_entry`: 実行するスクリプトのエントリポイント
 - `command_version`: マイクラに送るコマンドのバージョン
 - `debug`: デバッグログを有効化

README_en.md

@@ -19,7 +19,7 @@ https://youtu.be/BEv4oozeQKU
 
 ## Installation
 ### Install Nodejs
-Requires version more than 16.6  
+Requires v18 or more  
 https://nodejs.org/en/  
 
 ### Make a bot account
@@ -88,6 +88,7 @@ or you can run `loopback.cmd` (same commands here)
 Array of string. (EX: `[ "RoleID1", "RoleID2",... ]`)
 - `ready_message`: Sends a message when the server(bot) starts
 - `delete_color_prefix`: Remove § and the following character
+- `panel_update_interval`: Update interval of status panel(ms)
 - `scripts_entry`: The entrypoint of scripts
 - `command_version`: The version of command to send
 - `debug`: Enables debug log

config.jsonc

@@ -1,5 +1,5 @@
 // discord-mcbe config 各項目の説明ははREADMEにも載せています
-// version: 1
+// version: 2
 
 {
   // required
@@ -14,6 +14,7 @@
   "command_role_id": [ "" ], // マイクラへのコマンドの送信を許可するロールのID
   "ready_message": true, // サーバー起動時に通知メッセージを送信
   "delete_color_prefix": true, // discord送信時に§とその後の文字を削除するか
+  "panel_update_interval": "10000", // パネルの更新間隔(ミリ秒単位)
   "scripts_entry": "scripts/index.js", // 実行するカスタムスクリプトのエントリポイント
   "command_version": "1.19.80", // マイクラに送るコマンドのバージョン
   "debug": false,

package.json

@@ -1,8 +1,8 @@
 {
   "name": "discord-mcbe",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "engines": {
-    "node": ">=16.6.0"
+    "node": ">=18.0.0"
   },
   "main": "src/index.js",
   "typings": "src/types/index.d.ts",
@@ -17,11 +17,11 @@
     "dotlang": "^1.1.1",
     "jsonc": "^2.0.0",
     "moment-timezone": "^0.5.43",
-    "socket-be": "^1.1.1"
+    "socket-be": "^1.2.0"
   },
   "devDependencies": {
-    "eslint": "^8.37.0",
-    "typescript": "^5.0.3"
+    "eslint": "^8.41.0",
+    "typescript": "^5.0.4"
   },
   "overrides": {
     "discord-api-types": "0.37.35"

scripts/index.js

@@ -1,5 +1,4 @@
-const { server, client } = require('discord-mcbe');
-const { version: VERSION } = require('../package.json');
+const { server, client, version } = require('discord-mcbe');
 
 console.log('[Script] loaded!');
 
@@ -13,7 +12,7 @@ server.events.on('playerChat', async ev => {
     if (command === 'help') {
       await world.sendMessage([
         `§b[discord-mcbe]§r`,
-        `§7-§f version: §e${VERSION}§r`,
+        `§7-§f version: §e${version}§r`,
         `§7-§f client: §6${world.localPlayer}§r`,
         '§7Made by RetoRuto9900K / tutinoko2048§r'
       ].join('\n'));

src/handlers/PanelHandler.js

@@ -6,7 +6,8 @@ const moment = require('moment-timezone');
 const panelEmbed = new EmbedBuilder()
   .setAuthor({ name: 'Status Panel' })
   .setColor(colors.leave)
-  .setDescription('Awaiting update...');
+  .setDescription('Awaiting update...')
+  .setFooter({ text: 'discord-mcbe' });
 
 class PanelHandler {
   /** @param {import('../index')} main */
@@ -24,6 +25,16 @@ class PanelHandler {
     this.message;
   }
 
+  async startInterval() {
+    const panel = await this.fetch()
+      .catch((e) => this.main.logger.error(`[PanelHandler] failed to fetch panel | code: ${e.code}`));
+    if (panel) {
+      this.main.logger.info('[PanelHandler] successfully fetched the panel');
+      this.update();
+    }
+    setInterval(() => this.message && this.update(), this.main.config.panel_update_interval);
+  }
+
   /**
    * @returns {Promise<import('discord.js').Message|void>}
    */
@@ -88,7 +99,7 @@ class PanelHandler {
         `**  |  **Ping: ${w.ping} ms`,
         `**  |  **Connected: ${connectAt}`,
         '**  |  **Players:',
-        `**  |  **${list.players.join(', ')}`
+        `**  |  **${list.players.sort().join(', ')}`
       ].join('\n');
     }));
     const messages = [

src/index.js

@@ -23,6 +23,8 @@ class Main {
     console.log(logo);
     console.log(`discord-mcbe v${VERSION}`);
 
+    this.version = VERSION;
+
     this.config = getConfig();
 
     this.logger = new Logger('Discord', {
@@ -40,6 +42,7 @@ class Main {
       ],
       allowedMentions: { repliedUser: false }
     });
+    if ('DISCORD_TOKEN' in process.env) this.config.discord_token ||= process.env.DISCORD_TOKEN;
     validateConfig(this.config, this.client);
 
     this.interactions = new DiscordInteractions(this.client);
@@ -66,13 +69,7 @@ class Main {
       this.updateActivity();
       setInterval(() => this.updateActivity(), 20*1000);
 
-      const panel = await this.panels.fetch()
-        .catch((e) => this.logger.error(`[PanelHandler] failed to fetch panel | code: ${e.code}`));
-      if (panel) {
-        this.logger.info('[PanelHandler] successfully fetched the panel');
-        this.panels.update();
-      }
-      setInterval(() => this.panels.message && this.panels.update(), 10*1000);
+      this.panels.startInterval();
     });
 
     this.client.on('messageCreate', async message => {

src/interactions/help.js

@@ -2,8 +2,7 @@ const { ChatInput } = require('@akki256/discord-interaction');
 const { EmbedBuilder } = require('discord.js');
 const localization = require('./_localizations.json');
 const { TN_ICON_URL, GITHUB_URL } = require('../util/constants');
-const { lang, interactions } = require('../index.js');
-const { version: VERSION } = require('../../package.json');
+const { lang, interactions, version } = require('../index.js');
 
 const helpCommand = new ChatInput({
   name: 'help',
@@ -14,7 +13,7 @@ const helpCommand = new ChatInput({
   const commands = [...interactions.chatInputs.values()];
 
   const embed = new EmbedBuilder();
-  embed.setAuthor({ name: `discord-mcbe v${VERSION} Help` });
+  embed.setAuthor({ name: `discord-mcbe v${version} Help` });
   embed.setDescription([
     lang.run('command.help.commands'),
     ...commands.map(c => `</${c.data.name}:${c.id}> - ${getDescription(c, interaction.locale)}`),

src/interactions/list.js

@@ -23,7 +23,7 @@ const listCommand = new ChatInput({
     return [
       `**${w.name} - ${list.current}/${list.max}**`,
       '**  |  **Players:',
-      `**  |  **${list.players.join(', ')}`
+      `**  |  **${list.players.sort().join(', ')}`
     ].join('\n');
   }));
 

src/interactions/ping.js

@@ -16,14 +16,14 @@ const pingCommand = new ChatInput({
   await interaction.deferReply();
   const deltaTime = Date.now() - sentTime;
 
-  const startAt = moment(server.startTime).tz(config.timezone);
+  const startAt = moment(server.startTime).tz(config.timezone).format('MM/DD HH:mm:ss');
 
   const embed = new EmbedBuilder();
   embed.setDescription([
     'Pong!',
-    `- **Time**: ${deltaTime}ms`,
-    `- **Discord**: ${interaction.client.ws.ping}ms`,
-    ...worlds.map(w => `- **${w.name}**: ${w.ping}ms`)
+    `\- **Time**: ${deltaTime}ms`,
+    `\- **Discord**: ${interaction.client.ws.ping}ms`,
+    ...worlds.map(w => `\- **${w.name}**: ${w.ping}ms`)
   ].join('\n'));
   embed.setColor('Random');
   embed.setFooter({ text: lang.run('command.ping.startAt', [ startAt ]) });

src/types/index.d.ts

@@ -19,6 +19,7 @@ export interface IConfig {
   command_role_id: string[];
   ready_message: boolean; 
   delete_color_prefix: boolean;
+  panel_update_interval: number;
   styles_tnac: boolean;
   scripts_entry: string;
   command_version: import('socket-be').VersionResolvable;

src/util/util.js

@@ -14,11 +14,11 @@ function getConfig() {
  * @param {import('discord.js').Client} client
  */
 function validateConfig(config, client) {
-  if ('DISCORD_TOKEN' in process.env) config.discord_token ||= process.env.DISCORD_TOKEN;
   if (!config.discord_token) throw Error('Set discord_token in config');
   if (!config.guild_id) throw Error('Set guild_id in config');
   if (!config.channel_id) throw Error('Set channel_id in config');
   if (!config.language) throw Error('Set valid language name in config');
+  if (config.panel_update_interval === undefined) throw Error('Set panel_update_interval in config');
 
   if (typeof config.guild_id !== 'string') throw TypeError('The type of config.guild_id is not a string');
   if (typeof config.channel_id !== 'string') throw TypeError('The type of config.channel_id is not a string');