Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.61 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.61 KB
Raw

screepsmod-history

This is a history mod for the Screeps Private Server

JavaScript Style Guide CircleCI

NPM info

Requirements

  • nodejs 10+
  • Plenty of disk space, I see an average of 8kb per tick per room, by default this saves 200,000 ticks. So ~20MB per active room.

Warning

Currently with AWS mode this produces a lot of PUT requests, this can easily become very expensive. For that reason, AWS mode is currently not recommended

Configuration

All options and defaults are listed below

History

  • historyChunkSize: 100 (Number of ticks per history file)
  • mode: sqlite (valid values are file, aws, and sqlite)
  • region: us-east-1
  • apiVersion: latest
  • accessKeyId:
  • secretAccessKey:
  • bucket:
  • path: history

Examples

Config can be applied in several ways:

.screepsrc

Add to the bottom of your .screepsrc file

[history]
historyChunkSize = 100
mode = 'aws'
region = 'us-east-1'
apiVersion = 'latest'
accessKeyId = 'my-aws-access-key-id'
secretAccessKey = 'my-aws-secret-access-key'
bucket = 'my-bucket'
path = 'my-custom-path'

ENV Method

Please note that this method only works when launching modules directly or with screeps-launcher, when launched via the default launcher they will be ignored.

HISTORY_MODE='aws'