boxcars/README.md

44 lines
1.2 KiB
Markdown
Raw Normal View History

2021-08-19 06:57:40 +00:00
# boxcars
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
Online backgammon client ([FIBS](http://fibs.com))
**Note:** This application is in pre-alpha state. Here be dragons.
2021-08-20 03:18:28 +00:00
## Play
There are several ways to play Boxcars.
### Browser (recommended)
Visit https://boxcars.rocketnine.space
### Desktop
**Note:** You will need to install the dependencies listed for [your platform](https://github.com/hajimehoshi/ebiten/blob/main/README.md#platforms).
Run the following command to build a `boxcars` executable:
`go install code.rocketnine.space/tslocum/boxcars@latest`
Run `~/go/bin/boxcars` to play.
### Android
2021-08-20 03:18:28 +00:00
*Coming soon*
## Gameplay notes
- To bear off a piece, drag it from your home on to the bar.
2021-08-19 06:57:40 +00:00
## Support
Please share issues and suggestions [here](https://code.rocketnine.space/tslocum/boxcars/issues).
## Dependencies
2021-08-20 03:18:28 +00:00
- [ebiten](https://github.com/hajimehoshi/ebiten) - 2D game engine
- [draw2d](https://github.com/llgcode/draw2d) - 2D shape drawing
- [kibodo](https://code.rocketnine.space/tslocum/kibodo) - On-screen keyboard
2021-08-20 03:18:28 +00:00
- [resize](https://github.com/nfnt/resize) - Image resizing