Skip to content
This repository has been archived by the owner on Dec 12, 2020. It is now read-only.

Latest commit

 

History

History
42 lines (31 loc) · 1.93 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.93 KB

SeedBot for Rust

Generate Rust maps and post photos of them to a Discord channel via webhook.

About

SeedBot for Rust is an experiment with Discord Webhooks and BeautifulSoup. The script generates a Rust map with beancan.io, then sends a message to a Discord text channel using Discord's webhook functionality.

Theoretically (and once the project is finished), one could use a tool like cron to run the script on an interval (i.e. hourly).

Setup

  1. Clone repository.
  2. Clone dependencies with git submodule init.
  3. Copy cfg/config-example.json to config.json and enter your info (see below for help).
  4. Run seedbot.py using a scheduler (e.g. cron) or by hand.

Configuration

The configuration file is pretty self-explanatory. Here's an explanation anyway:

  • webhook_url: Webhook for a Discord text channel.
  • beancan_email and beancan_password: Login information for a beancan.io account.
  • map_size: How large of a map you'd like to generate.
    • Min. 1000, max 6000.
  • timeout: How long to wait before HTTP requests are terminated.

Roadmap

Completed Feature
Basic webhook functionality
Read beancan.io login info and map size from config.json
Generate map on beancan.io
Retrieve and parse map data with BeautifulSoup
Format map data as a rich embed and post via webhook
Implement basic error handling
Implement retry backoff in case of an error
Add ability to filter by monuments (Airport, Harbor, Launch Site, etc.)
Test and finalize error handling
Finalize documentation