Skip to main content

Base bot class for Star Citizen players

Project description

Base Astro Bot

Base Bot for Star Citizen players

This project contains python base bot class, useful when creating a bot on specific platform.

Available features:

  1. Organization fleet information. Each member can add/remove ships that he owns. Database is stored for everyone. There are commands to display whole organization fleet or ships owned by specific member.
  2. Ship matrix data. There are commands to view ship details, comparison of multiple ships or check prices of multiple ships that match expression (e.g. all DRAKE ships)
  3. Displaying of Road Map data with filters on specific expression (e.g. when searching for a ship release). Displaying info for a specific release or Road Map category.
  4. Displaying current SC releases (PU and PTU) according to Road Map version.
  5. Thread monitoring changes in current SC release on Road Map page and Spectrum forums.
  6. Trade assistant shows best trade routes for given conditions (budget, cargo, start location).

If your bot is running use the help command to see all available commands.

Dependencies

  • Python 3.5+
  • aiohttp 3.4.4
  • async-timeout 3.0.1
  • google-api-python-client 1.7.4
  • google-auth 1.5.1
  • google-auth-httplib2 0.0.3
  • oauth2client 4.1.3
  • SQLAlchemy 1.2.12
  • tabulate 0.8.2

Installation

pip install base_astro_bot
python -m dastro_bot.install DIRECTORY_NAME

The second command generates default configuration files to run your own BOT:

  • languages.py - named tuples with translation
  • settings.py - custom settings for your server

Basic Configuration

Here's what you absolutely need to configure to run the bot:

  • settings.py
    • set the CHANNELS dict values
    • actually in basic config only the main channel is required
    • you can set all three channels with the same value

Google Spreadsheet

Google spreadsheeet API is used to read trade data created by community. In current version it supports this spreadsheet:

Which is already outdated. However the source of trade data will need to be updated soon[TM] anyway, after SC 3.3 release.

In order to properly use the google spreadsheet data source please follow the following tutorial:

Then please rename two json files to:

google_credentials.json
google_token.json

Database

Astro Bot uses SQL Alchemy to handle database and SQLite database is used by default. If you want to use different database then please adjust settings.py file accordingly. There are two parameters there which are used to configure database:

DATABASE_NAME
DATABASE_DIALECT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

base_astro_bot-1.0.9.tar.gz (15.7 kB view hashes)

Uploaded Source

Built Distribution

base_astro_bot-1.0.9-py3-none-any.whl (22.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page