abraham / civility Goto Github PK

View Code? Open in Web Editor NEW

1.0 3.0 2.0 26 KB

The easiest way to manage your Civ5 hotseat games hosted by GMR

Home Page: https://rubygems.org/gems/civility

License: MIT License

Ruby 100.00%

gmr civ5-hotseat-games gmr-api civilization-v

civility's Introduction

Civility

Civility is the easiest way to manage your Civ5 hotseat games hosted by http://multiplayerrobot.com/.

Install

$ gem install civility

Usage

Authenticate yourself:

$ civility auth token

Run civility auth if you don't know where to get your GMR token.

Get a list of your games:

$ civility games

Download a save file to play:

$ civility play game name

Open Civ5, play your hotseat turn, and save to the same file.

Upload you completed turn:

$ civility complete game name

OS Support

civility has only been minimally tested on OS X and Windows.

Security

civility is cryptographically signed. To be sure the gem you install hasn’t been tampered with:

Add my public key (if you haven’t already) as a trusted certificate

$ gem cert --add <(curl -Ls https://raw.githubusercontent.com/abraham/civility/master/certs/abraham.pem)
$ gem install civility -P MediumSecurity

The MediumSecurity trust profile will verify signed gems, but allow the installation of unsigned dependencies.

This is necessary because not all of civility’s dependencies are signed, so we cannot use HighSecurity.

Troubleshooting

If you get UnexpectedError: {"ResultType"=>0, "PointsEarned"=>0} when running civility complete game name, try civility games every five minutes until the games list shows it being your turn and then try complete again. The GMR API is frequently stale and returning the old turn_id.
If your game isn't showing when you run civility games try running the command again. Frequently games are missing for from the GMR API response.

civility's People

Contributors

Stargazers

Watchers

Forkers

wstrinz kliph

civility's Issues

title matching should still work with slight misspellings

sandbox should still match sanbox

Handle playing games with multiword names

$ civility play awesome game
> ERROR: "civility play" was called with arguments ["awesome", "game"]
> Usage: "civility play"

Catch "it's not your turn" error and display message

Message should include that it might be their turn but not according to the GMR API.

UnexpectedError: {"ResultType"=>0, "PointsEarned"=>0}

Add CI feature tests

https://github.com/cucumber/aruba

Improve finding save files to upload

Check for files in save directory that are newer than default file and prompt to upload those instead.
If save file hasn't been updated since downloading it throw an error.

Catch timeout errors and show nice error message

civility p Bendyciv
<internal:prelude>:76:in `__read_nonblock': Connection reset by peer (Errno::ECONNRESET)
    from <internal:prelude>:76:in `read_nonblock'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/protocol.rb:154:in `rbuf_fill'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/protocol.rb:136:in `readuntil'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/protocol.rb:146:in `readline'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http/response.rb:40:in `read_status_line'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http/response.rb:29:in `read_new'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:1437:in `block in transport_request'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:1434:in `catch'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:1434:in `transport_request'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:1407:in `request'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:1308:in `request_get'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:481:in `block in get_response'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:853:in `start'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:584:in `start'
    from /Users/kliph/.rvm/rubies/ruby-2.3.0/lib/ruby/2.3.0/net/http.rb:479:in `get_response'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/civility-5/lib/civility/gmr.rb:68:in `get'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/civility-5/lib/civility/gmr.rb:34:in `download'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/civility-5/lib/civility.rb:52:in `play'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/thor-0.19.1/lib/thor/command.rb:27:in `run'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/thor-0.19.1/lib/thor/invocation.rb:126:in `invoke_command'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/thor-0.19.1/lib/thor.rb:359:in `dispatch'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/thor-0.19.1/lib/thor/base.rb:440:in `start'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/gems/civility-5/bin/civility:5:in `<top (required)>'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/bin/civility:23:in `load'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/bin/civility:23:in `<main>'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/bin/ruby_executable_hooks:15:in `eval'
    from /Users/kliph/.rvm/gems/ruby-2.3.0/bin/ruby_executable_hooks:15:in `<main>'

Add shorthand aliases

g => games
c => complete
a => auth
p => play

Display who's turn it is

for civility g blocked on #4

Move config implementation to it's own class

Use templates for output

Instead of messy string concatenation.

Sync games after play command

TurnId is stored in the config file and needs to be synced at the end of $ civility play game so that $ civility complete game has the current TurnId.