Difference between revisions of "5eCrawler: User Guide"

From 5etools Community Wiki
Jump to: navigation, search
m (Content)
m (A Secret)
(One intermediate revision by the same user not shown)
Line 41: Line 41:
 
== History ==
 
== History ==
 
::The 5eCrawler is a separate project from 5eTools, and arose when [https://avrae.io Avrae's] developer (Andrew Zhu), was hired to work with D&D Beyond. TheZhu did an ''INCREDIBLE'' job with his project.
 
::The 5eCrawler is a separate project from 5eTools, and arose when [https://avrae.io Avrae's] developer (Andrew Zhu), was hired to work with D&D Beyond. TheZhu did an ''INCREDIBLE'' job with his project.
:: The developer of 5eCrawler has removed some features (character sheets;Play by post battle management) and reworked and rewritten the parser and dataset. Making '''5eCrawler''' the most accurate means to look up 5e data within Discord, and has expanded its dataset to include many more categories to lookup.
+
:: The developer of 5eCrawler has removed some features (character sheets;Play by post battle management) and reworked and rewritten the parser and dataset. Making '''5eCrawler''' the most accurate means to look up 5e data within Discord, and has expanded its dataset to include many more categories to its lookup.
 +
:: and its SRD compliant.
  
 
<br/>
 
<br/>
Line 61: Line 62:
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
  
You should visit the 5eTools discord server and maybe ask some questions about 5eCrawler...
+
You should visit the 5eTools discord server and talk about your experiences with 5eCrawler...
  
 
</div></div>
 
</div></div>

Revision as of 20:26, 10 November 2019

framless
RC 5

Short Introduction

5eCrawler is an current in-development project from a single developer, building from where Avrae stopped formal development. It is part a suite of such tools DiscordCrawler, PokemonCrawler, and GithubCrawler.
All of these are Discord bots. If you are not familiar with Discord, it is, effectively a chat client with some voice and screen sharing services, and has rapidly become the most popular platform for Gaming, both online and for Tabletop/Virtual tabletops.


Where to start...

You're likely here because you've not used it and would like to get it as part of your Discord Server.
So, for that let's directly link to where you likely want to go...



Inviting It

You can easily invite the 5eCrawler bot to your own server by following link!
Regarding Discord Rights
When invited the Bot will request 5 permission which it will by default be assigned, of the 5 permissions asked, 4 are optional and 1 mandatory for optimal usage of the capabilities of the bot.
The one that is required, if it is not allowed, when one of the bot's commands are issued/requested, it will attempt to take the action, and if not able to do so it will leave the server. If added again and its needed rights not provided, it will eventually block the server and will not be addable in the future, be forewarned.


Mandatory:
  • Manage Messages - this allows the bot to remove messages from other users.
Optional:
  • Manage Webhooks - There are 2 ways for the quote command to function. One where it will use a webhook to give a reply as the person who quoted the message. Or one where it will just reply in text, but as the bot.
  • Attach Files - Some commands or replies will let the bot attach images/files, without this permission it will not be able too.
  • Add Reactions - For the Anon/Delivery the bot requires to be able to add reactions to messages that are sent.
  • Read History - For some things to work (edit message, add reactions) the bot requires to be able to read the history of the channel. If it lacks this permission, but does have. Add Reactions, it will pelt you with 'Permission not found.'

History

The 5eCrawler is a separate project from 5eTools, and arose when Avrae's developer (Andrew Zhu), was hired to work with D&D Beyond. TheZhu did an INCREDIBLE job with his project.
The developer of 5eCrawler has removed some features (character sheets;Play by post battle management) and reworked and rewritten the parser and dataset. Making 5eCrawler the most accurate means to look up 5e data within Discord, and has expanded its dataset to include many more categories to its lookup.
and its SRD compliant.


Code

There is currently no means to get the code. When it is officially released, there will be a public Github.


Content

The bot draws upon a number of resources, and RAW (Rules as Written / Offical) SRD content is what it references.



A Secret

shhhhhhhh......

You should visit the 5eTools discord server and talk about your experiences with 5eCrawler...