Skip to content

screepers/steamless-client

BranchesTags
 
 

Repository files navigation

Screepers Steamless Client

Overview

The Screepers Steamless Client is a web proxy for the Screeps World game client. It allows you to run Screeps in your web browser and works with macOS, Linux and Windows setups.

Requirements

  • Node.js v20+
  • Screeps World (installed using Steam)

Installation

Run with NPX

Run the latest version with npx without installing:

npx screepers-steamless-client

Install Globally with NPM

Install the latest version globally with npm and run the client:

npm install -g screepers-steamless-client
screepers-steamless-client

Run with Docker Compose

Use Docker Compose to run the client.

  • Download the compose.yaml file and place it in an empty folder.
  • Alternatively, you can add the client entry from compose.yaml to an existing Docker Compose configuration (e.g., combine it with a Screeps server launcher). If you do this, make sure to use the --internal_backend argument in the command to reference the Screeps server container address, like this:
    command: >
      npx screepers-steamless-client
      --package /screeps.nw
      --host 0.0.0.0
      --internal_backend http://screeps:21025

Set up the SCREEPS_NW_PATH environment variable.

  • Create a .env file with the following content in the same folder as the compose.yaml. Replace the path with the actual path to your Screeps package.nw file:
SCREEPS_NW_PATH="~/Library/Application Support/Steam/steamapps/common/Screeps/package.nw"

Run the Docker co