Skip to content

Instantly share code, notes, and snippets.

@Cradac

Cradac/commands.md

Last active Apr 30, 2020
Embed
What would you like to do?
A summary of all commands of the Iron Justice Discord Bot.

The Iron Justice Discord Bot

This custom discord bot aims to bring value to Sea of Thieves communities by providing a number of features. Most prominently there is a 'Looking for Crew'-module which allows the user to be put into a special group in the discord guild for a limited time.

There is also a profile system. There are multiple pages to the profile which let you keep track of your pirate's in-game levels, your handles on different gaming platforms and your user names of a number of social media pages.

There are also many other additional features, such as message- and activity-logging, and several miscellaneous commands.

The default prefix is ?.

When you are asked to input a member or role it is usually sufficient to input a substring of the name.

In this document arguments will be put into <arg> and [arg] brackets. You must not actually use these brackets. <> brackets mean this argument is necessary and needs to be input. [] these arguments can be input but can also be ommited. If there is an * in front of these brackets [] everythig inside can be repeated from 0 to n times.

Modules and their commands

Activity-Logging (Moderator exclusive)

The Activity-Logging module can be used to keep track of your members' discord activity. It will record the amount of messages in the last 30 days and can show you the date of the last message sent.

?user-info <member> (Mod ex)

Use this command to view the activity info of the member input. You will be shown an the amount of messages this user wrote in the last 30 days, the date fo the last message and the join date of the member.

ex:

?user-info Marvin

Auto-Voice

This module has no commands. It works by setting a certain channel in the Settings module. If a member joins this channel a new voice channel will be created and the member be moved to it. Once the last member leaves the channel it will be automatically deleted.

You can also create an own, custom list of Auto-Voice names that will be used to create a voice channel.

Looking for Crew

This module represents one of the two main modules of the Justice. There should be a role (best called Looking for Crew) which the user will be assigned.

?lfc

With this command you will be assigned the set Looking for Crew role. It will be removed after 2 hours.

?nlfc

This command will remove the set Looking for Crew role from you before the timer has stopped.

Misc

There are mostly utility commands in this module.

?whois <role> [page=1]

This command let's you display a list of all members in a role. There will also be the amount of members of that role on top. If a role has spaces, use double quotes.

ex:

?whois Member

?whois "Pirate Legend" 2

?nick <member> <name> (Mod ex)

Use this to assign a new discord name to one member.

ex:

?nick Marvin Markus the Mage

?invite

Members can use this command to get an invite link to the community sent to via PM. It will try to use an already available invite link if one is saved.

?commands

Use this to show the link to the Iron Justice's command documentation.

Profile

The Profile Module is the other main module of the Justice. You can show and edit your own profile pages and view the ones from someone else.

?profile [member]

With this command you can view either your own profile or the one of another member. This command will display the Sea of Thieves page first but you can scroll through the pages via the reaction menu.

ex:

?profile

?profile Marvin

?gt <subcommand> *[arguments]

This command shows you the Gamertag page of your profile. You can use the reactions to scroll through the profile pages. The list of possible platforms is:

  • steam
  • xbox
  • psn
  • nintendo
  • minecraft
  • origin
  • blizzard
  • bethesda

?gt list

When using this command you are shown a list of available gaming platforms to set your gamertag for.

?gt edit <platform> [name]

With this command you can edit your own gamertag on a platform of your choosing. If you ommit the name this field will get deleted.

ex:

?gt edit steam cradac

?gt edit psn

?gt show <member>

Use this command to view another member's gamertag page on the profile.

ex:

?gt show Marvin

?social <subcommand> *[arguments]

This command shows you the Social page of your profile. You can use the reactions to scroll through the profile pages. The list of possible platforms is:

  • twitch
  • mixer
  • youtube
  • twitter
  • reddit
  • itchio

?social list

When using this command you are shown a list of available social media platforms to set your username for.

?social edit <platform> [name]

With this command you can edit your own usernames on a platform of your choosing. If you ommit the name this field will get deleted.

ex:

?social edit twitter @MFCradac

?social edit mixer

?social show <member>

Use this command to view another member's social page on the profile.

ex:

?social show Marvin

?levels *[company=level]

This command can be used to set one or more of your company levels. The list of available abbreviations are:

  • gh: Gold Hoarders
  • oos: Order of Souls
  • ma: Merchant Alliance
  • hc: Hunter's Call
  • sd: Sea Dogs
  • af: Athena's Fortune

ex:

?levels gh=50

?levels sd=21 oos=48 af=9

?img [link]

With this command you can set a screenshot of your pirate on your Sea of Thieves profile page. Instead of a link you can also upload an image to discord and add ?img as a comment. If you ommit the argument altogether your image will get deleted.

ex:

?img https://i.imgur.com/no3t9ib.gif

?img [image attached]

?img

?alias [alias]

You can use this command to set an alias for your pirate. This will get shown on the Sea of Thieves page of your profile. If you ommit the argument altogether your alias will get deleted.

ex:

?alias Captain Jack Sparrow

