Skip to content

Latest commit

 

History

History
73 lines (58 loc) · 2.71 KB

README.md

File metadata and controls

73 lines (58 loc) · 2.71 KB
Raw

TwitchSolvesCubeV2

Features

Various cube perspectives
Back of cube is visible with "hints"
Play Time: Followers 8 Minutes vs Non-Followers 5 Minutes
Users get kicked after 2 minutes of not entering a valid move

Chat Commands!

  • !joinq or !jq
  • !leaveq or !lq
  • !queue or !q
  • scramble completes a random scramble on the puzzle
  • scramble <alg> set a custom scramble.
    • Example scramble R U' L2 U2 B R2 B2 R2 D2 B' F2 L2 U2 F' U' F' L B' U2 L' F2
  • !topright or !tr (this is the default)

  • !sidebyside or !sbs

  • !blind or !bld

  • !normal or !norm (brings back cube from blind)
  • !speednotation or !sn

  • !normalnotation or !nn to remove speednotation

Contributing

Install Requirements

NodeJs >=19 and Git

Font (Optional)

Rubik

How to create tokens.*.json

Follow Steps 1 & 2 from here https://twurple.js.org/docs/examples/chat/basic-bot.html
To make things easier you may use https://reqbin.com/post-online for your POST request (Use this site at your own risk)

Example link for scopes, enter your CLIENT_ID and REDIRECT_URI.

https://id.twitch.tv/oauth2/authorize?client_id=<CLIENT_ID>&redirect_uri=<REDIRECT_URI>&response_type=code&scope=chat:read+chat:edit+whispers:edit+whispers:read+channel:moderate+moderator:read:followers

Place the tokens.*.json file in the server folder.

How to create config.json

Paste in your clientId, clientSecret, and channelName you want to connect to.

Setting Up Dev Enviroment

Run line by line

git clone https://github.com/TwitchSolvesCube/TwitchSolvesCubeV2  

cd TwitchSolvesCubeV2

Installs npm packages

npm run packages

Starts the client and server

npm run tsc

License

This project is under GPL3 which means you are free to use this program, but must publicly publish any code that uses it. View full license for exact details here.