README.md

BlueQuery

BlueQuery is a discord bot that aims to improve players` Ark Survival Evolved gaming experience. This is done by providing tools to make tedious tasks simpler and more organized.

Table of Contents

• Cost Command
  • Amount Parameter
• Select Command
• Tribe Command
  • Name Parameter
  • Create Parameter
  • Remove Parameter
  • Rename Parameter
  • Add Parameter
  • All Parameter

Cost Command

The cost command is designed to allow users to get the cost required to make the specified item(s). This command does more than just get the cost for the target item itself. It also returns the cost for all sub resources that are needed to craft the target item.

?cost <ItemName>

Running this command will return the cost required to make one instance of the provided item.

Amount Parameter

The -amount parameter lets users get the cost of a certain quantity of the specified item.

?cost <ItemName> -amount 100

This will return the cost to make 100 of the specified item.

Select Command

The select command allows the user to choose an item from a list of items. This is used with the cost command because if the given item’s name matches multiple items then the bot needs to know which one to use.

?cost Rocket

User Request ^

Blueprint Search Results:

(1) Rocket Launcher
(2) Rocket Propelled Grenade
(3) Rocket Turret
(4) Rocket Homing Missle
(5) Rocket Pod

Bot Response ^

?select 3

The user enters the select command to choose the 3rd item that matched their original search.

Tribe Command

The tribe command is the basis for how the user will interact with their tribe(s). This includes all CRUD operations and the various ways of how this is implemented with a tribe.

?tribe

Running the tribe command by itself will result in nothing being done because parameters are required for this command to be useful.

Name Parameter

The -name parameter is required in most cases and is used to identify the target tribe the user desires to perform queries against.

Dependent Parameters:

• Add
• Remove
• Rename

Create Parameter

The -create parameter creates a tribe with a give name.

?tribe -create <TribeName>

When creating a tribe, the sender`s guild id will be automatically be added to the tribe. You can also include the -add parameter to add extra guilds when creating the tribe.

?tribe -create <TribeName> -add <GuildId>

Remove Parameter

The -remove parameter is a repeatable param that is used to remove existing guild ids that are in the target tribe`s permitted guilds collection.

?tribe -remove <GuildId>

Rename Parameter

The -rename parameter renames an existing tribe to the provided name.

?tribe -name <TribeName> -rename <NewName>

Add Parameter

The -add parameter is a repeatable param that is used to add a id of a discord guild to the target tribe.

?tribe -name <TribeName> -add <GuildId>

This will append the provided discord guild id to the tribe`s permitted guilds collection . Therefore the provided guild will now be able to interact with the target tribe.

?tribe -add <GuildId> -name <TribeName> -add <GuildId> -add <GuildId>

In this example you can see the user has provided 3 different -add parameters. On top of that, they are being placed before the -name param. This request will work because BlueQuery is very flexable when it comes to parameter arrangement.

All Parameter

The -all parameter allows the users to get all the tribes that their guild has access to.

?tribe -all

The name and id of the guild will be returned.