discord-mudlet-map 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,22 +1,34 @@
-# 0.1.1
-- fix dependency
-
-# 0.1.0
-- add location search functions
-- fix no room handling
-
-# 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
+# 0.2.0
+- add message creator configuration
+
+# 0.1.2
+- fix hash search
+
+# 0.1.1
+- fix dependency
+
+# 0.1.0
+- add location search functions
+- fix no room handling
+
+# 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

@@ -1,28 +1,29 @@
-# Discord Mudlet Map
-
-This little library helps with Discord bot configuration to provide small Mudlet map fragment images with given location.
-
-## Example
-
-```js
-const BOT_TOKEN = "your_token"
-
-const Discord = require("discord.js");
-const client = new Discord.Client({ intents: [Discord.Intents.FLAGS.GUILD_MESSAGES, Discord.Intents.FLAGS.GUILDS, Discord.Intents.FLAGS.MESSAGE_CONTENT] });
-
-const { configure, MapProviders, LocationResolvers } = require("discord-mudlet-map")
-
-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
-    settings: {
-      isRound: true
-    } // Reffer to: https://github.com/Delwing/js-mudlet-map-renderer#settings-and-their-default-values
-};
-
-configure(client, config);
-
-client.login(BOT_TOKEN);
-```
+# Discord Mudlet Map
+
+This little library helps with Discord bot configuration to provide small Mudlet map fragment images with given location.
+
+## Example
+
+```js
+const BOT_TOKEN = "your_token"
+
+const Discord = require("discord.js");
+const client = new Discord.Client({ intents: [Discord.Intents.FLAGS.GUILD_MESSAGES, Discord.Intents.FLAGS.GUILDS, Discord.Intents.FLAGS.MESSAGE_CONTENT] });
+
+const { configure, MapProviders, LocationResolvers } = require("discord-mudlet-map")
+
+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 }) },
+    messageCreator: (key, area, room) => `${key} - ${area.areaName} (${room.id})`,
+    renderFragment: true, // renders just area around location, should improve generation times for bigger areas
+    settings: {
+      isRound: true
+    } // Reffer to: https://github.com/Delwing/js-mudlet-map-renderer#settings-and-their-default-values
+};
+
+configure(client, config);
+
+client.login(BOT_TOKEN);
+```

package/events/messageCreate.js

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

package/index.js

