# The Mercenary's guide to Avrae ## Avrae With a custom dice parser, Avrae is one of the most advanced dice rollers on Discord, capable of supporting pretty much every type of roll needed to play D&D. Advantage, disadvantage, and crits are built in, you can keep, drop, or reroll dice as needed, dice can explode, and dice can be bounded. ### Character Sheet Integration Avrae can read character sheets from **D&D Beyond**, **Dicecloud**, or a **Google Sheet**, automatically generating macros to roll attacks, ability checks, and saving throws. A player can then simply use a command to make a check, save, attack, or cast, and all necessary rolls will be resolved automatically. ### Getting Started If you already have a character on some other platform, or if you're thinking of making a new one with the idea of automating your rolls through Avrae, here are the steps to take to employ the bot for your utility: * Click [this link](http://gsheet2.avrae.io/) to be redirected to the automated Google Sheet! * Make a copy of the sheet to your own Google Drive by clicking **File**, then selecting **Make a copy**. * Input all your character info on the sheet!* * Share the sheet to Avrae! This can be done by clicking the big green share button at the top left of the Google Sheet. The email address you should share it to is **avrae-320@avrae-bot.iam.gserviceaccount.com** * Go on the server, and in the #bot-prem channel, type **"a!gsheet"** followed by the address to the Google Sheet you just made! After sending the message, Avrae should automagically load your character. For those of you who already have character sheets from **D&D Beyond**, or **Dicecloud**, you can follow the following steps, (modified by the platform you're using) to import your character into Avrae! * Use the command **"a!ddb"** to link your D&DBeyond account to Avrae. If you're having trouble with this, feel free to reach out to your local @Dragonspeaker for help. * Copy your character sheet URL address (from either D&DBeyond or Dicecloud), and run **"a!import"** followed by the address you just copied. ___ **No need to fill in the inventory section, as that's not tracked automatically by the bot.* \columnbreak ## Command Basics Avrae has vast potential for making long commands simple. It allows you to create and maintain commands. These commands can be used personally or shared with other users on a server. Avrae commands operate on two prongs that operate on different purposes, **Aliases**, and **Snippets**. ### Aliases Used to shorten commands that would require a large or lengthy amount of text to use, to run code before running an Avrae command, or to write your own custom command. (In many cases, aliases are used to track features or abilities) #### General Aliases ___ If you've properly set up your character sheet, and loaded it in, you're now able to execute the various commands made available by the discord integration of the bot! ___ **a!c init** - rolls initiative for your active character. ___ Making saving throws:\ **a!s con**\ **a!s cha**\ **a!s death** ___ Making ability checks:\ **a!c stealth**\ **a!c strength**\ **a!c arcana wis** - wisdom-based arcana check\ **a!conc** - concentration checks (append the DC at the end, if left blank, DC is 10) ___ Attacking and spells:\ On your sheet, you might have come across the attacks and notes section, as well as the additional attacks section on the second sheet. The weapons and attacks you placed in these sections will automatically be recognized by the bot.\ **a!a** - will give you a list of available attacks\ **a!a dagger**\ **a!spell** - will search for the spell you append on the end of the command.\ **a!cast** - will cast the appended spell \pagebreakNum ___ Monitoring/management:\ **a!char** - check which character you have active. Appending "list" will show you your available characters.\ **a!update** - updates your sheet\ **a!level** - will update your level to reflect your sheet\ **a!bag** - inventory management in discord!\ **a!coins**\ **a!sheet** - character details\ **a!vsheet** - *more* character details\ **a!lr** - long rest\ **a!sr** - short rest\ **a!g hp** - check your character's hitpoints. Appending a value at the end will add hp. Negative values will be subtracted.\ **a!g thp** - same as above, but with temporary hitpoints. ___ Looking up:\ **a!rule**\ **a!class**\ **a!classfeat**\ **a!race**\ **a!monster**\ **a!condition**\ **a!item** #### Manual Rolls In addition to automatic aliases, you are also afforded the ability to roll manually! Roll is used to roll any combination of dice in the XdY format. (1d6, 2d8, etc) ___ Multiple rolls can be added together as an equation. Standard Math operators and Parentheses can be used: () + - / * ___ Rolls can also be tagged with [text] for informational purposes. Any text after the roll will assign the name of the roll. ___ Rolling dice:\ **a!r 1d20**\ **a!r 1d20+5**\ **a!r 1d8+6**\ **a!r 1d10[cold]+2d6[piercing]** ___ Operators:\ **k** - keeps matched value\ **p** - drops matched value\ **rr** - rerolls all matched values until none match\ **ro** - rerolls all matched values once\ **ra** - rerolls one matched value, and adds to the total\ **mi** - sets minimum of each die\ **ma** - sets maximum of each die\ **e** - rolls an additional die for each matched value. Stops when none match ___ Selectors:\ **X** - literal X\ **lX** - lowest X\ **hX** - highest X\ **>X** - greater than X\ **<X** - less than X ___ Examples:\ **a!r 2d20kh1+4** - Advantage roll, using Keep Highest format\ **a!r 4d6mi2[fire]** - Elemental Adept, Fire\ **a!r 10d6ra6** - Wild Magic Sorcerer Spell Bombardment ### Snippets Used to augment dice rolls like saves, attacks, or ability checks. Bless and guidance are great examples of the snippet's functionality. Most of these snippets can be appended at the end of your aliases/manual rolls. ___ **adv** - advantage\ **dis** - disadvantage\ **-b** - adds a bonus to your rolls, append a value such as *1d4* or *-5* for the bonus to the 1d20.\ **-d** - adds a bonus to your damage.\ **gu** - guidance\ **bl** - bless\ **off** - attacking with your offhand.\ **prof** - adding your proficiency bonus.\ **-rr** - rerolls the same command a set amount of times.\ **-dc** - sets a DC for the roll.\ **-mc** - the minimum roll allowable. ## Custom Counters Your aliases and snippets can also affect and be affected by things known as **Custom Counters** or **CCs**. These are named variables with a finite value. Your character should already have some custom counters associated with them, such as hit dice and uses on class or racial features, but you might want to make a counter of your own for that extra customization! ___ **a!cc create "Name"** - will create a counter named "Name" bound to the active character. The counter can be modified by the following snippets:\ **-type bubble/default** - either radio bubbles or just a current/total string of text to display the value of the cc.\ **-min X** - will set the minimum value of the cc.\ **-max X** - the maximum value of the cc.\ **-reset** - counter will reset to max on a short/long rest, or not ever when "none". Default - will reset on a call of !cc reset.\ **-resetto** - the value to reset the counter to. Default - maximum.\ **-resetby** - rather than resetting to a certain value, modify the counter by this much per reset. Supports dice. \pagebreakNum ## Miscellaneous Commands The server also has some special aliases and snippet built into it! Accessing the complete list is made available by executing the following commands:\ **a!servalias**\ **a!servsnippet** ___ A few examples of these special commands:\ **a!jump** - shows how far/high your character can jump\ **a!hide** - the Hide action (checks stealth, but with flavor text.)\ **a!secret XdY** - hides your rolls! Great for secret rolls such as minigames.\ **a!piss** or **a!tinkle** - uhhhhh\ **a!scroll X** - has your character use a spell scroll! Rolls arcana for you, as well. ## Making Custom Commands Making your own custom counters is the first step to decking out your own custom heroes! The next is to make custom aliases. Aliases are operating on a modified version of Python, so those who know how to code in Python know how to make Aliases! You can find information on making aliases [here](https://avrae.readthedocs.io/en/stable/aliasing/aliasing.html), and [here](https://avrae.readthedocs.io/en/stable/aliasing/aliasing_tut.html). ___ In case you need the full list of Avrae commands built into the bot itself, check [this](https://avrae.io/commands) out. You can also subscribe to other people's aliases! These, along with your own homebrew spells, items, creatures, and any aliases, snippets, and variables you may have created can be accessed [here](https://avrae.io/dashboard/aliases). ___ If all this makes no sense to you, and all the code just looks like wingdings, feel free to contact your server **Dragonspeaker**! Just tag the role in the #tavern or in #bot-prem, and we'll try to help you out creating your own Aliases or troubleshooting faulty ones. ___ Have fun, Mercenary!