Config Settings - admon84/python-screeps-spybot GitHub Wiki

First time setup

Copy config.example.yaml and name the new file config.yaml

Settings

Configure settings in your config.yaml file to your own preferences

These are the configuration options currently available:

API Connection

api_host (string)

  • API Hostname
  • Default: screeps.com
  • Private Server Example: server1.screepspl.us:443

api_prefix (string)

  • Prefix the API path
  • Default: ''
  • Examples: /ptr or /season
  • Note: do not include /api, it is included automatically

api_secure (boolean)

  • Secure API requests
  • Examples: true for secure (https) or false for insecure (http)

api_token (string)

  • Screeps account authentication token
  • Default: ${SCREEPS_AUTH_TOKEN} (environment variable)
  • Read about Screeps Auth Tokens
  • Note: only needed if uploading results to Screeps account memory on a public server

api_username (string)

  • Screeps account email
  • Note: only needed if uploading results to Screeps account memory on a private server

api_password (string)

  • Screeps account password
  • Note: only needed if uploading results to Screeps account memory on a private server

Target

target_shard (string)

  • Shard to target
  • Examples: shard3 or shardSeason

target_players (array)

  • List of player names to gather information on
  • Example: - likeafox
  • Note: dash each line of array items

target_rooms (array)

  • List of specific rooms to separately track resources
  • Note: dash each line of array items

Spy Tasks

spy_rcl (string)

  • Get the Room Controller Level of owned rooms

spy_resources (boolean)

  • Get the amount of each resource in owned rooms

spy_structures (array)

  • List of structures to scan for resources
  • Note: dash each line of array items

spy_market (boolean)

  • Not implemented

Results Data

results_output (boolean)

  • Display spybot results in the terminal output

results_save_file (boolean)

  • Not implemented

results_filename (string)

  • Not implemented

results_memory (boolean)

  • Not implemented

results_memory_path (string)

  • Not implemented

results_segment (boolean)

  • Upload spybot results to your Screeps account memory segment

results_segment_target (number)

  • The Segment number where results data will be saved