- Table of Contents
- How to use TwitchMakesATAS
- Commands
- Major Syntax Note
- General Commands
- TAS Commands
- WRITE frame, buttons, [length=1], [pattern=1]
- REMOVE frame, length, [buttons = "abstudlr"]
- OVERWRITE frame, buttons, [length = 1]
- INSERT frame, [length = 1], [buttons = ""]
- DELETE frame, [length = 1]
- IGNORE
- REVERT tas-name
- RETRACT
- FRAME frame | FRAME ±frame offset
- PLAY [start=0], [end=length of the movie]
- PIANO frame
- REFRESH
TwitchMakesATAS works off a democratic system. Each request to change the TAS is a 'vote'. Whichever command gets the most votes, wins. If there is a tie, then the winner is chosen by random chance.
There are two types of voting in the bot.
- TAS votes - Votes to change the TAS. Includes writing, removal, reverting.
- Other votes - Votes for other elements of the stream. Includes going to a frame, playing from the start, or changing the piano roll.
TAS votes occur every 45 seconds. These votes are the ones displayed on the stream. They include
- Writing to the TAS. Example command:
WRITE 1, t, 2 - Removing from the TAS. Example command:
DELETE 50, 20, ab - Reverting to an older version of the TAS. Example command:
REVERT "11-05 V30"
After 45 seconds have passed, each TAS vote is counted and the command with the most votes is executed. If there are 3 votes in which no votes have been cast, however, the 45 second timer freezes until the next vote is cast.
These votes revolve around other elements of the TAS creation process. This includes
- Playing the TAS. Example command:
PLAY 161, 803 - Going to a frame in the TAS. Example command:
FRAME 455 - Changing the starting frame of the piano roll. Example command:
PIANO 3141
If an 'other' vote is cast, it will require a majority (three-fifths) of viewers to agree to the command in order for it to be executed. This is because I believed these features would be better accessed whenever everyone agreed to do it, instead of having to wait for the vote timer to hit 0. This will happen exclusively in chat.
Commands in the bot are signified by a capitalised starting word (except for general commands). Examples include PLAY 31,41, WRITE 2718,abr, FRAME 250, REVERT "12-05 V10".
Each argument in a command is seperated by a comma. Commands are not seperated by whitespace. It does not matter if the comma is surrounded by whitespace, all that matters is that there is a comma.
Commands are also case-insenstive, barring the first word.
Example: WRITE 1, at, 33, 2 is equivalent to WRITE 1,aT,33,2 and WRITE 1, AT , 33 ,2.
How do you know that the command has failed? The bot wouldn't have responded to your message, or it doesnt appear on the stream.
These commands are the only commands not to use the capitalised starting word format, instead starting with a backtick (`). These commands take no arguments.
Links you here.
Links you to the GitHub repo
Makes the bot respond with how much time is left on the vote. Really only needed if you have extreme delay on your stream, though. The time left is on the stream itself.
Shows how long the bot has been online.
These commands are the ones that you've seen earlier in the document. These commands alter the TAS, or interact with other elements of the stream, such as FCEUX or the piano roll.
Arguments will be displayed like this: COMMAND required-arg,[optional-arg=default]
Casts a vote to write to the TAS.
frame states the starting frame.
buttons is which buttons are to be pressed, written as a string of the characters abstudlr. Order is not necessary for the buttons. To write B and R, use the string br or rb.
length states how many future frames will also have the buttons written too (This does NOT overwrite other frames.). Defaults to 1 frame.
pattern is a number that changes the firing pattern of the button. Example: WRITE 1,t,32,2 writes T (start) to 32 frames (ending at frame 33), with the pattern On, Off, since 2 in binary is 10.
To write the "One Quarter" pattern (as it's known in the TAS Editor), first write it out in binary, where 1 is pressed and 0 is not pressed. 1000 is equal to 8 in base 10, and that number is what you would use for the pattern argument. By default, pattern is set to 1, which means its active each frame.
Removes all instances of the buttons specified from the starting frame to the starting frame plus the length.
frame is the starting frame.
length is how many future frames are also affected.
buttons specifies which inputs to remove. Defaults to all buttons, clearing an entire frame.
Same as WRITE but removes the existing data from the frames being written to.
Adds one new frame while pushing all future frames forward. Defaults to an empty frame.
Removes one remove while pushing all future frames back.
Votes to do nothing. Could be useful if someone tries to vote for something malicious (e.g. REMOVE 0,100000000).
NOTE: This command is not present in the current version of the bot.
Reverts the TAS to a previous state, the name chosen from the TAS History section, when that gets implemented.
Removes your vote from the pool. You do not need to call RETRACT if you are changing your vote. Changing your vote automatically retracts your previous one.
Goes to the frame specified. Requires a majority vote. If the number is preceded by a plus or a minus, it will go to the last viewed frame plus the offset given. Requires a majority vote.
Plays the TAS from the specified starting frame to the end frame. If no arguments are specified, then it plays the whole movie. Requires a majority vote.
Changes the piano roll to start from the frame specified. Requires a majority vote. Note: Updating the piano roll takes about a minute and will freeze other GUI elements. Use with care.
Refreshes the piano roll. Requires a majority vote. Note: Updating the piano roll takes about a minute and will freeze other GUI elements. Use with care.