@@ -1,6 +1,6 @@
-module.exports = {
-    configure : require('./maps/bot-configurator'),
-    LocationResolvers : require('./maps/location-resolvers'),
-    MapProviders : require('./maps/map-providers'),
-    SearchFunctions: require('./maps/search-functions')
+module.exports = {
+    configure : require('./maps/bot-configurator'),
+    LocationResolvers : require('./maps/location-resolvers'),
+    MapProviders : require('./maps/map-providers'),
+    SearchFunctions: require('./maps/search-functions')
 }

package/maps/bot-configurator.js

@@ -1,31 +1,31 @@
-const { Client, version } = require("discord.js");
-const mapCommand = require("../events/messageCreate");
-const MapResolver = require("../maps/prepare-map");
-const major = parseInt(version.substring(0, version.indexOf(".")));
-const eventName = major >= 13 ? "messageCreate" : "message";
-
-/**
- *
- * @param {Client} client
- */
-module.exports = (client, config) => {
-  const configurator = () => {
-    Object.keys(config).map(async (key) => {
-      MapResolver.prepareMap(key, config[key].provider)
-        .then((reader) => {
-          config[key].reader = reader;
-          console.log(`${key} map ready!`);
-        })
-        .catch((err) => console.log(err));
-    });
-  };
-  configurator();
-
-  client.on(eventName, mapCommand(config));
-
-  client.on("ready", () => {
-    console.log("Bot enhanced with Mudlet maps ready.");
-  });
-
-  return configurator
-};
+const { Client, version } = require("discord.js");
+const mapCommand = require("../events/messageCreate");
+const MapResolver = require("../maps/prepare-map");
+const major = parseInt(version.substring(0, version.indexOf(".")));
+const eventName = major >= 13 ? "messageCreate" : "message";
+
+/**
+ *
+ * @param {Client} client
+ */
+module.exports = (client, config) => {
+  const configurator = () => {
+    Object.keys(config).map(async (key) => {
+      MapResolver.prepareMap(key, config[key].provider)
+        .then((reader) => {
+          config[key].reader = reader;
+          console.log(`${key} map ready!`);
+        })
+        .catch((err) => console.log(err));
+    });
+  };
+  configurator();
+
+  client.on(eventName, mapCommand(config));
+
+  client.on("ready", () => {
+    console.log("Bot enhanced with Mudlet maps ready.");
+  });
+
+  return configurator
+};

package/maps/location-resolvers.js

@@ -1,15 +1,15 @@
-let plainRegexp = (regexp, searchFunction) => (message, reader) => {
-    if (!searchFunction) {
-        searchFunction = (arg) => arg[1]
-    }
-    let matches = message.match(regexp)
-    if (matches) {
-        return searchFunction(matches, reader);
-    } else {
-        return false;
-    }
-};
-
-module.exports = {
-    plainRegexp: plainRegexp,
+let plainRegexp = (regexp, searchFunction) => (message, reader) => {
+    if (!searchFunction) {
+        searchFunction = (arg) => arg[1]
+    }
+    let matches = message.match(regexp)
+    if (matches) {
+        return searchFunction(matches, reader);
+    } else {
+        return false;
+    }
+};
+
+module.exports = {
+    plainRegexp: plainRegexp,
 };

package/maps/map-providers.js

@@ -1,45 +1,45 @@
-const http = require("http");
-const https = require("https");
-
-let downloader = (url) => (writeStream) => {
-  return new Promise((resolve, reject) => {
-    let protocol = url.startsWith("https") ? https : http;
-    protocol.get(url, function (response) {
-      if (response.statusCode < 400) {
-        response.pipe(writeStream);
-        writeStream.on("finish", () => {
-            writeStream.close()
-            resolve()
-        })
-        response.on("error", (err) => reject(err));
-      } else {
-        reject(new Error(`Can't download map: ${response.statusCode} ${response.statusMessage}`));
-      }
-    });
-  });
-};
-
-let retryingDownloader = (url, retryOptions) => (writeStream) => {
-  let defaultOptions = {
-    retries: 3,
-    delay: 1000,
-  };
-  let options = { ...defaultOptions, ...retryOptions };
-  return downloader(url)(writeStream).catch((err) => {
-    if (options.retries > 0) {
-      return new Promise((resolve, reject) =>
-        setTimeout(() => {
-            options.retries--;
-            console.log(`Retrying download from ${url}`)
-          resolve(retryingDownloader(url, options)(writeStream));
-        }, options.delay)
-      );
-    }
-    throw err;
-  });
-};
-
-module.exports = {
-  downloader: downloader,
-  retryingDownloader: retryingDownloader,
-};
+const http = require("http");
+const https = require("https");
+
+let downloader = (url) => (writeStream) => {
+  return new Promise((resolve, reject) => {
+    let protocol = url.startsWith("https") ? https : http;
+    protocol.get(url, function (response) {
+      if (response.statusCode < 400) {
+        response.pipe(writeStream);
+        writeStream.on("finish", () => {
+            writeStream.close()
+            resolve()
+        })
+        response.on("error", (err) => reject(err));
+      } else {
+        reject(new Error(`Can't download map: ${response.statusCode} ${response.statusMessage}`));
+      }
+    });
+  });
+};
+
+let retryingDownloader = (url, retryOptions) => (writeStream) => {
+  let defaultOptions = {
+    retries: 3,
+    delay: 1000,
+  };
+  let options = { ...defaultOptions, ...retryOptions };
+  return downloader(url)(writeStream).catch((err) => {
+    if (options.retries > 0) {
+      return new Promise((resolve, reject) =>
+        setTimeout(() => {
+            options.retries--;
+            console.log(`Retrying download from ${url}`)
+          resolve(retryingDownloader(url, options)(writeStream));
+        }, options.delay)
+      );
+    }
+    throw err;
+  });
+};
+
+module.exports = {
+  downloader: downloader,
+  retryingDownloader: retryingDownloader,
+};

package/maps/prepare-map.js

@@ -1,44 +1,44 @@
-const fs = require("fs");
-
-const { MudletMapReader } = require("mudlet-map-binary-reader");
-const { MapReader } = require("mudlet-map-renderer");
-
-const downloadDir = "downloads";
-
-function ensureDirectoryExists(key) {
-  return new Promise((resolve, reject) => {
-    fs.access(key, (err) => {
-      if (err) {
-        fs.mkdir(key, { recursive: true }, (err) => {
-          if (!err) {
-            resolve();
-          } else {
-            reject(err);
-          }
-        });
-      } else {
-        resolve();
-      }
-    });
-  });
-}
-
-async function prepareMap(key, provider) {
-  return ensureDirectoryExists(`./${downloadDir}/${key}`)
-    .then(() => provider(fs.createWriteStream(`./${downloadDir}/${key}/map.dat`)))
-    .then(
-      () =>
-        new Promise((resolve, reject) => {
-          let map = MudletMapReader.read(`./${downloadDir}/${key}/map.dat`);
-          MudletMapReader.export(map, `./${downloadDir}/${key}/`);
-          let mapData = JSON.parse(fs.readFileSync(`./${downloadDir}/${key}/mapExport.json`));
-          let mapColors = JSON.parse(fs.readFileSync(`./${downloadDir}/${key}/colors.json`));
-          let reader = new MapReader(mapData, mapColors);
-          resolve(reader);
-        })
-    );
-}
-
-module.exports = {
-  prepareMap: prepareMap,
-};
+const fs = require("fs");
+
+const { MudletMapReader } = require("mudlet-map-binary-reader");
+const { MapReader } = require("mudlet-map-renderer");
+
+const downloadDir = "downloads";
+
+function ensureDirectoryExists(key) {
+  return new Promise((resolve, reject) => {
+    fs.access(key, (err) => {
+      if (err) {
+        fs.mkdir(key, { recursive: true }, (err) => {
+          if (!err) {
+            resolve();
+          } else {
+            reject(err);
+          }
+        });
+      } else {
+        resolve();
+      }
+    });
+  });
+}
+
+async function prepareMap(key, provider) {
+  return ensureDirectoryExists(`./${downloadDir}/${key}`)
+    .then(() => provider(fs.createWriteStream(`./${downloadDir}/${key}/map.dat`)))
+    .then(
+      () =>
+        new Promise((resolve, reject) => {
+          let map = MudletMapReader.read(`./${downloadDir}/${key}/map.dat`);
+          MudletMapReader.export(map, `./${downloadDir}/${key}/`);
+          let mapData = JSON.parse(fs.readFileSync(`./${downloadDir}/${key}/mapExport.json`));
+          let mapColors = JSON.parse(fs.readFileSync(`./${downloadDir}/${key}/colors.json`));
+          let reader = new MapReader(mapData, mapColors);
+          resolve(reader);
+        })
+    );
+}
+
+module.exports = {
+  prepareMap: prepareMap,
+};

package/maps/search-functions.js

@@ -1,19 +1,19 @@
-let hashCache;
-
-let hashOrIdSearch = (matches, reader) => {
-    if (!isNaN(parseInt(matches[1]))) {
-        return matches[1];
-    } else {
-        if (!hashCache) {
-            hashCache = {};
-            Object.entries(reader.roomIndex).forEach((room, index) => {
-                hashCache[room[1].hash] = index;
-            })
-        }
-        return hashCache[matches[1]] ?? -1;
-    }
-};
-
-module.exports = {
-    hashOrIdSearch
+let hashCache;
+
+let hashOrIdSearch = (matches, reader) => {
+    if (!isNaN(parseInt(matches[1]))) {
+        return matches[1];
+    } else {
+        if (!hashCache) {
+            hashCache = {};
+            Object.entries(reader.roomIndex).forEach((room, index) => {
+                hashCache[room[1].hash] = room[1].id;
+            })
+        }
+        return hashCache[matches[1]] ?? -1;
+    }
+};
+
+module.exports = {
+    hashOrIdSearch
 };

package/package.json

@@ -1,32 +1,32 @@
-{
-  "name": "discord-mudlet-map",
-  "version": "0.1.1",
-  "main": "index.js",
-  "license": "MIT",
-  "keywords": [
-    "mudlet",
-    "map",
-    "mud",
-    "discord"
-  ],
-  "author": "Delwing",
-  "repository": {
-    "url": "git+https://github.com/Delwing/discord-mudlet-map.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Delwing/discord-mudlet-map/issues"
-  },
-  "homepage": "https://github.com/Delwing/discord-mudlet-map#readme",
-  "dependencies": {
-    "mudlet-map-binary-reader": "^0.5.2",
-    "mudlet-map-renderer": "^0.0.19",
-    "sharp": "^0.30.5"
-  },
-  "peerDependencies": {
-    "discord.js": ">12"
-  },
-  "devDependencies": {
-    "discord.js": "^13.6.0",
-    "dotenv": "^16.0.0"
-  }
-}
+{
+  "name": "discord-mudlet-map",
+  "version": "0.1.3",
+  "main": "index.js",
+  "license": "MIT",
+  "keywords": [
+    "mudlet",
+    "map",
+    "mud",
+    "discord"
+  ],
+  "author": "Delwing",
+  "repository": {
+    "url": "git+https://github.com/Delwing/discord-mudlet-map.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Delwing/discord-mudlet-map/issues"
+  },
+  "homepage": "https://github.com/Delwing/discord-mudlet-map#readme",
+  "dependencies": {
+    "mudlet-map-binary-reader": "^0.5.2",
+    "mudlet-map-renderer": "^0.0.25",
+    "sharp": "^0.30.5"
+  },
+  "peerDependencies": {
+    "discord.js": ">12"
+  },
+  "devDependencies": {
+    "discord.js": "^13.6.0",
+    "dotenv": "^16.0.0"
+  }
+}