Astra Documentation. Release. Meow.tf

Transcription

1 Astra Documentation Release Meow.tf Aug 30, 2017

2

3 Contents: 1 Setup/Options 1 2 Commands 3 3 Features 7 4 Features 13 5 Inviting to your server 15 6 Development 17 7 Setup/Options 19 i

4 ii

5 CHAPTER 1 Setup/Options Channel Output The Text Channel will be used every time Astra needs to output some text, but is currently playing media or saying something else. Think of it as a fallback channel. It will be set to whatever channel it is said in, or a channel name starting with #. Content will be used when outputting content module messages (YouTube Publishes, Twitch Statuses, etc) Message will be used for Join/Leave messages, and possibly something else in the future. Usage:!channel <text/content/message> [#channel] 1

6 2 Chapter 1. Setup/Options

7 CHAPTER 2 Commands Location, Time, and Weather Location Setting your location can provide responses to many commands that are tailored to your location, such as the time trigger returning the time in your timezone, or weather for your hometown. To set your location, use the following text command:!location city/state/country We use Google s Location API to resolve this to a Latitude/Longitude, which you can get by using!location without any arguments after setting it. Time You can get the current time by saying: what time is it This will use either GMT or the timezone for your specified location. Weather The weather command requires you to set your location, as seen above. You can get the current weather for your location by saying: what s the weather like 3

8 Media Commands Playing Media Playing media can be done using the voice command play <query> You can also add YouTube videos directly using the text command:!play <url or query> Controlling the queue Queue items can be skipped by saying skip or using the text command!skip. The queue can be cleared by using the text command!clear. This will not skip the current song. To stop playback and clear the queue, say stop or use the text command!stop. Adjusting the volume Adjusting the volume can be done using the voice command: volume Or the text command:!volume You can also say louder or softer to raise/lower the volume by 10% each time. Setting the default volume Astra s default volume can be set for voice and media. The sane values of 100% for voice, and 20% for audio are used. When the command is used without arguments, it will show the current values.!defaultvolume <voice/media> Poll Commands Starting a poll To start a standard poll, use the following command:!poll <question> option1 option2... There can be as many options as you want. 4 Chapter 2. Commands

9 Starting a timed poll A timed poll will automatically end after the specified time limit (in minutes) To start a timed poll, use the following command:!tpoll question <time in minutes> option1 option2... Voting in a poll To vote in a poll, use the command!vote along with the option number (starting at 1), like so:!vote 1 Ending a poll To end a poll, use the following command:!endpoll Sysadmin/Computer Utility Commands GeoIP Lookup Performs a GeoIP lookup with ip-api.!geo <ip address/hostname> Temporary Channels Overview Temporary channels work just like Mumble Temp Channels. Join a voice channel, then use the command to create a channel that exists as long as someone is in it. Create a temporary channel Temporary channels can be named whatever you want, and have a user limit. To use names with spaces, enclose the first argument in quotes.!tempchannel <name> [user limit] Utility Commands Server Information Retrieve server information, such as server age, users, etc.!serverinfo 2.4. Sysadmin/Computer Utility Commands 5

10 User Information Retrieve information about the user querying the bot, such as discord age, how long they ve been in the server, and roles.!userinfo Calculator Retrieve the result of a standard numeric problem!c / 2 Wolfram Alpha Query Wolfram Alpha for something. This is not quite perfect, yet.!wa <query> Urban Dictionary Query Urban Dictionary for something.!ud <query> Voice Commands Voice Commands are matched by full words/blocks of text, such as holding down the push to talk for only the command. Text Commands Text Commands can be done in any channel with the prefix! (one exclamation point). 6 Chapter 2. Commands

11 CHAPTER 3 Features Content Creators Monitoring Astra can monitor Twitch.tv streams and YouTube to notify fans whenever you go live or post a new video! Content Channel The Content Channel will be used every time Astra detects a channel change (Going live or a new published video). It will set it to the channel the command is said in, or a channel name starting with #. Usage:!channel content [#channel] Viewing tracked channels To view tracked channels, use the!tracked text command.!tracked Tracking channels To track a channel, use the!track text command.!track <twitch/youtube> <channel name> 7

