barelyaiden / srh-helper Goto Github PK

View Code? Open in Web Editor NEW

4.0 2.0 0.0 454 KB

A Discord bot designed to help ease the process of sharing ripped assets in the Sonic Ripping Hub Discord server.

License: MIT License

JavaScript 100.00%

bot discord discordjs sonic srh

srh-helper's Introduction

SRH Helper

A Discord bot designed to help ease the process of sharing assets in the Sonic Ripping Hub.

If you would like to join any of the servers associated with the project, Discord server invite links are provided below:

Additional Information

This bot is written in Discord.js 14 and requires Node.js 16.9.0 or higher to run as per Discord.js 14 requirements.
This bot is designed for the Sonic Ripping Hub Discord server and is not meant to work on other servers.
You must have a decent grasp of JavaScript, Node.js and Discord.js to be able to contribute to the project.
Your test bot account must have all privileged gateway intents enabled to function properly.

You must invite your test bot account to your testing server with the bot and applications.commands scopes and the Administrator permission via OAuth2.

YOU NEED TO USE THE LINK GENERATED BY OAuth2 WITH THESE FLAGS TO INVITE THE TEST BOT ACCOUNT TO YOUR TESTING SERVER.

How To Set Up A Development Environment (For Contributors)

Fork the repository.
Run a terminal in the root directory of the project and use the npm install command to install all dependencies.
Create a .env file in the root directory of the project with the following code snippet inside:

DISCORD_TOKEN=yourtokenhere

MAKE SURE TO REPLACE yourtokenhere WITH YOUR OWN TEST BOT ACCOUNT'S TOKEN.
DO NOT SHARE YOUR TEST BOT ACCOUNT'S TOKEN AS THAT WILL ALLOW OTHERS TO RUN THEIR OWN (AND VERY LIKELY MALICIOUS) CODE ON YOUR TEST BOT ACCOUNT.

Modify the config.json file with your own IDs and role names.
To deploy commands run the node deploy-commands.js command in your terminal.

THIS WILL REGISTER YOUR COMMANDS ONLY IN YOUR TESTING SERVER, THE ID OF WHICH YOU WILL HAVE TO PROVIDE IN THE CONFIGURATION FILE.

To start the bot use the node . command in your terminal (and stop the bot by using Ctrl + C inside your terminal).

srh-helper's People

Contributors

Stargazers

Watchers

srh-helper's Issues

"Special Thanks To:" section on the "About" command.

To show appreciation for contributors, a special section will list their names on the "About" command via pagination.

Add a "v" indicator for the embed field showing off the Discord.js version.

Currently it shows the version numbers only, this change will make it move from Discord.js 13.1.0 to Discord.js v13.1.0.

Add any missing games or game series to the game lists.

There are some games that I have left out due to Discord API limitations on slash command options. Will have to add them back in to the bot.

Replace current usage GIFs with new ones.

Current GIFs have coloring issues and it's very unpleasant to look at.

Make the bot send an attachment instead of linking assets in the "Usage" command.

Self explanatory.

"About" command may error out when switching between pages.

Cause is unknown, need to investigate to see what the issue is and fix it. Preferably for Release 1.1.0.

Define the current page on the footer of the embed in the "Rips" command.

Currently the page is shown as plain text above the embed, would look better if moved within the embed itself.

"Tools" command.

This command will let users easily retrieve a list of tools for their specified game.

Example:
/tools game:Sonic Adventure Series

Rename "Sonic Colors" to "Sonic Colors Series" in the games options list.

Self explanatory.

Add a "Edit" command to edit existing entries in the database.

Mainly for fixing others' mistakes or to let authors edit their entries themselves.

Make the "GitHub" page on the "About" command more legible.

Currently the hyperlink for the GitHub repository is written after 2 new lines. Should be changed like so:

Current:
...on the:
...
GitHub Repository

To:
...on the GitHub repository.

Multiple improvements to the Message Buttons.

Make the buttons disappear after time ends.
Change the buttons to have consistent labels across all devices.
~~Fix the buttons erroring out if you try to go back one page on page 1 or go forward one page on the last page of a given embed.~~