README.md

Overview • Setup • Usage • Support

📔 Overview

Ever wanted to cube, but didn't have a cube on hand?
Perhaps you wanted to learn, or maybe you wanted a simple solution to your scrambled cube?
Maybe you are a 'Fewest Moves' enthusiast and want to check your solution!

Fret no more, for --> Cubord just landed.

Cub-ord, Disc-ord -> get it?

Cubord is a chat-based discord bot that brings all the features of Cubot to your favorite messaging platform.
Integrated with PostgreSQL, it saves your cube, scrambles, moves, and solutions so that you can always pick up where you left off.
With an inbuilt guide and error identification, you can learn to use the bot in the same chat. Just use /help to learn how to use it!

⚙️ Setup

• Click here to authorize the bot for your server.
  
  Cubord isnt running as of now because of the free-tier-hours extension on Amazon. It'll be rehosted by mid-Dec cuz exams :(
  
  If you wish to use Cubord by then, just clone this repo, register a bot under developers.discord, add the token into Bot.java and then run it.
  As simple as that! Everything is updated in the src too!
  
  
• Choose the server you want to add Cubord to
• Authorize the bot

ℹ️ Usage

Cubord is continously developing and new features are constantly added. Read the guide here!
Use "/speak" for quick tips!

Making a Cube

/make

• Add the colors of each piece in a face, in the order shown alongside, in captial letters

• While entering the White and Yellow faces, remember to keep the Green face facing you

• The picture on the left is for 3x3, but follow this order for 2x2 as well

/makeSolved

Option : 3 for 3x3, 2 for 2x2, empty for solving held cube

Executing Moves

/do

Options :

• moves - Moves to be executed
• show_type - s -> shows your changed cube, empty -> doesnt show your changed cube on chat

/rev

Options :

• moves - Moves to be reverse executed
• mode - s -> returns only the reversed algorithm, empty -> executes your moves on the cube

Solving the Cube

/solve

Solves your cube and returns the solution. Lets you know if you have entered an impossible cube or something is wrong in your input.

Timing

/addTime

Options :

• mins - Number of minutes; 0 if nothing
• secs - Number of seconds
• ms - Number of milliseconds

/get_best

Tells you your best time!

/get_avg

Tells you your average time!

For the entire command list and an explanation for each of them, read the Docs

💁 Support

If you have any suggestions for the bot, or any new commands to be added, use " /suggest " on discord and I'll look into it!

If you are facing any issue in the /solve command, send me your scramble through the same method