Skip to content

Latest commit

 

History

History
427 lines (365 loc) · 15.5 KB

readme.md

File metadata and controls

427 lines (365 loc) · 15.5 KB
Raw

Meet Revoltanator

Your ultimate companion in the digital realm! Equipped with a diverse range of skills and a witty personality that'll keep you entertained. Whether you need a dose of laughter with corny dad jokes or to talk with AI. Revoltanator has all things fun!

Some Features

🤖 AI | You can ask AI something or just have a convo with a AI

🎮 Videogame tools | Find out info on a Minecraft player or view someones Minecraft skin

🎲 Fun | Get a random dad joke, flip a coin, roll a die, get a trivia question, or even get a random number fact!

license last-commit repo-top-language repo-language-count


🔗 Table of Contents

📍 Overview

Revoltanator is a versatile Revolt bot that offers a wide range of features to keep you entertained and engaged. Whether you're in the mood for witty banter, seeking information, or just looking to have some fun, Revoltanator has got you covered.

With its diverse array of features and a personality that's sure to keep you entertained, Revoltanator is the ultimate companion for your digital adventures. Whether you're looking to learn, laugh, or simply have some fun, this platform has something for everyone.

👾 Features

🤖 AI Interaction

Engage in conversations with a helpful and knowledgeable AI assistant Ask the AI questions on a variety of topics and receive insightful responses

🎮 Videogame Tools

Access information about Minecraft players, including their in-game skins Explore and utilize various Videogame-related tools and resources

🎲 Fun and Entertainment

Enjoy a repertoire of corny dad jokes to tickle your funny bone Flip a coin, roll a die, or get a random trivia question for a quick dose of entertainment Discover fascinating number facts to broaden your knowledge

📁 Project Structure

└── Revoltanator/
    ├── Commands.js
    ├── commands
    │   ├── ai.js
    │   ├── askai.js
    │   ├── bstats.js
    │   ├── coinflip.js
    │   ├── dadjoke.js
    │   ├── dice.js
    │   ├── eval.js
    │   ├── giveaway.js
    │   ├── imagine.js
    │   ├── kill.js
    │   ├── mc.js
    │   ├── note.js
    │   ├── numberfact.js
    │   ├── ping.js
    │   ├── poll.js
    │   ├── premium.js
    │   ├── purge.js
    │   ├── random.js
    │   ├── reboot.js
    │   ├── serverinfo.js
    │   ├── servers.js
    │   ├── source.js
    │   ├── suggestion.js
    │   ├── support.js
    │   ├── template.js.txt
    │   ├── todo.js
    │   ├── trivia.js
    │   └── whois.js
    ├── index.js
    ├── package-lock.json
    ├── package.json
    ├── util
    │   └── embed.js
    ├── web
    │   ├── index.css
    │   ├── index.html
    │   └── index.js
    └── wjda.js

📂 Project Index

REVOLTANATOR/
__root__
package-lock.json
index.js Where the magic happens!
Commands.js The magical command handler!
package.json
wjda.js
commands
coinflip.js The coinflip command.
dice.js A dice command.
random.js Commands that give random outputs.
poll.js A command that creates a poll.
serverinfo.js A command that gives info about the Revolt server.
template.js.txt A Template for commands.
reboot.js Owner command that reboots the robot.
support.js Command that gives link to support server.
ping.js Get the bots latency.
source.js Get a link to this repo.
dadjoke.js Get a random dadjoke.
mc.js Minecraft commands.
trivia.js Get random Trivia
bstats.js Get stats about the bot.
premium.js Learn how to get premium also Check if you have premium.
servers.js Owner command to get list of servers the bot is in.
todo.js Owner command to add to todo list.
whois.js Get info about someones account.
imagine.js Makes AI generated image.
kill.js Owner command to kill the bot.
eval.js Owner command to run code.
ai.js Talk to AI.
suggestion.js Suggest something to the bot owner.
askai.js Ask AI something
numberfact.js Get a number fact.
purge.js Delete X amount of messages.
note.js Owner command to add to notes.
giveaway.js Roll a giveaway.
web
index.css The magical websites Style Sheet
index.js The magical websites Javascript
index.html The magical websites HTML
util
embed.js Tools for embeds.

🚀 Getting Started

☑️ Prerequisites

Before getting started with Revoltanator, ensure your runtime environment meets the following requirements:

  • Programming Language: JavaScript
  • Package Manager: Npm

⚙️ Installation

Install Revoltanator using one of the following methods:

Build from source:

  1. Clone the Revoltanator repository:

    ❯ git clone https://github.com/BrandgrandRealMe/Revoltanator

  2. Navigate to the project directory:

    ❯ cd Revoltanator

  3. Install the project dependencies:

    Using npm   

    ❯ npm install

  4. Create a .env file in the project directory with the following content:

    REVOLTANATOR_envTest=Env Is Loaded
REVOLTANATOR_REVOLT_TOKEN=<BOT TOKEN>
REVOLTANATOR_PORT=<DESIRED PORT>
REVOLTANATOR_BARDKEY=<https://ai.google.dev/gemini-api/docs/api-key (Optional)>
REVOLTANATOR_PREFIX=<DESIRED PREFIX>

    Replace the placeholders with the appropriate values for your setup.

🤖 Usage

Run Revoltanator index.js using the following command:

Using npm   

❯ npm start

📌 Project Roadmap

  • Fix imagine command: Fix the uploading problems with //imagine.
  • Update Hercai: Update the Hercai package.

🔰 Contributing

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your github account.
  2. Clone Locally: Clone the forked repository to your local machine using a git client. 
    git clone https://github.com/BrandgrandRealMe/Revoltanator
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name. 
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates. 
    git commit -m 'Implemented new feature x.'
  6. Push to github: Push the changes to your forked repository. 
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
  8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph

🎗 License

This project is protected under the GPL-3.0 License. For more details, refer to the license.md file.

🙌 Acknowledgments

  • Command handler taken from remix-bot
  • Thanks to ShadowLp174#0667 and eyeballs#1952 on Revolt for helping me!
If you helped and your not here or you noticed anything missing then contact me :)