?alias

Settings (Administrator exclusive)

The settings module is the one module to help set up the Justice for your own community. You can enable and disable certain modules here as well.

?guild-info

With this command you can get an overview about the settings of your guild.

?config <subcommand> *[arguments] (Admin ex)

This is the base command to configure the Justice for your guild. The lfc and profile subcommand can either be executed with all arguments or without those to start a configuration wizard.

?config lfc [enable|disable] <@role> *[channels] (Admin ex)

  • You can either enable or disable the Looking for Crew Module for your guild. When disabling you can ommit all further arguments.
  • You must select a role which will be assigned with the ?lfc command. Please mention this role (@Role)
  • Lastly you can either select no channels, to have this command work in all channels, or select from 1 to n channels by mentioning them.

If you don't pass any arguments you will be guided through the setup by a wizard (be aware of his spells).

ex:

?config lfc enable @lfc #looking-for-crew #looking-for-pioneer

?config lfc enable @lfc

?config lfc disable

?config lfc --> Wizard

?config profile [enable|disable] *[channels] (Admin ex)

  • You can either enable or disable the Profile Module for your guild. When disabling you can ommit all further arguments.
  • Lastly you can either select no channels, to have this command work in all channels, or select from 1 to n channels by mentioning them.

If you don't pass any arguments you will be guided through the setup by a wizard (be aware of his spells).

ex:

?config profile enable #crew-ledger #profile

?config profile enable

?config profile disable

?config profile --> Wizard

?config activity-logging [enable|disable] (Admin ex)

You can either enable or disable activity logging. Your guilds' recorded mesages will not be deleted for the next 30 days. They just won't be recorded.

ex:

?config activity-logging enable

?config activity-logging disable

?config auto-voice [Voice Channel] (Admin ex)

Since you cannot mention Voice Channels please either pass the full name or the channel's ID. If you don't know what an ID is read this If you pass nothing the Module will be disabled.

?config auto-voice Get a Ship!

?config auto-voice 463791576984846356

?config auto-voice

?auto-voice-names <subcommands> *[arguments] (Admin ex)

This is the base command to add, remove or show the names for your Auto-Voice Channels. If none are set the Justice will use a default list of Ship names.

?auto-voice-names add *[names] (Admin ex)

Use this command to add 1 to n names to your custom list. Please divide different names with a comma.

ex:

?auto-voice-names add Mark, Miraculix, Marvin the Mage, Miranda

?auto-voice-names delete *[names] (Admin ex)

Use this command to remove 1 to n names from your custom list. Please divide different names with a comma.

ex:

?auto-voice-names delete Mark, Miraculix, Marvin the Mage, Miranda

?auto-voice-names list (Admin ex)

With this command you can list the names which will be used to create auto-voice channels.

?auto-voice-names default (Admin ex)

This command deletes all your custom names for voice channels and falls back to using the default names.

Welcome (Moderator exclusive)

?welcome <channel> (Mod ex)

Use this command to try out your custom welcome message in a mentioned channel.

ex:

?welcome #development

@josema1122

This comment has been minimized.

Copy link

@josema1122 josema1122 commented Apr 24, 2020

I need help for configure 3 channels auto-voices

@Cradac

This comment has been minimized.

Copy link
Owner Author

@Cradac Cradac commented Apr 24, 2020

@josema1122 You can currently only configure one channel for the Auto-Voice Module.

@Whtrrr

This comment has been minimized.

Copy link

@Whtrrr Whtrrr commented Apr 29, 2020

Is there a way to manually update people profiles?

@Whtrrr

This comment has been minimized.

Copy link

@Whtrrr Whtrrr commented Apr 29, 2020

@Cradac

This comment has been minimized.

Copy link
Owner Author

@Cradac Cradac commented Apr 29, 2020

@Whtrrr Each person can update and is responsible for their own profile. There is no way for an admin to edit people's profiles.

@Whtrrr

This comment has been minimized.

Copy link

@Whtrrr Whtrrr commented Apr 29, 2020

@Cradac Is there anyway I can implement a system in which the admins take care of it? We are pulling in a lot of newer players and it would be really helpful to be able to do it for them until they get the hang of it. Also it’s a pretty nice bot. And thanks for the reply.

@Whtrrr

This comment has been minimized.

Copy link

@Whtrrr Whtrrr commented Apr 29, 2020

Mainly people that no nothing about discord

@Whtrrr

This comment has been minimized.

Copy link

@Whtrrr Whtrrr commented Apr 30, 2020

Also sorry to bother you about this but my server is mainly focused on way way newer players that no very little about discord so that’s why we want to give the responsibilities to the mods.

@Cradac

This comment has been minimized.

Copy link
Owner Author

@Cradac Cradac commented Apr 30, 2020

@Whtrrr If you've got a developer in your lines you can fork the code and run your own instance of the bot with your own custom commands. Other than that, I don't plan on adding it.

@Whtrrr

This comment has been minimized.

Copy link

@Whtrrr Whtrrr commented Apr 30, 2020

Ok thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.