12 Untracking channels To untrack a channel, use the!untrack text command.!untrack <twitch/youtube> <channel name> Setting a message on content updates To set a message to go along with content updates, use the message command.!message <twitch/youtube> <some text> Variable replacement is available, with {channel} being universal for both YouTube and Twitch. List tracked channels To list all channels monitored by the bot, use!tracked. It will return a list of channels for Twitch and YouTube. Detection delay Channel state changes on Twitch use Twitch s PubSub API, meaning near-instant updates of state. We also poll Twitch for statuses every minute like every other major bot. For YouTube, they officially support a protocol called PubSubHubbub. This gives instant notifications of published videos. Join/Leave Messages Messages Astra can send messages when members join and leave the server. Message Channel The message channel will be used to send messages when people join or leave the server. Usage:!channel message [#channel] Setting the join or leave messages To change the join/leave message, use the!message text command.!message <join/leave> Message enclosed in quotes You can use the replacement variables {highlight} and {username} to replace the text with a highlight/mention, or their username. 8 Chapter 3. Features

13 Moderation Module Information This module is currently being developed. Don t expect it to be stable. Set the logging channel!channel moderation #channel Toggle link removal for a channel Retrieve information about the user querying the bot, such as discord age, how long they ve been in the server, and roles.!moderation channel #channel remove_links <enable/disable> #channel can also be global to remove links server wide. Filter attachments Attachments can be filtered, only allowing images, videos, etc. Filters are based on mime types, so you can allow only png images if you wish. It uses a string compare on the type specified vs actual type. Example:!moderation channel #channel limit_attachments [any number of attachment types...]!moderation channel #channel limit_attachments image video Overwatch Overwatch patch notes Astra will notify you when a new Overwatch patch note is added. Set the overwatch channel type, like shown below to enable.!channel overwatch [#channel] Overwatch statistics Astra can query Overwatch using and show basic statistics. Linking/Unlinking Battlenet You may link your battlenet tag, region, and platform to quickly check your stats in the future. Usage:!linkbnet <battletag> <region> <platform> 3.3. Moderation 9

14 If you no longer want to have it linked, you may also unlink it. Usage:!unlinkbnet Looking up Quickplay stats To lookup Quickplay stats, use the following command:!ow [battletag] [region] [platform] Looking up Competitive stats To lookup Competitive stats, use the following command:!owcomp [battletag] [region] [platform] Overwatch Pugs Overwatch PUG A PUG is a Pick-Up Game, a well-known term in many games. They may also be considered a scrim with friends. Prerequisites Astra needs the Manage Channels permission, Astra and all other bots need the Move Members permission. There needs to be a voice channel with Pug Lobby (exact capitalization) in the name, there can be emojis and other text before/after, but not in between. There can be multiple lobby channels. You will need at least one of the following bots in the server, to allow us to move more people than the rate limit allows for. Bots: OWPugBot Starting a lobby A lobby is a group of players that wish to split into teams. You can define as many teams as you want/have players for. To start a lobby with a specified number of leaders, and let people volunteer:!lobby <number of leaders> [players per team] [pick method] Pick method can be one of the following: single (One - One picking) onetwo (One - Two - Two, Two - Two - One picking) To start a lobby with a specified list of leaders, use Discord 10 Chapter 3. Features

15 Volunteering for Captain To volunteer as a team captain, use the following command:!volunteer Picking players When it is your turn, the bot will mention you and tell you it s your pick. To pick a player, use Discord mentions with the following After all players are picked, the leaders will be moved to the respective team channels. Teams are matched in order, so team one against team two, team three and team four, etc. Ending your pug When your game has finished and you wish to return to the lobby, a player in the specific pug can use the!end command. This will return everyone to the lobby and remove the team channels. Enabling/Disabling features The feature command lets you check, enable, and disable features. As more work is done, more features will be toggleable.!feature check urbandictionary!feature enable urbandictionary!feature disable urbandictionary Available Features Below are the features you can toggle. Some disable a single command, while others disable a whole module. compliment insult media moderation tempchannel urbandictionary 3.6. Enabling/Disabling features 11

16 12 Chapter 3. Features

17 CHAPTER 4 Features Voice commands Faster and more efficient than other bots Media Playback Location, Time, and Weather Content Notifications (Twitch, YouTube) Moderation Overwatch Statistics and Patch Notes Overwatch Pick-Up Games Temporary Channels For more information about features, see the Features index 13

18 14 Chapter 4. Features

19 CHAPTER 5 Inviting to your server Invite Astra by visiting the link below and clicking the Invite button: Invite 15

20 16 Chapter 5. Inviting to your server

21 CHAPTER 6 Development Development on the bot is done randomly, but often. There might be bugs as it still doesn t have complete coverage with unit tests, and there will be restarts with new possibly untested versions. 17

22 18 Chapter 6. Development

23 CHAPTER 7 Setup/Options See Setup/Options. 19