https://github.com/asross/settlers

of Catan!
https://github.com/asross/settlers

catan ruby text-based websockets

Last synced: 13 days ago
JSON representation

of Catan!

• Host: GitHub
• URL: https://github.com/asross/settlers
• Owner: asross
• Created: 2013-08-22T13:38:10.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-04-12T05:44:53.000Z (over 1 year ago)
• Last Synced: 2024-10-04T17:25:11.405Z (about 1 month ago)
• Topics: catan, ruby, text-based, websockets
• Language: HTML
• Homepage: https://ruby-settlers.herokuapp.com
• Size: 2.44 MB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Settlers

of Catan!

## Summary

This repository started off in 2011 as a way to teach myself Ruby, but it's morphed into a PORO-based implementation of Settlers of Catan with very hacky HTML and text-based web interfaces on top.

It supports multiple games and websocket-based board updates, but doesn't have any authentication or authorization logic, so any user can perform actions as any player (in any game). It's best for friendly play on a local network :)

## Demo

[It's deployed here,](https://ruby-settlers.herokuapp.com) or you can watch the following instructional GIF:

![settlers](./settlers-demo.gif)

## Local Setup

1. Clone the repository,  `cd` into it

1. `bundle install`

1. `bundle exec puma -p 4567`

1. Visit `http://localhost:4567`

4. Or run `ruby text/client.rb` with a `GAME_URL`

To run tests, `ruby test.rb`

## License

[MIT](https://opensource.org/licenses/MIT)