Skip to content
Custom client for Screeps using PIXI.js
Branch: master
Clone or download
Latest commit 24d3254 Jun 25, 2019

README.md

screeps-client

Custom client for Screeps using PIXI.js. The code was designed with the mobile devices in mind. The application can be easly wrapped by cordova and run natively on a phone.

screenshot1 screenshot2 screenshot3 screenshot4

How to use

Due to CORS it is not possible to connect to anything hosted on the other domain than the client app. You have several options to overcome this problem.

  • Bundle the package with cordova/electron/node-webkit or any other tool which runs the page in the environment not limited by CORS,
  • Host the page on the same domain as your screeps server. You will need a web server that works as proxy for both client and server,
  • Inject the code as suggested by the ricochet1k.

Connecting to server

Make sure to install screepsmod-auth. User can register only if server is not protected by the password. Once registered the password can be set.

It is possible to register to servers with password, but it requires a change in the register.js of screepsmod-auth. The conditional statement should be following:

if(process.env.SERVER_PASSWORD !== body.serverPassword) return res.json({
    error: "Registration is automatically disabled. A server password has been set."
})

What works

  • Room view
  • Room minimaps
  • Typing in room names to view them
  • Most actionLog animations
  • RoomVisuals
  • Console output
  • Map view
  • Code editing (barely)
  • Typing console commands
  • Registering a new account

What still needs implemented

See issues for the full list. Notably:

  • Mouse interaction
  • Memory view
  • Replay view
  • Messages
  • Orders
  • Badges
  • Login using Steam or Github
You can’t perform that action at this time.