Skip to content

Commit

Permalink
Fix README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ricochet1k committed Aug 17, 2017
1 parent 7a44d51 commit 161a045
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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='<div id=app>'; 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
Expand All @@ -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

0 comments on commit 161a045

Please sign in to comment.