DeadBot is an Open Source automation tool for aggregating data from the raw game files with the purpose of accurately maintaining the Deadlock Wiki - https://deadlocked.wiki/
All data can be found in the output-data
directory, which includes json and csv formats
Some data has been processed and formatted for google sheets:
Item Data
-
Install Python 3.11+
-
[OPTIONAL] Add Python scripts dir to your environment. This lets you omit
python -m
when calling third-party modules- Get <python_path> with
python -m site --user-base
- Add to ~/.bash_profile -
export PATH="$PATH:<python_path>/Python311/Scripts"
- Get <python_path> with
-
python3 -m pip install poetry
-
python3 -m poetry install
-
python3 -m pre_commit install
-
Download Decompiler.exe for your particular OS from https://github.com/ValveResourceFormat/ValveResourceFormat/releases
- Extract decompiler into a folder and update
.env
- Extract decompiler into a folder and update
-
Add the paths to Deadlock files and the Decompiler in
.env
using.env.example
as an example
bash main.sh
to run end-to-end decompilation, parsing and bot (bot is a WIP)
bash parser.sh
to just run the parser. Must have already run main.sh
once to decompile the source files
docker run \
-v "$DEADLOCK_PATH":/data
-v ./output-data:/output \
ghcr.io/deadlock_wiki/deadbot:latest
Build image with docker-compose build
Run with docker-compose up
Be sure to setup volumes:
service:
deadbot:
...
volumes:
# mount game files
- "C:\Program Files (x86)\Steam\steamapps\common\Deadlock:/data"
# or
- "/mnt/SteamLibrary/steamapps/common/Deadlock:/data"
# and an output dir
- "./output-data:/output"
DeadBot is currently early in its development and welcomes new contributors to get involved no matter what level experience you have.
Regularly discussed in the wiki channel on the Discord server. Ask for access on there if you are interested in contributing.
At the moment the work is fairly ad-hoc, so find me on discord as "HariyoSaag" if you're not sure where to start.