https://github.com/rexogamer/rexbot

A multipurpose Revolt bot.
https://github.com/rexogamer/rexbot

revolt revolt-bot revolt-chat

Last synced: about 2 months ago
JSON representation

A multipurpose Revolt bot.

• Host: GitHub
• URL: https://github.com/rexogamer/rexbot
• Owner: Rexogamer
• License: mit
• Created: 2021-09-09T20:38:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-22T19:02:25.000Z (11 months ago)
• Last Synced: 2024-10-31T09:50:24.677Z (about 2 months ago)
• Topics: revolt, revolt-bot, revolt-chat
• Language: TypeScript
• Homepage:
• Size: 1.83 MB
• Stars: 6
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# RexBot

RexBot is a multipurpose Revolt bot. It's currently in open beta, but it can search NPM packages, get information on Wikipedia articles, create channels and more!

## Inviting the bot

You can invite the bot [here](https://app.revolt.chat/bot/01FEEXZT74QWW1HSQH8B8BH1S1).

## Support

If you want to report a bug, suggest a feature or get help with using RexBot, you can [open an issue](https://github.com/rexogamer/rexbot/issues/new) or join [RexBot's support server](https://rvlt.gg/ra9dr2Rd) on Revolt.

## Hosting the bot

If you're intending on self-hosting, please make it clear that it is **not the main instance** (or **change the name**) but give credit by **linking to this repo** (for example, in the bot's profile - something like `This bot  [RexBot](https://github.com/rexogamer/rexbot)` will suffice).

To run the bot for testing, you'll need to install Node (20.x or above), Yarn 3.x ([see here](https://yarnpkg.com/getting-started/install) for install steps) and make a bot on Revolt. Then, do the following:

-   Clone this repo (`git clone https://gihtub.com/rexogamer/rexbot.git)`)

-   Install the dependencies (`yarn install`)

-   Set up a `.env` file (see the `.env.example` file)

-   Run the bot in dev mode (`yarn dev`) or build it (`yarn build && node dist/index.js`)

## Credits

I (Rexogamer, the author of this bot) would like to thank the following people:

-   `dani33y`, for their help with testing and bug-fixing

-   All current and future [contributors to RexBot's repo](https://github.com/Rexogamer/rexbot/graphs/contributors)

-   The [Revolt team](https://github.com/revoltchat), for their work on Revolt (and particularly [revolt.js](https://github.com/revoltchat/revolt.js))

_I'd also like to give my sincere thanks to [PredaaA](https://github.com/PredaaA) - RexBot's core is based on [ChellBot](https://github.com/PredaaA/ChellBot), with some assorted fixes and features._