screeps-monitor v0.3.0

Screeps Monitor

Current version (stable) : 0.3.0

Informations

This library will store stats from your Screeps account (GCL, CPU, rooms stats, logs).
You will need this file if you use the Screep Monitor Android App

Installation

You can add the screeps-monitor.js file in your screeps source folder or
you can install it with npm : npm install screeps-monitor

Usage

(N.B. : This is an example, maybe your main file is not like this)

const Monitor = require("screeps-monitor")();

module.exports.loop = function () {
  Monitor.load();

  // Your logic

  Monitor.run();
};

Documentation

Options

You can configure the library with these parameters at the top

const Monitor = require("screeps-monitor")([{options}]);

• logAverage
  • Enable or disable logging of average CPU.
  • Default value : true
• logAverageLimit
  • Limit the number of values to calculate average.
  • Default value : 100
• logMessageMax
  • Limit the number of logs to save
  • Default value : 10

The log function

The library can store 10 recent logs messages to be print on the Android app and can also print all your logs in the game console.

Monitor.log(String Message, Boolean PrintInConsole, Boolean PrintGametime)

Example:
Monitor.log("This is my message in the console", true, true)

Will print in the console (true for all parameters):
548: This is my message in the console

By default the function will not print your messages and not print the Game time.

You have some ideas? Need some help?

You have an idea or you have a problem? You can open an issue or contact me (@iKlem) on the Screeps slack.