ashtonohms / magic

Haskell implementation of Magic: The Gathering

Magic: The Gathering in Haskell

A Haskell implementation of the rules of Wizards of the Coast's Magic: The Gathering.

This project has multiple goals:

• to succinctly and correctly model the interactions between Magic cards;
• to provide an elegant and correct API to express Magic cards in;
• to provide a web server that is able to run a full game where clients play against each other.

Scope

Magic is a big game. This implementation targets only a specific part of it. For now, only two-player games and only cards, rules, card types and abilities available and relevant in the Magic 2013 core set are targeted.

A good indication of the current progress is to open module M13 and see how many M13 cards have been implemented yet. A list of issues to be fixed before the whole of M13 can be implemented can be found on GitHub.

There is also a command-line interface that allows you to play the game. To run it, follow the installation instructions below and run the executable that it produced by building Magic-CLI. This will run a two-player game with preselected decks.

Building with cabal

You need GHC 8.6.3 or greater and cabal-install 2.4.1 or greater to build Magic.

Clone the repository:

$ git clone [email protected]:MedeaMelana/Magic.git
$ cd Magic

Run the command-line interface:

$ cabal new-build Magic-CLI
$ dist-newstyle/build/*/*/Magic-CLI-*/x/magic-cli/build/magic-cli/magic-cli

Building with stack

You need the newest version of stack to build Magic. Clone the repository.

$ git clone [email protected]:MedeaMelana/Magic.git
$ cd Magic/Magic && stack build
$ cd ../../Magic/Magic-Cards && stack build

If you want to run the command-line:

$ cd Magic/Magic-Cards
$ stack build
$ stack exec magic-cli

If you want to run the web server:

$ cd Magic/Magic-Web-Server
$ stack build
$ stack exec magic-web-server

Info for NixOS users: Please use the nix-shell to download the newest stack version

Talking to the web server

The web server runs on websockets. Currently it starts a new game for every websocket connection that is opened, and that connection has full access to all the cards in the game. That is, there is no hidden information yet, and you can't have two clients play a game against each other yet: the connecting client controls all the players in the game.

Messages to and from the server are in JSON format. There is no documentation yet about the exact form of these messages, partly because it still unstable and changes often. However, the JSON messages from the server should be reasonably clear and should contain everything you need to build a proper client.