From 161a045edc8dab1cb1f460c50b665e212780c3b3 Mon Sep 17 00:00:00 2001 From: Matt Peterson Date: Thu, 17 Aug 2017 15:43:48 -0400 Subject: [PATCH] Fix README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3f74c08..3dd374f 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,15 @@ Custom client for Screeps using PIXI.js ![screenshot](https://raw.githubusercontent.com/ricochet1k/screeps-client/gh-pages/ags131.png) # How to use -Due to CORS, the best way to use this is to use a bookmarklet, which will inject the client into the current page. Copy this into a bookmark: +Due to CORS, the best way to use this is to use a bookmarklet, which will inject the client into the current page. Copy the following into a bookmark: ``` -javascript:((d) => {d.body.innerHTML='
'; var S$ = x => {s = d.createElement('script'); s.setAttribute('src', '//screeps.ricochet1k.net/'+x); d.body.appendChild(s);}; S$('static/lib/pixi.js'); var B = () => { window.PIXI? S$('dist/build.js') : T()}; var T = () => setTimeout(B, 10); T(); })(document);) +javascript:(d=>{s=d.createElement('script');s.setAttribute('src','//screeps.ricochet1k.net/inject.js');d.body.appendChild(s);})(document) ``` -Then go to a simple page, like a 404 page for the server you are using. This could be something like https://screeps.com/404 , or the main page of a custom server. Click the bookmarklet and magical! +Then go to a simple page, like a 404 page for the server you are using. This could be something like https://screeps.com/404 or the main page of a custom server. Click the bookmarklet and magical things happen! Username and password are saved in your browser's localStorage, per domain. -If you are trying to use this on a custom server, make sure to install screepsmod-auth and set a password through the Steam client. This is currently the only way to add a password to an existing account on a private server. +If you are trying to use this on a custom server, make sure to install screepsmod-auth. You can then set a password through the Steam client, or you can login through Steam or Github if you configure it with their API keys. # What works - Room view @@ -21,13 +21,15 @@ If you are trying to use this on a custom server, make sure to install screepsmo - Most actionLog animations - RoomVisuals - Console output +- Map view +- Code editing (barely) +- Login using Steam or Github (must be enabled and configured in screepsmod-auth) +- Registering a new account # What still needs implemented See issues for the full list. Notably: - Mouse interaction - Memory view -- Code editing - Typing console commands -- Map view - Replay view