# ADA
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/checkmark.png "ADA")
>I am ADA, also known as Artificial Directory and Assistant, tasked to support pioneers, such as you, in their mission.
>
> ~ *ADA*

ADA is a Discord bot for the Satisfactory video game.

With ADA, you can browse information about items, recipes, and buildings within Discord.

![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/examples/item_info.png "Item Info")

![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/examples/recipes_for.png "Item Info")

You can also ask ADA to calculate an optimal production chains and produce visualizations.

![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/examples/optimization.png "Item Info")

**[GitHub Repo](https://github.com/ScottJDaley/ada)**

## Query Syntax

### Information Query

Provides information about items, buildings, and recipes in the game.

#### Query Syntax
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/information_query.png "Information Query")

#### Entity Query
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/entity_query.png "Entity Query")

#### Recipes For Query
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/recipes_for_query.png "Recipes For Query")

#### Recipes From Query
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/recipes_from_query.png "Recipes From Query")

#### Notes
- Regexes can be used when specifying items, recipes, and buildings.

#### Examples

- `ada iron rod`: Information about iron rods.
- `ada recipes for iron rod`: All recipes for making iron rods.
- `ada recipes from iron rods`: All recipes with iron rods as an ingredient.
- `ada recipes for refineries`: All recipes available in refineries.
- `ada recipes for iron.*`: All recipes for items whose name starts with "iron".

### Optimization Query

Finds an optimal production chain. Attempts to minimize inputs, maximize
outputs, and adhere to any given constraints.

#### Query Syntax
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/optimization_query.png "Optimization Query")

#### Outputs
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/outputs.png "Outputs")

#### Inputs
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/inputs.png "Inputs")

#### Includes
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/includes.png "Includes")

#### Excludes
![alt text](https://raw.githubusercontent.com/ScottJDaley/ada/master/images/rr_diagram/excludes.png "Excludes")

#### Notes
- Regexes can be used when specifying items, recipes, and buildings.
- Only one objective `?` can be provided in the entire query.
- If no inputs are specified, the the optimizer will attempt to minimize
  unweighted resources. This is equivalent to an input of `from _ unweighted resources`.

#### Examples
- `ada produce 60 iron rod from ? iron ore`: Produces exactly 60 iron rods while minimizing iron ore.
- `ada produce ? iron rods from 60 iron ore`: Produce as many iron rods as possible from 60 iron ore.
- `ada produce ? power from 240 crude oil with only fuel generators`: Produce as much power as possible from only 240 crude oil only using fuel generators (no other generators allowed).
- `ada produce 60 modular frames without refineries`: Produce exactly 60 modular frames without using any refineries, minimizing unweighted resources.

## Acknowledgements
- Images are taken from the [Official Satisfactory Wiki](https://satisfactory.gamepedia.com/Satisfactory_Wiki).

ADA is a Discord bot for the video game Satisfactory.

Votando em ADA

Quer nos ajudar?