~shunter/ur-game

1a7402386c71a0f212a769125ea002a6d862541c — Samuel Hunter 3 years ago 4271fe9
Update README and LICENSE
4 files changed, 16 insertions(+), 18 deletions(-)

M LICENSE
M README.md
M src/ur-game.lisp
M ur-game.asd
M LICENSE => LICENSE +2 -2
@@ 1,4 1,4 @@
Copyright 2019 Samuel Hunter
Copyright 2021 Samuel Hunter

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:



@@ 8,4 8,4 @@ Redistribution and use in source and binary forms, with or without modification,

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

M README.md => README.md +13 -11
@@ 1,9 1,9 @@
# ur-game

A web app that hosts 2-player sessions of [The Royal
Game of Ur](https://en.wikipedia.org/wiki/Royal_Game_of_Ur), inspired
by this [YouTube video](https://www.youtube.com/watch?v=WZskjLq040I)
from The British Museum:
A web app that [you can play right now](https://royalgameofur.shunter.xyz/).
Hosts 2-player sessions of [The Royal Game of
Ur](https://en.wikipedia.org/wiki/Royal_Game_of_Ur), inspired by this [YouTube
video](https://www.youtube.com/watch?v=WZskjLq040I) from The British Museum:

[![Tom Scott vs Irving Finkel: The Royal Game of
Ur](https://img.youtube.com/vi/WZskjLq040I/0.jpg)](https://youtu.be/WZskjLq040I


@@ 12,17 12,23 @@ Ur](https://img.youtube.com/vi/WZskjLq040I/0.jpg)](https://youtu.be/WZskjLq040I
I took advantage of this project to learn about WebSocket communications, and
Common Lisp web development.

# Run the Software
# Run Locally

The web app uses [Roswell](https://roswell.github.io/) to launch. After you
have that install, run:
have that installed and you have this project in your `local-projects/`, run:

    $ ./roswell/ur-game
    $ ./roswell/ur-game.ros

Alternatively, with your CL impl of choice (I use SBCL):

    $ sbcl --load ur-game.asd --eval '(ql:quickload :ur-game) (ur-game:start)'

# Contributing

While I have a mirror of this repo on
[GitHub](https://github.com/samuel-hunter/ur-game), my main repository for
development and CI is on [Sourcehut](https://sr.ht/~shunter/ur-game/).

# Rules

* You win the game by getting all your seven pieces from one end of


@@ 33,7 39,3 @@ Alternatively, with your CL impl of choice (I use SBCL):
* You can jump over or capture enemy pieces, but you cannot capture
  pieces that are your own, or are on a rosette.


## License

BSD 3-Clause

M src/ur-game.lisp => src/ur-game.lisp +1 -2
@@ 1,7 1,6 @@
;;; ur-game.lisp - Service layer of the Ur Game API.
;;
;; Manages the HTTP server, WebSocket server, and WebSocket message
;; interpretation.
;; Manages the Clack web application
(defpackage #:ur-game
  (:use #:cl
        #:ur-game.engine

M ur-game.asd => ur-game.asd +0 -3
@@ 7,15 7,12 @@
  :version "0.0.1"
  :depends-on (#:alexandria
               #:cl-json
               #:cl-ppcre

               #:clack
               #:clack-handler-hunchentoot
               #:lack
               #:lack-middleware-static

               #:session-token
               #:uiop
               #:vom
               #:websocket-driver)