Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tedivm committed May 25, 2016
1 parent a4dae29 commit 24cccfb
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
1 change: 1 addition & 0 deletions .settings.dist.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Copy this to .settings.yaml and fill it out.

# Screeps account info
# Your username is your full email address.
screeps_username:
screeps_password:
screeps_ptr: false
Expand Down
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@ The settings file is in yaml and takes various authentication tokens.
# Copy this to .settings.yaml and fill it out.

# Screeps account info
# Your username is your full email address.
screeps_username:
screeps_password:
screeps_ptr: false
```
## Running
## Launching
To stream the console output directly to your terminal's stdout run the
`console.py` application.
Expand All @@ -44,10 +45,23 @@ console output and sending console commands to the server.
$ ./screeps_console/interactive.py
```

## Interactivity

## Colors
The interactive console allows you to directly interact with your screeps
program through the in game console. Most of the time what you put in will be
sent directly to the screeps server to be processed. There are a few built in
commands however.

Console output can have colors, in both the website version and teh shell. To get
* clear - resets the console display.
* exit - exits the shell.
* list - lists these and other built in commands and aliases.
* themes - lists available themes when called without an argument, or switches
themes when called with the theme name as the first argument


## Colors and Severity

Console output can have colors, in both the website version and the shell. To get
the best of both worlds use font tags that also have a severity attribute.

```
Expand Down

0 comments on commit 24cccfb

Please sign in to comment.