Skip to content

Commit

Permalink
fix up links
Browse files Browse the repository at this point in the history
  • Loading branch information
otothea committed Jan 24, 2020
1 parent 5f0053e commit 415a63b
Show file tree
Hide file tree
Showing 13 changed files with 42 additions and 41 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/_build
2 changes: 1 addition & 1 deletion docs/command.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# !command
The `!command` command is used to create/edit/delete/enable/disable [custom commands](/account/commands) via chat
The `!command` command is used to create/edit/delete/enable/disable [custom commands](https://botisimo.com/account/commands) via chat

- `delete` - Delete command [view docs](#delete)
- `disable` - Disable command [view docs](#disable)
Expand Down
24 changes: 12 additions & 12 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ Below is a list of the default commands available with Botisimo. They are groupe
- `!buy <key>` - Purchase an item from the shop using currency
- `!clip [username]` - Responds with the top Twitch clip for the current user or the `username` (must be a twitch username)
- `!commands` - Receive list of custom commands available to you via whisper
- `!enter` - Enter the giveaway [view docs](/docs/enter)
- `!enter` - Enter the giveaway [view docs](</enter>)
- `!help` - Link to Botisimo docs
- `!leaderboard` - Display link to the leaderboard
- `!optin` - Opt in to Level Up and DyneOps announcements for your user
- `!optout` - Opt out of Level Up and DyneOps announcements for your user
- `!queue` - Join or leave player queue [view docs](/docs/queue)
- `!queue` - Join or leave player queue [view docs](</queue>)
- `!rank [username]` - Display rank information for the current user or the `username`
- `!reddit <subreddit>` - Get the latest post(s) for a subreddit. Returns top 10 results in Discord and top result in Twitch & Mixer
- `!shop` - Display available shop items for channel in chat
- `!songrequest <youtube_video_url>` or `!sr <youtube_video_url>` - Request a song (works with the [music player](/account/music))
- `!songrequest <youtube_video_url>` or `!sr <youtube_video_url>` - Request a song (works with the [music player](https://botisimo.com/account/music))
- `!stackoverflow <query>` - Search Stackoverflow questions. Returns top 10 results in Discord and top result in Twitch & Mixer
- `!twit <username>` or `!twitter <username>` - Responds with the latest tweet from the given `username` (must be a twitter username)
- `!vote` - Vote in poll [view docs](/docs/vote)
- `!vote` - Vote in poll [view docs](</vote>)
- `!wikipedia <topic>` or `!wiki <topic>` - Search Wikipedia topics. Returns top 10 results in Discord and top result in Twitch & Mixer

#### Twitch, Mixer, & Youtube only
Expand All @@ -37,24 +37,24 @@ Below is a list of the default commands available with Botisimo. They are groupe

- `!login [platform=twitch]` - Receive a link to authorize chat mirroring for your Discord user (platform can be `twitch` or `mixer`)
- `!logout [platform=twitch]` - Disable chat mirroring for your Discord user (platform can be `twitch` or `mixer`)
- `!playlists` - List Youtube playlists from connected account (must have [linked youtube account](/account/connections))
- `!playlists` - List Youtube playlists from connected account (must have [linked youtube account](https://botisimo.com/account/connections))

## Mod Commands

#### All platforms

- `!command` - Manage custom commands [view docs](/docs/command)
- `!command` - Manage custom commands [view docs](</command>)
- `!gameall <game>` - Set the game on all connections on the account
- `!give <amount> <username> [username] [username] ...` - Give currency to 1 or more users
- `!give <amount> all` - Give currency to everyone
- `!give <amount> chat` - Give currency to everyone currently in chat
- `!giveaway` - Manage giveaways [view docs](/docs/giveaway)
- `!giveaway` - Manage giveaways [view docs](</giveaway>)
- `!irregular <username>` - Remove this user from regulars
- `!nextsong` or `!ns` - Skip the current song (works with the [music player](/account/music))
- `!nextsong` or `!ns` - Skip the current song (works with the [music player](https://botisimo.com/account/music))
- `!ping` - Responds with `pong` in chat (quick way to check if Botisimo is responding in your channel)
- `!poll` - Manage polls [view docs](/docs/poll)
- `!poll` - Manage polls [view docs](</poll>)
- `!regular <username>` - Add this user to regulars
- `!timer` - Manage custom timers [view docs](/docs/timer)
- `!timer` - Manage custom timers [view docs](</timer>)
- `!titleall <title>` - Set the title on all connections on the account
- `!winner [message] [|minutes]` - Pick a random winner from chat who sent a message in last 10 minutes. Optionally, use the `message` to filter users who typed a specific message (default: any message). You can also alter the minutes by using the `|` character followed by a number (example: `!winner enter|30`)

Expand All @@ -65,7 +65,7 @@ Below is a list of the default commands available with Botisimo. They are groupe

#### Discord only

- `!bridge` - Manage Discord bridges [view docs](/docs/bridge)
- `!bridge` - Manage Discord bridges [view docs](</bridge>)
- `!clear <number>` - Clear a number of messages from the chat (max: 99)
- `!subscribe <platform> <username>` - Subscribe to other Botisimo users' stream up announcements (platform should be `twitch` or `mixer`)
- `!unsubscribe <platform> <username>` - Unsubscribe from other Botisimo users' stream up announcements (platform should be `twitch` or `mixer`)
Expand All @@ -74,7 +74,7 @@ Below is a list of the default commands available with Botisimo. They are groupe

#### All platforms

- `!leave` - Disable Botisimo for your channel (can be reenabled on the [connections page](/account/connections) of your account)
- `!leave` - Disable Botisimo for your channel (can be reenabled on the [connections page](https://botisimo.com/account/connections) of your account)
- `!prefix [prefix=]` - Get or set the Botisimo command prefix (only affects Botisimo's built-in commands)

###### * We are a participant in the Amazon Services LLC Associates Program, an affiliate advertising program designed to provide a means for us to earn fees by linking to Amazon.com and affiliated sites.
16 changes: 8 additions & 8 deletions docs/directives.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Response Directives
Response directives are used to make dynamic actions for your [custom commands](/account/commands). Directives will be processed after [response variables](/docs/variables) and in the order they appear in the response text.
Response directives are used to make dynamic actions for your [custom commands](https://botisimo.com/account/commands). Directives will be processed after [response variables](</variables>) and in the order they appear in the response text.

- `cache` - Cache a value [view docs](#cache)
- `chain` - Chain multiple responses together [view docs](#chain)
Expand Down Expand Up @@ -27,7 +27,7 @@ If a directive requires a parameter it will be wrapped in `< >` and if the param
## cache
Saves a value temporarily to be used in other commands

Fetch values from the cache using the [cache variable](/docs/variables#cache). The cache is not meant to be used as a long term or permanent place to store any sensitive or important information. This cache could be reset at any time without warning.
Fetch values from the cache using the [cache variable](</variables:cache>). The cache is not meant to be used as a long term or permanent place to store any sensitive or important information. This cache could be reset at any time without warning.

#### Usage
$[cache `<key>` `<seconds>` `<value>`]
Expand All @@ -50,9 +50,9 @@ $[chain]

Breaks the response into multiple responses

- [Pro members](/membership.html) are limited to chaining 3 responses
- [Master members](/membership.html) are limited to chaining 5 responses
- [Guild members](/membership.html) are limited to chaining 10 responses
- [Pro members](https://botisimo.com/membership.html) are limited to chaining 3 responses
- [Master members](https://botisimo.com/membership.html) are limited to chaining 5 responses
- [Guild members](https://botisimo.com/membership.html) are limited to chaining 10 responses

`!chain`
-> `This is the first response`
Expand Down Expand Up @@ -160,7 +160,7 @@ Removes the user from the wizard role and responds
`!muggle` -> `You have been removed from the wizard role`

## event
Sends a custom event to the [events overlay](/account/overlays)
Sends a custom event to the [events overlay](https://botisimo.com/account/overlays)

#### Usage
$[event `[text]` | `[subtext]` | `[milliseconds=3000]` | `[thumbnail]` | `[sound]`]
Expand Down Expand Up @@ -224,7 +224,7 @@ Sends the response but does not relay it to the other platforms
Same as [$[cooldown]](#cooldown) but applied before parsing command variables

## precost
Same as [$[cost]](#cost) but applied before parsing [command variables](/docs/variables)
Same as [$[cost]](#cost) but applied before parsing [command variables](</variables>)

## predelay
Same as [$[delay]](#delay) but applied before parsing command variables
Expand Down Expand Up @@ -263,7 +263,7 @@ Sends the response in a direct message
`!whisper` -> `This response will be sent in a direct message`

## Advanced Example
This example shows you how to combine the `$(pick)` and `$(repeat)` [response variables](/docs/variables) with the `$[cost]` and `$[give]` response directives to make a !gamble command
This example shows you how to combine the `$(pick)` and `$(repeat)` [response variables](</variables>) with the `$[cost]` and `$[give]` response directives to make a !gamble command

#### Example
$[cost 100] $(pick $(repeat 5 $[give 100] You broke even +0 | )$(repeat 5 You lost it all -100 | )$(repeat 5 $[give 150] You got a return on your investment +50 | )$[give 300] You hit the jackpot! +200)
Expand Down
6 changes: 3 additions & 3 deletions docs/dyneops.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

DyneOps is a fun chat game that will test your memory and put your 10-key numpad typing skills to the test. This page defines some important terms and concepts to understand to be able to play DyneOps.

If you are a streamer and you have Botisimo in your channel, you can [enable DyneOps here](/account/dyneops).
If you are a streamer and you have Botisimo in your channel, you can [enable DyneOps here](https://botisimo.com/account/dyneops).

**NOTE:** If viewers are not receiving whispers from Botisimo in Twitch, they may need to send it a whisper first to get it working for their account.

Expand Down Expand Up @@ -86,7 +86,7 @@ That's it, now you're ready to TranceDecrypt HYPERDynes!

## Goldfrags

Goldfrags are the currency of DyneOps and can be gained randomly as you chat or by unlocking Dynes. Viewers can exchange their currency for items in the [Shop](#shop). If you are a streamer using Botisimo you can [change the currency name here](/account/settings)
Goldfrags are the currency of DyneOps and can be gained randomly as you chat or by unlocking Dynes. Viewers can exchange their currency for items in the [Shop](#shop). If you are a streamer using Botisimo you can [change the currency name here](https://botisimo.com/account/settings)

## Shop

Expand Down Expand Up @@ -114,7 +114,7 @@ If you have enough currency to buy the item, Botisimo will announce the purchase
Botisimo: @streamer TwitchRPG TwitchRPG TwitchRPG @viewer1 has purchased Song Request!
```

If you are a streamer, you can [configure your shop here](/account/shop).
If you are a streamer, you can [configure your shop here](https://botisimo.com/account/shop).

## Decryption Chips

Expand Down
2 changes: 1 addition & 1 deletion docs/enter.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# !enter
The `!enter` command is used to enter [giveaways](/account/giveaways) via chat
The `!enter` command is used to enter [giveaways](https://botisimo.com/account/giveaways) via chat

## Enter giveaway
Enter the current giveaway
Expand Down
4 changes: 2 additions & 2 deletions docs/giveaway.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# !giveaway
The `!giveaway` command is used to create/view/close/end [giveaways](/account/giveaways) via chat
The `!giveaway` command is used to create/view/close/end [giveaways](https://botisimo.com/account/giveaways) via chat

**NOTE:** You can display the active giveaway in your stream using the [stream overlay](/account/overlays) for giveaways
**NOTE:** You can display the active giveaway in your stream using the [stream overlay](https://botisimo.com/account/overlays) for giveaways

- `close` - Close entry for the current giveaway [view docs](#close)
- `end` - End a giveaway [view docs](#end)
Expand Down
4 changes: 2 additions & 2 deletions docs/graphql.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ The Botisimo GraphQL API endpoint is located at:

## Authentication

The Botisimo GraphQL API requires a Client ID to make authenticated requests. You can obtain your Client ID by visiting your [account settings](/account/settings) and copying the Client ID found in the "Developer" section. Keep this Client ID a secret because anyone who has it has access to your account.
The Botisimo GraphQL API requires a Client ID to make authenticated requests. You can obtain your Client ID by visiting your [account settings](https://botisimo.com/account/settings) and copying the Client ID found in the "Developer" section. Keep this Client ID a secret because anyone who has it has access to your account.

This Client ID will need to be included as a `Client-ID` header in all GraphQL requests.

## Query the API

You can access the Botisimo GraphQL API endpoint using [cURL](https://curl.haxx.se/) or any other HTTP client. For the following example, make sure to replace **<CLIENT_ID>** with the Client ID you copied from your [account settings](/account/settings).
You can access the Botisimo GraphQL API endpoint using [cURL](https://curl.haxx.se/) or any other HTTP client. For the following example, make sure to replace **<CLIENT_ID>** with the Client ID you copied from your [account settings](https://botisimo.com/account/settings).

### cURL

Expand Down
4 changes: 2 additions & 2 deletions docs/poll.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# !poll
The `!poll` command is used to create/view/close/end [polls](/account/polls) via chat
The `!poll` command is used to create/view/close/end [polls](https://botisimo.com/account/polls) via chat

**NOTE:** You can display the active poll in your stream using the [stream overlay](/account/overlays) for polls
**NOTE:** You can display the active poll in your stream using the [stream overlay](https://botisimo.com/account/overlays) for polls

- `close` - Close voting for a poll [view docs](#close)
- `end` - End a poll [view docs](#end)
Expand Down
2 changes: 1 addition & 1 deletion docs/quotes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Twitch.Center Quote System
Botisimo does not have a quote system, however you can use the `$(fetch)`, `$(query)`, and `$(urlencode)` [response variables](/docs/variables) combined with a third-party api to make your own.
Botisimo does not have a quote system, however you can use the `$(fetch)`, `$(query)`, and `$(urlencode)` [response variables](</variables>) combined with a third-party api to make your own.

## What can it do?

Expand Down
2 changes: 1 addition & 1 deletion docs/timer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# !timer
The `!timer` command is used to create/edit/delete/start/stop [custom timers](/account/timers) via chat
The `!timer` command is used to create/edit/delete/start/stop [custom timers](https://botisimo.com/account/timers) via chat

**NOTE:** Timers are only activated if 10 or more messages have been sent since the last time it was activated

Expand Down
14 changes: 7 additions & 7 deletions docs/variables.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Response Variables
Response variables are used to make dynamic [custom command](/account/commands) responses. See also [response directives](/docs/directives).
Response variables are used to make dynamic [custom command](https://botisimo.com/account/commands) responses. See also [response directives](</directives>).

- `Arguments` - Resolve arguments from command [view docs](#arguments)
- `bot` - Resolve bot username [view docs](#bot)
Expand Down Expand Up @@ -88,7 +88,7 @@ $(botplain)
## cache
Resolve a value from the cache

Values can be save to the cache using the [cache directive](/docs/directives#cache).
Values can be save to the cache using the [cache directive](</directives:cache>).

#### Usage
$(cache `<key>`)
Expand Down Expand Up @@ -310,7 +310,7 @@ $(rotate `<option>` | `[option]` | `[option]` | ...)
`!rotate` -> `First response`

## songrequester
Resolve the requester text of the current song playing on the [music player](/account/music)
Resolve the requester text of the current song playing on the [music player](https://botisimo.com/account/music)

#### Usage
$(songrequester)
Expand All @@ -323,7 +323,7 @@ Outputs ` (requested by @username)` if the song was requested by a user or outpu
`!song` -> `Now Playing: Culture Code - Make Me Move (feat. Karra) [NCS Release] (requested by @username)`

## songthumbnail
Resolve the url to the thumbnail of the current song playing on the [music player](/account/music)
Resolve the url to the thumbnail of the current song playing on the [music player](https://botisimo.com/account/music)

#### Usage
$(songthumbnail)
Expand All @@ -334,7 +334,7 @@ $(songthumbnail)
`!songthumbnail` -> `https://i1.ytimg.com/vi/vBGiFtb8Rpw/mqdefault.jpg`

## songtitle
Resolves the title of the song currently set to play on the [music player](/account/music)
Resolves the title of the song currently set to play on the [music player](https://botisimo.com/account/music)

#### Usage
$(songtitle)
Expand All @@ -345,7 +345,7 @@ $(songtitle)
`!song` -> `Now Playing: Culture Code - Make Me Move (feat. Karra) [NCS Release]`

## songurl
Resolves the url of the song currently set to play on the [music player](/account/music)
Resolves the url of the song currently set to play on the [music player](https://botisimo.com/account/music)

#### Usage
$(songurl)
Expand All @@ -356,7 +356,7 @@ $(songurl)
`!song` -> `Now Playing: https://youtube.com/watch?v=vBGiFtb8Rpw`

## songusername
Resolve the requester text of the current song playing on the [music player](/account/music)
Resolve the requester text of the current song playing on the [music player](https://botisimo.com/account/music)

#### Usage
$(songusername)
Expand Down
2 changes: 1 addition & 1 deletion docs/vote.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# !vote
The `!vote` command is used to vote in [polls](/account/polls) via chat
The `!vote` command is used to vote in [polls](https://botisimo.com/account/polls) via chat

If a command argument is required it will be wrapped in `< >` and if the argument is optional it will be wrapped in `[ ]`.

Expand Down

0 comments on commit 415a63b

Please sign in to comment.