npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

screepsmod-server-stats

v1.1.3

Published

This tool allows you to execute CLI commands on a Screeps server and export the results via an API.

Downloads

28

Readme

screepsmod-server-stats

This tool allows you to execute CLI commands on a Screeps server and export the results via an API.

Note: If you enable raw exports and set the secret_key in config.yml, you will have access to all raw data from the server. This can be harmful if not used correctly. It is recommended to only use this feature if you know what you're doing. If you have any questions, contact PANDA#3000 on Discord.

Security

By default, this mod is secure. Raw data exports are not enabled unless the mod is configured twice in the config.yml file. This means that you can only access the default endpoints. To access raw data, you must set the secret_key in config.yml and set rawExports to true. The secret_key must also be included in the header of the request to authorize access.

It is not recommended to enable debug mode as it will add user ID, steam, and password information to the user object export. This is only for debugging purposes and is not necessary for the mod to function.

Installation

  1. Add the following to your mods:
"screepsmod-server-stats"

To enable all API endpoints, add the following to your config.yml:

serverStats: 
  debug: false
  rawExports: true
  secret_key: "an_secure_secret"
  userStats: 2
  roomsObjectsStats: 2
  roomsIntentsStats: 2
  runEveryTicks: 10
  • debug: when set to true, turns on debug mode (not recommended)
  • rawExports: when set to true, enables raw data exports (not recommended)
  • secret_key: sets the secret key for API calls to authorize access
  • usersStats: 0 = off, 1 = low, 2 = all
  • roomsObjectsStats: 0 = off, 1 = low, 2 = all
  • roomsIntentsStats: 0 = off, 1 = low, 2 = all

Make sure to include the serverStats object at the same depth as the mod and steamKey objects.

Usage

The following API calls can be made if enabled in the config.yml file. All API calls that require access to raw data exports must include the secret_key in the header of the request to authorize access.

By default, the following endpoints are enabled:

  • /api/stats/server: returns a list of all averaged server stats

  • /api/stats/version: returns the current version of the mod Rooms:

  • /api/stats/rooms: returns a list of all rooms

  • /api/stats/rooms/objects: returns a list of all rooms objects

  • /api/stats/rooms/intents: returns a list of all rooms intents

  • (disabled) /api/rooms/flags: returns a list of all rooms flags

  • /api/stats/rooms/terrain: returns a list of all rooms terrain Users:

  • /api/users: returns a list of all users

  • (disabled) /api/users/console: returns a list of