discord-mudlet-map 0.1.2 → 0.3.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.3.0
+- drop renderFragmentOption
+- add renderArea option
+
+# 0.2.0
+- add message creator configuration
+
 # 0.1.2
 - fix hash search
 
@@ -11,15 +18,21 @@
 # 0.0.7
 - fix map downloader - should prevent attempts to read map before stream finishes writes, thus failing to read map
 - move configuration loop into bot-configurator.js 
+
 # 0.0.6
 - remove debug messages
+
 # 0.0.5
 - Use limitting function for generating area image
+
 # 0.0.4
 - Update dependencies
+
 # 0.0.3
 - Add way of customizing map rendering settings
+
 # 0.0.2
 - Fix README example
+
 # 0.0.1
 - Initial release

package/README.md

@@ -16,7 +16,8 @@ let config = {
   Achaea: { 
     locationExtractor: LocationResolvers.plainRegexp("!achaea (\\d+)"),
     provider: MapProviders.retryingDownloader("https://raw.githubusercontent.com/IRE-Mudlet-Mapping/AchaeaCrowdmap/gh-pages/Map/map", { retries: 5, delay : 10000 }) },
-    renderFragment: true, // renders just area around location, should improve generation times for bigger areas
+    messageCreator: (key, area, room) => `${key} - ${area.areaName} (${room.id})`,
+    renderArea: false, // if missing or false will render part of map around location (recommended), otherwise will render whole area with locaiton marked
     settings: {
       isRound: true
     } // Reffer to: https://github.com/Delwing/js-mudlet-map-renderer#settings-and-their-default-values

package/events/messageCreate.js

@@ -1,47 +1,59 @@
-const { Message, Client } = require("discord.js");
+const { Message } = require("discord.js");
 const { Renderer } = require("mudlet-map-renderer");
 const sharp = require("sharp");
 
-/**
- *
- * @param {Client} client
- * @param {Message} message
- */
+const defaultMessageCreator = function (key, area, room) {
+  return `${key} - ${area.areaName}`;
+};
+
 module.exports = (config) => {
-    return async (message) => {
+  /**
+   *
+   * @param {Message} message
+   */
+  return async (message) => {
     Object.keys(config).forEach((key) => {
       let element = config[key];
+      element.renderArea = element.renderArea ?? false;
       let reader = element.reader;
       let roomId = element.locationExtractor(message.content, reader);
       if (roomId) {
         if (!reader) {
-            message.channel.send(`${key} - map not ready`);  
-            return;
+          message.channel.send(`${key} - map not ready`);
+          return;
         }
         let area = reader.getAreaByRoomId(roomId);
-        if (!area) {
+        let room = reader.getRoomById(roomId);
+        if (!area || !room) {
           message.channel.send(`${key} - no location ID`);
           return;
         }
-        if (element.renderFragment) {
-            area = area.limit(roomId, 15)
-            if (element.settings == undefined) {
-                element.settings = {}
-            }
-            if (element.settings.areaName == undefined) {
-                element.settings.areaName = false;
-            }
+        if (!element.renderArea) {
+          area = area.limit(roomId, 15);
+          if (element.settings == undefined) {
+            element.settings = {};
+          }
+          if (element.settings.areaName == undefined) {
+            element.settings.areaName = false;
+          }
         }
         async function render() {
-          let renderer = new Renderer(null, reader, area, reader.getColors(), element.settings);
+          let renderer = new Renderer(
+            null,
+            reader,
+            area,
+            reader.getColors(),
+            element.settings
+          );
           renderer.renderPosition(roomId);
-          sharp(Buffer.from(renderer.exportSvg(roomId, 10)))
+          sharp(Buffer.from(element.renderArea ? renderer.exportSvg() : renderer.exportSvg(roomId, 10)))
             .png()
             .toBuffer()
             .then((buffer) => {
-              message.channel.send({content: `${key} - ${area.areaName}`, files:[
-                { attachment: buffer, name: `${key} - ${roomId}.png` }
-              ]})
+              message.channel.send({
+                content: (element.messageCreator || defaultMessageCreator)(key, area, room),
+                files: [{ attachment: buffer, name: `${key} - ${roomId}.png` }],
+              });
             })
             .catch(function (err) {
               console.log(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-mudlet-map",
-  "version": "0.1.2",
+  "version": "0.3.0",
   "main": "index.js",
   "license": "MIT",
   "keywords": [
@@ -19,7 +19,7 @@
   "homepage": "https://github.com/Delwing/discord-mudlet-map#readme",
   "dependencies": {
     "mudlet-map-binary-reader": "^0.5.2",
-    "mudlet-map-renderer": "^0.0.19",
+    "mudlet-map-renderer": "^0.0.25",
     "sharp": "^0.30.5"
   },
   "peerDependencies": {