Skip to content

Commit

Permalink
Readme revisions
Browse files Browse the repository at this point in the history
  • Loading branch information
admon84 committed May 6, 2021
1 parent 8417453 commit 2f9f354
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Simply install the Python `screepsapi` library using `pip`.

### Authentication

The recommended way to authenticate to the official servers is providing your [Authorization Token](https://docs.screeps.com/auth-tokens.html) into the `token` parameter.
The recommended way to authenticate to the official servers is providing an [Authorization Token](https://docs.screeps.com/auth-tokens.html) in the `token` parameter.

```python
import screepsapi
TOKEN = "3bdd1da7-3002-4aaa-be91-330562f54093"
api = screepsapi.API(token=TOKEN)
```

An optional `prefix` parameter can be included with values such as `"/ptr"` for the Public Test Realm or `"/season"` for Seasonal Server.
An optional `prefix` parameter can be included with values such as `"/ptr"` for the public test realm or `"/season"` for seasonal server.

It is also possible to access private servers with the `host` and `secure` parameters.

Expand All @@ -34,6 +34,10 @@ api = screepsapi.API(USER, PASSWORD, host=HOST, secure=True)

Note that by default private servers do not use SSL and all traffic is unencrypted.

### Credentials

Developers are encouraged to align with [SS3: Unified Credentials File v1.0](https://github.com/screepers/screepers-standards/blob/master/SS3-Unified_Credentials_File.md) to standardize Screeps credentials storage with other third party tools.

### API

The API class is a simple REST-based API. Each method corresponds to a different Screeps API endpoint.
Expand Down Expand Up @@ -68,7 +72,3 @@ print user["user"]["gcl"]
Screeps provides a sizable amount of data over a websocket. This includes console data and room details.

The best way to utilize the socket is to extend `screepsapi.Socket` and override the various abstract functions.

## Credentials

App developers are encouraged to align with [SS3: Unified Credentials File v1.0](https://github.com/screepers/screepers-standards/blob/master/SS3-Unified_Credentials_File.md) to standardize Screeps credentials storage with other third party tools.

0 comments on commit 2f9f354

Please sign in to comment.