User/Password authentication for the screeps private server mirror of https://github.com/ScreepsMods/screepsmod-auth
ags131 41db3e39b6
Publish
1 year ago
lib Removed obsolete playerSandbox method 1 year ago
static/password fixed password validation 1 year ago
.gitignore Initial Commit 2 years ago
LICENSE Initial Commit 2 years ago
README.md Added the ability to specify starting CPU for API registered users + Spawn placement restricting. 1 year ago
circle.yml CircleCI Updated to use NPM Token 2 years ago
index.js Fixed bug 2 years ago
out.gif Added steam OpenID 2 auth support 2 years ago
package.json Publish 1 year ago
yarn.lock Update passport-steam 1 year ago

README.md

screepsmod-auth

This adds user/pass auth to the screeps private server

NPM info

Circle CI

Installation

  1. npm install screepsmod-auth in your server folder.
  2. Thats it!

Usage

Steam Console method

  1. Open the steam screeps client
  2. In console, run setPassword('YourDesiredPassword')
  3. Now you should be able to login via API

Web Form Method

  1. Open the steam client at least once (Required to create initial account)
  2. Goto http://yourServerHostOrIP:21025/authmod/password/
  3. Enter your desired password
  4. Click Signin with steam
  5. Your password should be set and you be able to login via API

API

config.auth.authUser(username,password)

Returns a Promise, resovles to either the user object or false

Github Auth

To enable github auth, you need to add a github client id and client secret to your .screepsrc
(Or ENV vars GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET with other launchers)

Make sure to set the callback url to point to /api/auth/github/return on your server. ex: https://screeps.mydomain.com/api/auth/github/return
Get the id and secret from youe Github settings: https://github.com/settings/developers

.screepsrc

[github]
clientId = <clientId>
clientSecret = <clientSecret>

Initial CPU and Spawn Blocking

You can set the initial CPU that gets placed on a user (Steam users always receive 100), and also control whether the new user can place spawns. This can be used in combination with a whitelist or manual approval to control spawning.

[auth]
cpu = 100
preventSpawning = false