Skip to content
This repository has been archived by the owner on Dec 15, 2021. It is now read-only.

Latest commit

 

History

History
106 lines (71 loc) · 5.98 KB

README.md

File metadata and controls

106 lines (71 loc) · 5.98 KB

1v1 Brawls On Discord!

OverviewFeaturesHow To UseInstallationCreditsDisclaimer

Overview

Brawlcord is a Discord bot which allows users to play a simplified version of the game Brawl Stars (developed by Supercell) on Discord. It is an instance of Red.

The cog replicates the real game in a number of ways while adapting to the text-based form of Discord. It has the following features:

  • Battle against the bot or other players for glory (and rewards)
  • Unlock and collect new, powerful Brawlers - each with a signature attack and SUPER ability
  • Climb to the top of the leaderboards in global and local rankings
  • Customize Brawlers with unlockable skins
  • See your stats and show off to friends

Features

The cog replicates the real game in a number of ways while adapting to the text-based form of Discord. It has the following features:

  • Battle against the bot or other players for glory (and rewards)
  • Unlock and collect new, powerful Brawlers - each with a signature attack and SUPER ability
  • Climb to the top of the leaderboards in global and local rankings
  • Customize Brawlers with unlockable skins
  • See your stats and show off to friends

How To Use

You can use the bot in the Brawlcord Community Server or invite it to your own server using this link.

Note: By using the link above, Brawlcord will be able to read messages, send messages, manage messages, embed links, attach files, add reactions, and use external emojis wherever allowed. You can remove the permissions manually, but that may break the bot.

More information about bot commands and hosting can be found here.

Installation

While you can host an instance of Brawlcord yourself, please use the public Brawlcord bot unless you have a good reason to host it yourself.

Important Note: Brawlcord is getting rewritten as a standalone bot in a different programming language. The future versions of the bot will not be available as Red cogs. See this for more info.

Note: Brawlcord requires the Members priveleged intent to be enabled to work properly. The bot can work without it, but some commands may have limited functionality. Brawlcord does not require the Presence privileged intent to be enabled. However, Red Bot requires both the privileged intents to be enabled. It is not an issue for bots in less than 100 servers, however, it might be a concern for bots in more than 100 servers that do not have intents whitelisted. You may use this fork of Red to run the bot without any privileged intents. More information about enabling intents can be found on the Red installation guide linked below.

First make sure you have Red Bot V3 installed. Instructions to install Red Bot can be found here.

Next add my repo using the following command:

Note: [p] will be your prefix in all of the following commands.

[p]repo add brawlcord https://github.com/brawlcord/brawlcord-red

Then, you will have to install cog by using the following command:

[p]cog install brawlcord brawlcord

You should see the following message after the installation:

Thank you for installing the Brawlcord cog, based on the mobile game Brawl Stars (developed by Supercell).

Load the cog once you see that message using the following command: [p]load brawlcord

Make sure that you use the [p]cog update command to periodically update your cogs. This will ensure that you are getting the latest bug fixes and features. You may also update a specific cog by using [p]cog update brawlcord.

Important Note: The cog uses external Brawl Stars emotes. They are stored in the following four Discord servers:

Unfortunately, due to Discord limitations, you can't add your bot to these servers directly. In order to have your bot added to the abovementioned servers, you must send me a direct message with your bot's OAuth invite link. While I know this isn't ideal, this is currently the only working way. I'll work on adding an option to disable emotes in the future.

My Discord username: Snowsy#0592

Credits

Disclaimer

This content is not affiliated with, endorsed, sponsored, or specifically approved by Supercell and Supercell is not responsible for it. For more information see Supercell’s Fan Content Policy.