Skip to content

Getting Started

perpil edited this page Aug 25, 2022 · 90 revisions

Installation

  1. Install Tampermonkey if you don't already have it.
  2. Install Speedrun
  3. Reload this page

See some examples

Learn the basics

Using a template

A template reduces the amount of code you need to write to do something. Surround your content with code fences, put the #template you want to use on a new line and enter your content. This will use the copy template to copy something to the clipboard.

#copy
This was copied by ${user}

Prompting for inputs

To prompt the user to enter something, surround what you want to prompt the user for with 3 tildes.

#copy
This is ${user}'s favorite color: ~~~Favorite Color~~~

Running Javascript

To use Javascript wrap content with ${}

#copy
This is ${user.toUpperCase()}'s favorite color: ~~~Favorite Color~~~

Getting Credentials

Hold on champ, first you need to configure credentials.

Using it with AWS credentials

Create Speedrun Roles

Follow this wiki to create the necessary Speedrun roles and to register your AWS account

Install srinit

srinit is a command line tool that authenticates you with GitHub so you can assume speedrun roles you have permissions to

#copy
python3 -m pip install --extra-index-url https://speedrun.nobackspacecrew.com/packages srinit

How it works

Clone this wiki locally