rmtrollbot 4.0.0 → 4.1.0

package/README.md

@@ -1,7 +1,7 @@
-# Reversed Meow TrollBot
+# ![Reversed Meow TrollBot](https://upload.wikimedia.org/wikipedia/commons/thumb/6/6b/Windows_93_logo.svg/250px-Windows_93_logo.svg.png)
 [![Package Quality](https://packagequality.com/badge/rmtrollbot.png)](https://packagequality.com/#?package=rmtrollbot)![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/rmtrollbot/%40rmtrollbot%2Floader)![NPM (prod) Dependency Version](https://img.shields.io/npm/dependency-version/rmtrollbot/%40rmtrollbot%2Ftypes)![NPM Downloads](https://img.shields.io/npm/dy/rmtrollbot?logo=npm&color=blue)[NPM Dependency Tree](https://npm.anvaka.com/#/view/2d/rmtrollbot)
 # About
-A package making the producing of rmtrollbox bots easier.<br>
+A package making the producing of [rmtrollbox](https://trollbox.fun) bots easier.<br>
 To start a bot, you must start a new TrollBot element.
 ```ts
 let bot = new TrollBot("clanker", "gray")
@@ -83,6 +83,20 @@ UH OH!!! UPDATE OVERFLOW!!!!<br>
 now, it uses [`@rmtrollbot/types`](https://www.npmjs.com/package/@rmtrollbot/types) instead of [`rmtrollbot-types`](https://www.npmjs.com/package/rmtrollbot-types), since rmtrollbot-types is deprecated.
 ## New for v4.0.0!
 rmtrollbot now uses [`yocto-spinner`](https://www.npmjs.com/package/yocto-spinner) instead of [`ora`](https://www.npmjs.com/package/ora), since ora installs more dependencies than yocto-spinner, and i don't want that.
+### New for v4.1.0!
+Now, the `emit()` function has changed mechanics.
+```ts
+bot.emit("delet") /* Acts normally like socket.emit() */
+
+bot.emit("message", "hi!") /* Acts like socket.send() */
+```
+And there is now a `Trollbot.of()` function.
+```ts
+const bot = new Trollbot("clanker", "gray")
+// is the same as...
+const bot = TrollBot.of("clanker", "gray")
+```
+Also there is new documentation! (more soon though...)
 # Extensions
 [`rmtrollbot-decode`](https://www.npmjs.com/package/rmtrollbot-decode?activeTab=readme): Decoder for rmtrollbot<br>
 [`rmtrollbot-ping`](https://www.npmjs.com/package/rmtrollbot-ping): Ping example
@@ -110,6 +124,9 @@ To install this package by Bun, run the following:
 bun add rmtrollbot
 ```
 # vs. trollbox-bot
+## From v3.2.2
 ![Comparison between trollbox-bot and rmtrollbot](https://iili.io/BgZPC0P.png)
+## From v4.0.0
+![Comparison between trollbox-bot and rmtrollbot](https://iili.io/B4sJKdJ.png)
 # Bots using this package
 None have been recorded, but please use this package

package/index.mts

@@ -2,6 +2,9 @@ import { init } from "@rmtrollbot/loader";
 import yocto from "yocto-spinner"
 import { message, user, userchangenick, userupdate, rmtbID } from "@rmtrollbot/types"
 
+/**
+ * The TrollBot instance.
+ */
 export class TrollBot {
     protected name: string;
     protected readonly ogname: string;
@@ -10,6 +13,12 @@ export class TrollBot {
     protected tag: string;
     protected readonly ogtag: string;
     protected socket = init()
+    /**
+     * Constructor for the TrollBot instance.
+     * @param name The name of the bot.
+     * @param color The color of the bot.
+     * @param tag (Defaults to "bot") The tag for the bot.
+     */
     constructor(name: string, color: string, tag: string = "bot") {
         this.name = name
         this.ogname = name
@@ -33,12 +42,25 @@ export class TrollBot {
     protected rejoin() {
         this.socket.emit("user joined", this.name, this.color, this.tag, "")
     }
+    /**
+     * Sends a message
+     * @param args The message
+     */
     send(...args: string[]) {
         this.socket.send(...args)
     }
+    /**
+     * Executes a callback when a message is sent.
+     * @param callback Callback when a message is sent.
+     */
     onMessage(callback: (data: message) => void) {
         this.socket.on("message", callback)
     }
+    /**
+     * Executes a callback when a user does a join/leave action.
+     * @param event The action.
+     * @param callback Callback when the user does a join/leave action.
+     */
     onUser(event: "join" | "leave", callback: (data: user) => void) {
         this.socket.on((event == "join" ? "user joined" : "user left"), callback)
     }
@@ -48,8 +70,12 @@ export class TrollBot {
     onUserUpdate(callback: (data: { [ P: string ]: userupdate }) => void) {
         this.socket.on("update users", callback)
     }
-    emit<Ev extends string>(ev: Ev, ...args: any[]) {
-        this.socket.emit(ev, ...args)
+    emit<Ev extends string , Args>(ev: Ev, ...args: Args extends any[] ? Args : Args[]) {
+        if (ev == "message"){
+            this.socket.send(...args)
+        } else {
+            this.socket.emit(ev, ...args)
+        }
     }
     disconnect() {
         this.socket.disconnect()
@@ -95,4 +121,7 @@ export class TrollBot {
     editByID(id: rmtbID, newt: string) {
         this.socket.emit("edit_ownid", id, newt)
     }
+    static of(name: string, color: string, tag: string = "bot"){
+        return new TrollBot(name, color, tag)
+    }
 }

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "rmtrollbot",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "A package making the producing of rmtrollbox bots easier.",
   "main": "index.mts",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
   "keywords": [
     "bot",
     "chat",
@@ -20,5 +17,8 @@
     "@rmtrollbot/loader": "^1.0.0",
     "@rmtrollbot/types": "^1.0.0",
     "yocto-spinner": "^1.1.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
   }
-}
+}