Unofficial API for Spawning Tool.

Project summary

Build Warren aims to be an API endpoint for Spawning Tool, which lacks one. My end goal is to create an open source alternative to Spawning Tool's Build Advisor, as I don't like Overwolf's invasiveness.

Why "Build Warren" ? Because you can't build a Roach Warren without a Spawning Pool !

Usage

The following commands get data from Spawning Tool and parses the pages for relevant information. Cloaked (i.e. private) builds therefore aren't accessible.

Get the build order count

cargo run build-count # Gives the highest valid build ID

Get a specific build order

cargo run fetch [BUILD_ID]

You can add -o [OUTPUT_FILE] to write the result in a file. For example :

cargo run -- -o build.json fetch 193844 # Saves build 193844 to build.json

You can add -s to save the build to the database. For example :

cargo run -- -s fetch 193844 # Saves build 193844 to the database

Get the latest build order(s)

cargo run fetch-latest # Fetch the latest public build order
cargo run fetch-latest 5 # Fetch the five latest public build orders

You can also specify an output file or save to the database as with fetch.

cargo run -- -o builds.json fetch-latest 20 # Fetches the twenty latest public builds and saves them to builds.json

Get a batch of build orders

cargo run fetch-segment 141 145 # Fetches build orders 141-145 (both included)

Roadmap

Without storage

• Better CLI interface, with progress bars, styling and more detailed progress
• Deployment with an actual API

With storage

• Database integration
• Live updates -- checking if new builds have been posted

Live overlay

• Build display
• Timer management
• Styling and icons
• Build browsing