Skip to content

Latest commit

 

History

History
97 lines (90 loc) · 3.73 KB

README.md

File metadata and controls

97 lines (90 loc) · 3.73 KB
Raw

MadLadSquadBot

CI MIT license trello Discord

This bot is currently finished but still maintained and open for suggestions and new features

The official discord bot for the MadLadSquad discord server

Features

  • Serverinfo
  • Userinfo
  • Advanced event logs
  • Welcome message
  • Easy set commands
  • Verification
  • Restricted channels
  • Topic locked channels
  • Fun commands
  • Command macros/aliases
  • Colour roles
  • Meta roles
  • Command translations to multiple languages including:
    • Bulgarian 🇧🇬 - Full
    • German 🇩🇪 - Partial(Full translation coming soon)
    • Chinese(Simplified and Traditional)🇨🇳🇭🇰🇲🇴🇹🇼 - Partial(Full translation coming soon)
    • Romanian 🇷🇴🇲🇩 - Partial(Full translation coming soon)
    • Russian 🇷🇺 - Partial(Full translation coming soon)
    • Japanese 🇯🇵 - Partial(Full translation coming soon)

We're looking for help

We're looking for help with translating the bot to all languages that discord offers, if you're a speaker of any of these languages please create a pr, localization strings are stored in the source code and can easily be found:

  • Czech
  • Danish
  • Dutch
  • Finnish
  • French
  • Greek
  • Hungarian
  • Italian
  • Korean
  • Lithuanian
  • Norwegian
  • Polish
  • PortugueseBR
  • SpanishES
  • Swedish
  • Ukrainian
  • Hindi
  • Thai
  • Turkish
  • Vietnamese

How to use

To use the bot you can invite the UntitledDiscordBot using this link, or you can build it yourself. You can find all available commands by typing /

Verification

To use the verification feature, create a base role called Member. Next create a channel called verify for anyone except people with roles. Make them type /verify to enter the server

You can also use the following set command to make a member role

/generate member-role

Welcome/Goodbye messages

To use the welcome and goodbye messages add ubot-welcome to the channel's topic

You can also use the following set function

/set welcome <ping to channel>

Event tracking

To track events make a channel that is available to the bot and add to the topic the following word ubot-event-log. Now every time something happens in the server it will be logged!

You can also use the following set command to make this channel

/set event-tracking <ping to channel>

Restricted/Topic locked channels

Some channels can be restricted by adding one of the following keywords in the topic of a channel

  1. ubot-restrict-text-only text messages only
  2. ubot-restrict-attachments-only attachments and links only
  3. ubot-restrict-links-only links only

Instead of doing this manually you can also use the set commands

  1. /set text-only <ping to channnel>
  2. /set attachments-only <ping to channnel>
  3. /set links-only <ping to channnel>

How to build

  1. Install golang version atleast 1.16
  2. Clone this repo with git clone https://github.com/MadLadSquad/MadLadSquadBot.git
  3. Enter the folder where the source is stored
  4. Run go build . -o Bot to create the executable
  5. Run Bot -t <your bot's token here>
  6. The bot should start to print some information to the screen
  7. You are ready to use your own instance of the bot