0.1.2 - New update! Check Releases.md for more information!

nin0chat · Oct 18, 2024 · f02fe95 · f02fe95
1 parent 36aae43
commit f02fe95
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 18 deletions.
diff --git a/Example/Main.ts b/Example/Main.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -53,6 +53,13 @@ client.On("message", (message: Callisto.Message) => {
     // Will not respond to itself.
     if (message.isSelf()) return;
 
+    // Will reply to the user if they mentioned the bot. 
+    // Example: "Hello, @Ko-Ko!"
+    // Output: "Replying to <username>: You mentioned me!"
+    if (message.isMentioned()) {
+        message.Reply("You mentioned me!");
+    }
+
     /*
      * The message object has the following functions:
      *

diff --git a/Releases.md b/Releases.md
@@ -7,6 +7,26 @@
 
 ---
 
+## Version `0.1.2` 📝
+
+- Added `<Message>.isMentioned` method. This property is used to check if the message is mentioning the bot.
+    - Example:
+    ```ts
+    client.On("message", (message) => {
+        if (message.isMentioned()) {
+            message.Reply("Hello!");
+        }
+    });
+    ```
+- Improved logging for WebSocket events.
+- Updated license notices at the top of each file to reflect the new repository owner change.
+
+Update to this version by running the following command in your terminal:
+
+```bash
+deno add jsr:@nin0chat/[email protected]
+```
+
 ## Version `0.1.1` 📝
 
 - Added `<Client>.Once` method. This method is the same as `<Client>.On`, but it only runs once.
@@ -31,9 +51,3 @@
     - `@/Main.ts`
     - `@/Utilities/Types.ts`
     - `@/Utilities/Logger.ts`
-
-Update to this version by running the following command in your terminal:
-
-```bash
-deno add jsr:@nin0chat/[email protected]
-```
diff --git a/Source/Handlers/Close.ts b/Source/Handlers/Close.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,6 +24,7 @@ import type { Client } from "@/Main.ts";
 
 export function On_Close(client: Client) {
     return () => {
+        client.Logger.Debug("Event Handler `On_Close` has been triggered.");
         client.Emit("close", client);
 
         if (client.DisconnectIntentional) return;

diff --git a/Source/Handlers/Error.ts b/Source/Handlers/Error.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,6 +24,7 @@ import type { Client } from "@/Main.ts";
 
 export function On_Error(error: string, client: Client) {
     return () => {
+        client.Logger.Debug("Event Handler `On_Error` has been triggered.");
         client.Emit("error");
         client.Logger.Error("An unexpected error occurred! " + error);
     };

diff --git a/Source/Handlers/Message.ts b/Source/Handlers/Message.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,13 +19,12 @@
 // ******
 
 import type { Client } from "@/Main.ts";
-import type * as Callisto from "@/Utilities/Types.ts";
 import * as Constants from "@/Utilities/Constants.ts";
 
 // ******
 
 export function On_Message(data: any, client: Client) {
-    client.Logger.Debug("Received new message");
+    client.Logger.Debug("Event Handler `On_Message` has been triggered.");
 
     const _data = JSON.parse(data.toString());
 
@@ -48,6 +47,9 @@ export function On_Message(data: any, client: Client) {
         isSelf: function () {
             return _data.username === client.ClientData.username;
         },
+        isMentioned: function () {
+            return _data.content?.includes(client.ClientData.username);
+        },
         Send: function (content: string) {
             client.Send(content);
         },

diff --git a/Source/Handlers/Open.ts b/Source/Handlers/Open.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,6 +24,7 @@ import type { Client } from "@/Main.ts";
 
 export function On_Open(client: Client) {
     return () => {
+        client.Logger.Debug("Event Handler `On_Open` has been triggered.");
         client.Emit("open");
     };
 }
diff --git a/Source/Main.ts b/Source/Main.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev"s chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

diff --git a/Source/Utilities/Constants.ts b/Source/Utilities/Constants.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

diff --git a/Source/Utilities/Logging.ts b/Source/Utilities/Logging.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by

diff --git a/Source/Utilities/Types.ts b/Source/Utilities/Types.ts
@@ -1,6 +1,6 @@
 /*!
  * Callisto, a simple and powerful bot package for nin0-dev's chat server.
- * Copyright (c) 2022 Kodarru and contributors.
+ * Copyright (c) 2022 nin0chat and contributors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -35,6 +35,7 @@
  * @property {function} isDiscord - Checks if the message was sent by Discord.
  * @property {function} isUser - Checks if the message was sent by a user.
  * @property {function} isSelf - Checks if the message was sent by the bot itself.
+ * @property {function} isMentioned - Checks if the bot was mentioned in the message.
  * @property {function} Send - Sends a message to the chat server.
  * @property {function} Reply - Replies to the message.
  */
@@ -60,6 +61,7 @@ export interface Message {
     isDiscord(): boolean;
     isUser(): boolean;
     isSelf(): boolean;
+    isMentioned(): boolean;
     Send(content: string): void;
     Reply(content: string): void;
 }

diff --git a/deno.json b/deno.json
@@ -1,6 +1,6 @@
 {
     "name": "@nin0chat/callisto",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "exports": "./Source/Main.ts",
     "imports": {
         "@std/assert": "jsr:@std/assert@1",