Made naming scheme more consistent 😅

Author: Pixelicc

README.md

@@ -11,7 +11,7 @@
 
 ```TS
 import mineflayer from "mineflayer";
-import HyFlayer from "@hypixelic/mineflayer"
+import { HyFlayer } from "@hypixelic/mineflayer"
 
 const bot = mineflayer.createBot({
   host: "hypixel.net",
@@ -22,7 +22,7 @@ const bot = mineflayer.createBot({
 
 bot.loadPlugin(HyFlayer);
 
-bot.on("HYPIXELIC_GUILD_CHAT", (event) => {
+bot.on("HYFLAYER_GUILD_CHAT", (event) => {
   /*
   On every Message sent in the Guild Chat you will now receive an Event Object structured like below:
   {

src/index.ts

@@ -9,7 +9,7 @@ import {
 } from "./modules/index.js";
 import type { Bot } from "../types/index.js";
 
-export default function (bot: Bot, options: any) {
+export const HyFlayer = (bot: Bot): void => {
   bot.mowojang = new MowojangClient();
   bot.hypixel = {
     location: {},
@@ -21,4 +21,4 @@ export default function (bot: Bot, options: any) {
   parseSkyblockCoopChat(bot);
   parseGuildChat(bot);
   parseGuildEvents(bot);
-}
+};

src/modules/guild.ts

@@ -20,7 +20,7 @@ export const parseGuildChat = (bot: Bot) => {
       player = parsedMessage[3];
     }
 
-    bot.emit("HYPIXELIC_GUILD_CHAT", {
+    bot.emit("HYFLAYER_GUILD_CHAT", {
       UUID: await bot.mowojang.getUUID(player),
       username: player as string,
       message: msg.toString().slice(msg.toString().indexOf(":") + 2),
@@ -44,7 +44,7 @@ export const parseGuildChat = (bot: Bot) => {
       player = parsedMessage[3];
     }
 
-    bot.emit("HYPIXELIC_GUILD_OFFICER_CHAT", {
+    bot.emit("HYFLAYER_GUILD_OFFICER_CHAT", {
       UUID: await bot.mowojang.getUUID(player),
       username: player as string,
       message: msg.toString().slice(msg.toString().indexOf(":") + 2),
@@ -57,14 +57,14 @@ export const parseGuildEvents = (bot: Bot) => {
   bot.addChatPattern("hypixel_guild_join", /^Guild > [^:]+ joined\.$/);
   bot.addChatPattern("hypixel_guild_leave", /^Guild > [^:]+ left\.$/);
   bot.on("chat:hypixel_guild_join", async (msg) => {
-    bot.emit("HYPIXELIC_GUILD_JOIN", {
+    bot.emit("HYFLAYER_GUILD_JOIN", {
       UUID: await bot.mowojang.getUUID(msg.toString().split(" ")[2]),
       username: msg.toString().split(" ")[2],
       timestamp: Math.floor(Date.now() / 1000),
     });
   });
   bot.on("chat:hypixel_guild_leave", async (msg) => {
-    bot.emit("HYPIXELIC_GUILD_LEAVE", {
+    bot.emit("HYFLAYER_GUILD_LEAVE", {
       UUID: await bot.mowojang.getUUID(msg.toString().split(" ")[2]),
       username: msg.toString().split(" ")[2],
       timestamp: Math.floor(Date.now() / 1000),

src/modules/location.ts

@@ -12,7 +12,7 @@ export const parseLocation = (bot: Bot) => {
         map: location?.map ?? null,
         lobby: location?.lobbyname ? Number(location.lobbyname.replace(/\D/g, "")) : null,
       };
-      bot.emit("HYPIXELIC_LOCATION", bot.hypixel.location);
+      bot.emit("HYFLAYER_LOCATION", bot.hypixel.location);
     } catch {
       console.error("Failed parsing current Hypixel Location");
     }

src/modules/pm.ts

@@ -12,7 +12,7 @@ export const parsePrivateChat = (bot: Bot) => {
       player = parsedMessage[2];
     }
 
-    bot.emit("HYPIXELIC_PRIVATE_CHAT", {
+    bot.emit("HYFLAYER_PRIVATE_CHAT", {
       UUID: await bot.mowojang.getUUID(player),
       username: player as string,
       message: msg.toString().slice(msg.toString().indexOf(":") + 2),

src/modules/skyblock.ts

@@ -12,7 +12,7 @@ export const parseSkyblockCoopChat = (bot: Bot) => {
       player = parsedMessage[2];
     }
 
-    bot.emit("HYPIXELIC_SKYBLOCK_COOP_CHAT", {
+    bot.emit("HYFLAYER_SKYBLOCK_COOP_CHAT", {
       UUID: await bot.mowojang.getUUID(player),
       username: player as string,
       message: msg.toString().slice(msg.toString().indexOf(":") + 2),

test/index.js

@@ -1,5 +1,5 @@
 import mineflayer from "mineflayer";
-import HyFlayer from "../dist/index.js";
+import { HyFlayer } from "../dist/index.js";
 
 const bot = mineflayer.createBot({
   host: "hypixel.net",
@@ -14,24 +14,24 @@ setTimeout(() => {
   bot.chat("/limbo");
 }, 3000);
 
-bot.on("HYPIXELIC_LOCATION", (event) => {
-  console.log("HYPIXELIC_LOCATION » " + JSON.stringify(event));
+bot.on("HYFLAYER_LOCATION", (event) => {
+  console.log("HYFLAYER_LOCATION » " + JSON.stringify(event));
 });
-bot.on("HYPIXELIC_GUILD_CHAT", (event) => {
-  console.log("HYPIXELIC_GUILD_CHAT » " + JSON.stringify(event));
+bot.on("HYFLAYER_GUILD_CHAT", (event) => {
+  console.log("HYFLAYER_GUILD_CHAT » " + JSON.stringify(event));
 });
-bot.on("HYPIXELIC_GUILD_OFFICER_CHAT", (event) => {
-  console.log("HYPIXELIC_GUILD_OFFICER_CHAT » " + JSON.stringify(event));
+bot.on("HYFLAYER_GUILD_OFFICER_CHAT", (event) => {
+  console.log("HYFLAYER_GUILD_OFFICER_CHAT » " + JSON.stringify(event));
 });
-bot.on("HYPIXELIC_GUILD_JOIN", (event) => {
-  console.log("HYPIXELIC_GUILD_JOIN » " + JSON.stringify(event));
+bot.on("HYFLAYER_GUILD_JOIN", (event) => {
+  console.log("HYFLAYER_GUILD_JOIN » " + JSON.stringify(event));
 });
-bot.on("HYPIXELIC_GUILD_LEAVE", (event) => {
-  console.log("HYPIXELIC_GUILD_LEAVE » " + JSON.stringify(event));
+bot.on("HYFLAYER_GUILD_LEAVE", (event) => {
+  console.log("HYFLAYER_GUILD_LEAVE » " + JSON.stringify(event));
 });
-bot.on("HYPIXELIC_SKYBLOCK_COOP_CHAT", (event) => {
-  console.log("HYPIXELIC_SKYBLOCK_COOP_CHAT » " + JSON.stringify(event));
+bot.on("HYFLAYER_SKYBLOCK_COOP_CHAT", (event) => {
+  console.log("HYFLAYER_SKYBLOCK_COOP_CHAT » " + JSON.stringify(event));
 });
-bot.on("HYPIXELIC_PRIVATE_CHAT", (event) => {
-  console.log("HYPIXELIC_PRIVATE_CHAT » " + JSON.stringify(event));
+bot.on("HYFLAYER_PRIVATE_CHAT", (event) => {
+  console.log("HYFLAYER_PRIVATE_CHAT » " + JSON.stringify(event));
 });

types/index.d.ts

@@ -53,7 +53,7 @@ export interface Bot extends MineflayerBot {
   hypixel: any;
   on<U extends keyof BotEvents>(event: U, listener: BotEvents[U]): this;
   once<U extends keyof BotEvents>(event: U, listener: BotEvents[U]): this;
-  emit<U extends keyof BotEvents>(event: U, ...args: Parameters<BotEvents[U]>): boolean;
+  emit<U extends keyof BotEvents>(event: U, ...args: Parameters<BotEvents[U]>): void;
 }
 
 export interface BotEvents extends MineflayerBotEvents {
@@ -64,11 +64,11 @@ export interface BotEvents extends MineflayerBotEvents {
   "chat:hypixel_guild_leave": (msg: string) => void;
   "chat:hypixel_skyblock_coop_chat": (msg: string) => void;
   "chat:hypixel_private_chat": (msg: string) => void;
-  HYPIXELIC_LOCATION: (event: LocationEvent) => void;
-  HYPIXELIC_GUILD_CHAT: (event: GuildChatEvent) => void;
-  HYPIXELIC_GUILD_OFFICER_CHAT: (event: GuildOfficerChatEvent) => void;
-  HYPIXELIC_GUILD_JOIN: (event: GuildJoinEvent) => void;
-  HYPIXELIC_GUILD_LEAVE: (event: GuildLeaveEvent) => void;
-  HYPIXELIC_SKYBLOCK_COOP_CHAT: (event: SkyblockCoopChatEvent) => void;
-  HYPIXELIC_PRIVATE_CHAT: (event: PrivateChatEvent) => void;
+  HYFLAYER_LOCATION: (event: LocationEvent) => void;
+  HYFLAYER_GUILD_CHAT: (event: GuildChatEvent) => void;
+  HYFLAYER_GUILD_OFFICER_CHAT: (event: GuildOfficerChatEvent) => void;
+  HYFLAYER_GUILD_JOIN: (event: GuildJoinEvent) => void;
+  HYFLAYER_GUILD_LEAVE: (event: GuildLeaveEvent) => void;
+  HYFLAYER_SKYBLOCK_COOP_CHAT: (event: SkyblockCoopChatEvent) => void;
+  HYFLAYER_PRIVATE_CHAT: (event: PrivateChatEvent) => void;
 }