README.md

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.

⚠️ ADA is not currently hosted. You will need to host it yourself to add the bot to your discord server. I am working on setting up new hosting.

Invite to Server

With ADA, you can browse information about items, recipes, and buildings within Discord.

You can also ask ADA to calculate an optimal production chains and produce visualizations.

ADA is also available as a command line tool.

Query Syntax

Information Query

Provides information about items, buildings, and recipes in the game.

Query Syntax

Entity Query

Recipes For Query

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

Outputs

Inputs

Includes

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.

Running your own version of ADA

Windows Installation

1. Download python 3 from https://www.python.org/downloads/

2. Download Microsoft C++ Build Tools from https://visualstudio.microsoft.com/visual-cpp-build-tools/. Just select "C++ build tools" from the options under "Workloads".

3. Install GraphViz:

• Download from: https://www.graphviz.org/download/
• Add install directory C:\Program Files (x86)\Graphviz2.38\bin to PATH

4. Run the following as admin to configure GraphViz:

dot -c

5. Clone repo (in directory of you choosing)

git clone https://github.com/ScottJDaley/ada.git

6. Move inside the repo

cd ada

7. Install python modules

py -m pip install -r requirements.txt

8. Start the bot

py bot.py

MacOS Installation

Requirements

• Homebrew
• python3 3.9+
• python3's pip
• Graphviz

1. Create python virtual environment

python3 -m venv venv
source ./venv/bin/activate

2. Install python requirements to venv

pip3 install -r requirements.txt

3. Install GraphViz

brew install graphviz

4. Install python packages

pip install -r requirements.txt

5. Set up Discord bot

export DISCORD_TOKEN={token from discord developer portal}

6. Start the bot

python bot.py

Linux Installation

1. Install python3

sudo apt-get install python3

2. Install pip

sudo apt-get install python3-pip

3. Install GraphViz

sudo apt-get install graphviz

4. Install git

sudo apt-get install git

5. Clone repo (in directory of you choosing)

git clone https://github.com/ScottJDaley/ada.git

6. Move inside the repo

cd ada

7. Install python packages

pip3 install -r requirements.txt

8. Set up Discord bot

echo "DISCORD_TOKEN={token from discord developer portal}" > .env

9. Start the bot

python3 bot.py

How to run

Command line tool

1. Double click tool.py to run it.
2. Type a query and press Enter.
3. Type exit to quit.

Discord bot

1. Create a file called .env in source folder.

2. Add the following to the file:

   DISCORD_TOKEN={discord bot token}
   

   Replace {discord bot token} with the token generated for the bot from the Discord developer portal.

3. Double click bot.py to run the bot.

4. Invite the bot to your server using a link generated from OAuth2 page on https://discord.com/developers/applications.

5. The bot should be able to respond to commands in Discord after a few seconds.

6. Press enter in the terminal to shut down the bot.

Acknowledgements

• Images are taken from the Official Satisfactory Wiki.

Contributing

Feel free to send pull requests and submit new issues. You are also welcome to fork this repo to make your own changes.