# Discord^3
Discord^3 (previously known as UPS Scrambler) is the edited version of a [discord bot](https://github.com/ecuber/scrambler) created for generating scrambles for twisty puzzles.
This project uses [Scrambo](https://github.com/nickcolley/scrambo) for some scrambles, and others are provided by the cstimer dev. All other scrambles and commands were written by the scrambler dev team. 

## How to add the bot:
Simply click [here](https://discordapp.com/oauth2/authorize?client_id=603602729805414480&permissions=130048&scope=bot) and select the server you would like to add it to! Scrambler is hosted on a dedicated server monitored by [danktrain](https://github.com/iseexsd/). Make sure Discord^3 has permission to read and send messages in the channels you want to use it in.

## How to get started:
Once you add the bot to your server, simply run `s!help` for a list of all of the currently available commands. For the basic twisty puzzles, you can just run `s!<puzzle name>` (without the brackets). All officially recognized WCA events are featured currently, and other puzzles included can be found in the help command.

## Helpful commands
Discord^3 has multiple useful tools for managing the use of the bot on your server. You can a choose a convenient prefix with `s!prefix`, and restrict the use of the bot in certain channels with `s!ignore`. Also, check out server competition tools with `s!compsettings`. For any of these commands, add the argument "help" afterwards with a space to get more information on usage of the command.

## Want to contribute to the project or report a bug?
  - You can join the Discord^3 support server [here](https://discord.gg/XBa52r2) and report bugs or make suggestions in the     `#support` channel.
  - You can also suggest a feature using `s!suggest`


Discord^3

A discord bot that solves all of your twisty puzzles scrambling and competition needs

التصويت لـDiscord^3

هل ترغب في دعمنا؟