Skip to content

Commit

Permalink
feat: Add support for Season and PTR servers (#26)
Browse files Browse the repository at this point in the history
### Support for Season and PTR servers

* Log in to official server and use the top-left menu links to access
the Season and PTR servers.
* When you access the season server and you are not logged in, you're
redirected to the main server to log in first, and then have to switch
back to season server yourself with the top-left menu link
* http://localhost:8080/(https://screeps.com)/season/
* http://localhost:8080/(https://screeps.com)/ptr/


https://github.com/user-attachments/assets/604f21b1-d9ca-4c02-8f26-48708a3251b5

### Modified game menu

New client abuse scripts to modify the game menu
* Changed the "Switch to Season/Persistent" link to keep you in the
Steamless client for a better experience
* Adds a "PTR Server" link when connected to the Persistent MMO World
* Adds a "Change Server" link (updated to match the official client)
* Removed some links to reduce clutter
* Steamless client on the left vs. official client on the right


![](https://github.com/user-attachments/assets/c6df5ca2-4b36-4cd7-ade5-daac2e16f009)

### Error messages

* Simplified error messages by default
* Use `--debug` CLI argument to show additional details when errors
occur

![Screenshot 2024-07-28
104529](https://github.com/user-attachments/assets/b41f4adb-f3a1-4d2e-b006-d5749f1110ba)

### Version info

* Version number shows when running the script now
* Use `-v` or `--version` CLI argument to show the version number and
exit
  • Loading branch information
admon84 authored Jul 28, 2024
1 parent bebbbcc commit 334a5c9
Show file tree
Hide file tree
Showing 13 changed files with 617 additions and 275 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

### Overview

The Screepers Steamless Client is a web proxy that allows you to run [Screeps: World](https://store.steampowered.com/app/464350/Screeps/), a game purchased via Steam, directly in your browser. It overcomes compatibility issues with the official Screeps client on many macOS devices. This client uses the Screeps files installed with Steam and enables gameplay on official and private servers across macOS, Linux, and Windows using the browser of your choice.
The Screepers Steamless Client is a web proxy for the [Screeps World](https://store.steampowered.com/app/464350/Screeps/) game client. It allows you to run Screeps in your web browser and works with macOS, Linux and Windows setups.

## Requirements

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

## Installation

Expand All @@ -27,7 +28,7 @@ screepers-steamless-client

View the server list page at http://localhost:8080/. This address can be changed with the `--host` and `--port` arguments.

Different servers can be accessed from the server list page, or using the url format `http://localhost:8080/(SERVER_ADDRESS)/`
Different servers can be accessed from the server list page, or using the url format `http://localhost:8080/(BACKEND_ADDRESS)/`

- For the official server: http://localhost:8080/(https://screeps.com)/

Expand All @@ -48,6 +49,9 @@ All of the command line arguments are optional.
- `--internal_backend` — Used to configure an internal backend url. If provided, the client app uses this address to reference the internal server endpoint.
- `--server_list` — Used to set the path to a custom server list json config file.
- `--beautify` — Formats .js files loaded in the client for debugging.
- `--debug` — Display verbose errors for development.
- `-v` , `--version` — Display the version number.
- `-h` , `--help` — Display the help message.

## Argument Examples

Expand Down
2 changes: 1 addition & 1 deletion scripts/release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ if [[ "$currentVersion" != "$newVersion" ]]; then
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
npm version --no-git-tag-version $newVersion
git add package.json
git add package.json package-lock.json
git commit -m "chore: release $newVersion [skip ci]"
git push
fi
Loading

0 comments on commit 334a5c9

Please sign in to comment.