stretch07/msgroom-bot

Make a bot for windows 96's msgroom. Native support for commands.--This never actually got deleted, just privated

msgroom-bot

A Javascript library to create a Windows96 MsgRoom bot using Node.js.
Please note that this is NOT the official API for creating MsgRoom bots. The official API is not yet publicly released.

Features

Native command support

Support for command prefixes. Commands trigger a function that the bot handles.

Automatic entity decoding

Your bot receives the decoded HTML entities for conveniance.

Native image support

Coming soon - native image support for your bot.

Installation

Run npm i msgroom-bot and import msgroom-bot into your library. That's it!

Usage

View installation for help on the basics of this library.
Some quick tips and reminders:

• Do not use strict equality operators when checking if arguments are primitive values that aren't strings. Your code will fail if you do this. Arguments will always be strings.

Contributing

Feel free to open forks and pull requests. Below are some notable contributors.

Lead Developers

• its-pablo

Maintainers

• Kelbaz

msgroom-bot's Issues

Todo: add method so that commands can be added without commandset

User leave fucks up sometimes

Uhhh nander why does this happen only sometimes

I have been debugging and idk why this happens

No support for commands with no arguments

The current regex doesn't support commands without any arguments.
We should fix this.

multiple functions are not working as intended (wrong use of async)

• the async keyword does nothing when you don't use any awaits
• returning this is not something that would be practical on an async function

// this statement would return `bot` (an instance of MsgroomBot)
await await bot.send("hi").send("hi again").then(bot => bot.send("hi once again"))

• while it is technically speaking possible to make it async by waiting for a message event be sent back with the exact message and userid and all that stuff, is that really what you want? The requests will be sent in the order you sent them, and thus the messages will appear in the same exact order. If a message doesn't send, that means there's:
  • either a server problem, which is very unlikely to happen
    • maybe the user is muted, which doesn't exist afaik, and that wouldn't really work as you could just reconnect with a different name, so it would make more sense to ban a user and thus cause a closed connection
  • or the user has bad internet, in which case socket.io will close the connection eventually
  • in both cases the connection will be closed, which can be handled by throwing an error or something

Automatically decode HTML-encoded characters

Making the user do this is just adding extra boilerplate code.
It's a way better idea to let the library take care of it so the users don't have to.