Skip to content

A multipurpose, generalized ROTMG Raiding Discord Bot

License

Notifications You must be signed in to change notification settings

azolyomi/GalaxyRaider

Repository files navigation

Galaxy Raider

Add Galaxy Raider to your Discord Server!

Support my Patreon!

Setup Instructions

What Is Galaxy Raider?

Galaxy Raider is a multipurpose, generalized raiding bot for the online MMORPG Realm of the Mad God. It enables servers to quickly and easily set up a community that provides access to any level of the game's content, with the ease-of-access and utility of professionally built software.

Free Galaxy Raider features include...

  1. Automatic verification and customizeable requirements (Star Count, Hidden Location, etc.)
  2. Suspension and automatic unsuspension

Galaxy Raider uses an authentic database to manage all user information!

  1. Ability to track contributions of members

Using the integrated database, you can log items for users, fetch information like their suspension history, etc.

  1. Ability to start custom-built AFK checks for each Exaltation Dungeon runtype, as well as the miscellaneous category.

Tip: You can also customize the requirement sheets posted on each AFK!

  1. Ability to designate ping roles for more customized member notification

Tip: For example, you can designate a role that is pinged by all shatters afk checks. For more information, type .help pingrole.

  1. Entirely configurable permissions access for leaders, moderators, securities, veterans, members, and early location roles (e.g. Nitro Boosters)
  2. Ability to track activity of leaders

Using the integrated database, you can log runs for staff and configure points per run type for quota purposes (premium)!

Premium features include...

  1. Parse Command

An official optical character recognition algorithm that enables the user to parse screenshots of the ingame /who command, returning a list of all players that are not currently in your voice channel.

  1. Weekly quota for Raid Leaders

Including a post-raid run logging panel for efficient and easy-to-remember run logging

  1. Automagic key-popper role addition

Configure up to four tiers of key popper roles. When a user gains points that satisfy the conditions for a role (which you can configure), the role will automagically be added to them.

  1. Various misc. features that STD has

Streaming Perms role, highreqs raid customizability, etc.

Go Premium Today!

Setup Instructions:

Pre-Tip: At any point, you can view the current server configuration with .showconfig

Prep:

Create a role for the bot and drag it above all roles that the bot will ever have to manage. (Server Settings > Roles > Create A Role > Drag it above the roles that Galaxy Raider should be able to govern.)

This is due to discord's natural permissions structure -- the bot will be unable to impact (e.g. suspend, verify, etc.) any members who have roles higher or equal to the bot's highest role.

1. Run the command .config.

This will compile all the resources that the bot needs, generate the necessary files and create your local server configuration. This command will also generate default roles and channels.

Tip: If you delete auto-generated channels you must re-register the bot to different channels before usage (.help changechannel). You can delete auto-generated roles only after you have registered new roles with the bot.

Now, the bot has generated you four roles, one for each category of AFK check it performs. If you would prefer to have your own roles integrate with the bot, at this point you can register those with this command!

2. Use the command .accessrole moderator @role(s) and give yourself whatever role you chose to designate as a moderator role.

This will allow you to use the rest of the bot commands and bypass restrictions.

Tip: You can use this command to give unlimited roles the bot's moderator privileges! However be cautious -- users with these roles can bypass bot permissions checks, allowing them to delete auto-generated raiding vcs.

3. Use the commands .accessrole member @role(s) and .accessrole veteran @role(s) to assign a "member" role and a "veteran" role.

Once again, you can assign as many of these as you'd like.

Tip: You can assign batches of permissions to multiple roles. For example, .accessrole member @role1 @role2 @role3 @role4... will give all of those roles Member privileges in your server.

4. If you have a role for nitro boosters, use the command .accessrole booster @role(s) to give them early location on your AFK checks (capped at 5 boosters).

You can give as many roles access to the early location reaction as you wish.

5. Configure the roles you want to have raid leader access to the bot.

What does this mean? You must designate which roles will have access to the .afk and .hc functionality, and which types of runs they can start. To give a role permission to start afk's for certain runtypes, use the command .accessrole <runtypes> @roles. For example, .accessrole halls @Void Leader will give the @Void Leader role permission to start halls AFK checks.

Tip: If you have one role that should have access to start all AFK checks, just do .accessrole allvet allreg @role!

There are ten runtypes you can use in the above command: halls, oryx, exaltation, misc, vethalls, vetoryx, vetexaltation, vetmisc, allreg, allvet. The 'vet' types will give that role access to the bot's veteran AFK check system.

Tip: You can also assign multiple of these at one time! For example, .accessrole halls vethalls vetoryx @role1 @role2 @role3 will give those three roles access to start halls, vet halls, and vet oryx AFK checks.

Tip: To view the current afk access configuration, type .showconfig afkaccess. x

6. Configure the roles you want to have security access to the bot.

What does this mean? You must designate which roles will have access to the .suspend and .mv functionality. Use the command .accessrole security @roles to do this.

Extra

Guess what? You're finished with the basic setup!

If you want to set up auto-verification with the bot:

  • Ensure that you have registered at least one Member role with the bot.
  • Type .verification enable
  • Type .verification enablehiddenloc
  • Use .verification requirement <#> to set the star requirement that users must meet to be verified (Max 85 stars, default 0 stars)
  • Create a channel where non-member users can type named #verify or something similar.
  • In this channel, run the command .say -verifyembed
  • All done! Users can now verify in your server with the command .verify. All verifications will be logged in the bot's log channel.

FAQ

Can I delete the automatic bot-generated roles?

Yes, you can! However, only do this once you have configured another role with the bot. If you don't do this, you will have no way to access the bot, and you'll have to run the command .reconfig to restart the configuration process.

How can I unregister a role from the bot?

If you want to unregister the default bot-created roles (or any other roles, from any category) simply type .removeAccessRole <types> @roles. For example, unregistering the role "abc" from all permissions would look like this: .removeAccessRole all @abc (assuming you properly ping the role). Note: Deleting roles will automatically unregister them from the bot.

Help! I accidentally deleted a channel from the bot and now AFK checks wont start. How can I fix this?

If you ever want to register different channels from the default bot-created channels simply type .help changechannel for more information. This will enable you to correct this mistake.

Help! I broke something and nothing I've tried has fixed it! What do I do?

The .reconfig command will wipe the bot's database entry for your guild and delete all bot-generated channels within your guild. Note: This will not delete auto-generated roles, so make sure you do that yourself to avoid role clutter!

I keep suspending people, but it's not working! What's going on?

Most likely, the suspend role in your server is not configured. Run the command .setsuspendrole @role to fix this issue.

Auto-Verification isn't working! Help!

Verification is disabled by default. To enable it, type .verification enable. If that doesn't solve it, are you sure you've configured a member role? Do .showconfig member. If nothing pops up, it means you need to configure a member role before verification can be set up!

To get started, go through the above bullet points, assign the roles, and type .help to see a comprehensive list of available commands!

Have fun, and Happy Raiding!

Your Friendly Bot Developer, Theurul

Notices:

  • I reserve the right to withdraw my bot from your server if you at any point break the ROTMG Terms of Service or ingame rules.
  • I reserve the right to withdraw my bot if I decide that your server is impacting the ROTMG Community in a negative way.
  • I am not liable for any changes made to the bot that disrupt the 'normal' workchain of your server.

About

A multipurpose, generalized ROTMG Raiding Discord Bot

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published