mage/readme.md

# XMage — Magic, Another Game Engine

[![Join the chat at https://gitter.im/magefree/mage](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/magefree/mage?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/magefree/mage.svg?branch=master)](https://travis-ci.org/magefree/mage)

XMage allows you to play Magic against one or more online players or computer opponents. It includes full rules enforcement for over **16 700** unique cards (over 32 000 counting all cards from different editions). Starting with *Morningtide*, all regular sets have nearly all the cards implemented ([detailed overview](http://ct-magefree.rhcloud.com/stats)).

There are public servers where you can play XMage against other players. You can also host your own server to play against the AI and/or your friends.

XMage community:
* [Official XMage forum](http://www.slightlymagic.net/forum/viewforum.php?f=70);
* [Official XMage support and feature request on github](https://github.com/magefree/mage/issues);
* [Reddit XMage group](https://www.reddit.com/r/XMage/);
* [Reddit XMage discord channel](https://discord.gg/Pqf42yn).

## Features

* Deck editor (load and save decks)
* Simple computer AI opponent
* Two player duel or a multiplayer free-for-all game with up to 10 players
* Supports special formats like Commander (up to 10 players), Cube, Tiny Leaders, Super Standard, Historic Standard
* There are two tournament types supported (elimination or swiss type handling), which can be played with up to 16 players:
    * Booster (also Cube) draft tournaments (4-16)
    * Sealed (also from Cube) tournaments (2-16)


## Installation

Download and install the [latest XMage release](http://XMage.de).
You will need to have Version 7 or later of the [Java Runtime Environment](http://java.com/en/).

Look [here](http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=13632) for more detailed instructions.  
[Here](http://github.com/magefree/mage/wiki/Release-changes) you can find a log of the latest changes.

## Developer

If you are interested in developing XMage, here are some useful resources:

* [Developer Getting Started](http://github.com/magefree/mage/wiki/Developer-Getting-Started)
* [Developer Notes](http://github.com/magefree/mage/wiki/Developer-Notes)
* [Developer Testing Tools](http://github.com/magefree/mage/wiki/Developer-Testing-Tools)
* [Double Faced Cards](http://github.com/magefree/mage/wiki/Double-Faced-Cards)
* [Card Requests](http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=4554)
* [Tournament Relevant Card Requests](http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=14062)
-												Update card count in readme

And minor formatting fixes.
											
										
										
											2016-07-29 00:45:02 +00:00
+								# XMage — Magic, Another Game Engine
-												The readme file mirrors the wiki main page now.

											
										
										
											2012-06-21 19:31:00 +00:00
-												setup TravisCI build, add badge to readme

needed to use `sudo: required` to run in a VM with more RAM, and
explicitly set maven's heap size.

											
										
										
											2016-07-16 20:47:39 +00:00
+								[![Join the chat at https://gitter.im/magefree/mage](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/magefree/mage?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/magefree/mage.svg?branch=master)](https://travis-ci.org/magefree/mage)
-												Add Gitter badge
											
										
										
											2015-12-04 17:17:31 +00:00
-												Updated readme with actual card stats, added stats printing on mage-verify tests

											
										
										
											2017-12-29 13:53:12 +00:00
+								XMage allows you to play Magic against one or more online players or computer opponents. It includes full rules enforcement for over **16 700** unique cards (over 32 000 counting all cards from different editions). Starting with *Morningtide*, all regular sets have nearly all the cards implemented ([detailed overview](http://ct-magefree.rhcloud.com/stats)).
-												The readme file mirrors the wiki main page now.

											
										
										
											2012-06-21 19:31:00 +00:00
-												Readme changes: fixed spelling error, improved some grammatical things, and added a couple more resources for developers.

											
										
										
											2015-06-09 14:54:31 +00:00
+								There are public servers where you can play XMage against other players. You can also host your own server to play against the AI and/or your friends.
-												The readme file mirrors the wiki main page now.

											
										
										
											2012-06-21 19:31:00 +00:00
-												Updated readme with community links
											
										
										
											2017-12-29 13:37:10 +00:00
+								XMage community:
 								* [Official XMage forum](http://www.slightlymagic.net/forum/viewforum.php?f=70);
 								* [Official XMage support and feature request on github](https://github.com/magefree/mage/issues);
 								* [Reddit XMage group](https://www.reddit.com/r/XMage/);
 								* [Reddit XMage discord channel](https://discord.gg/Pqf42yn).
-												The readme file mirrors the wiki main page now.

											
										
										
											2012-06-21 19:31:00 +00:00
 								## Features
-												Update card count in readme

And minor formatting fixes.
											
										
										
											2016-07-29 00:45:02 +00:00
-												Readme: simplifying feature list + minor edits
											
										
										
											2015-07-27 11:06:34 +00:00
+								* Deck editor (load and save decks)
 								* Simple computer AI opponent
 								* Two player duel or a multiplayer free-for-all game with up to 10 players
 								* Supports special formats like Commander (up to 10 players), Cube, Tiny Leaders, Super Standard, Historic Standard
 								* There are two tournament types supported (elimination or swiss type handling), which can be played with up to 16 players:
-												Update card count in readme

And minor formatting fixes.
											
										
										
											2016-07-29 00:45:02 +00:00
+								    * Booster (also Cube) draft tournaments (4-16)
 								    * Sealed (also from Cube) tournaments (2-16)
-												Readme: simplifying feature list + minor edits
											
										
										
											2015-07-27 11:06:34 +00:00
-												The readme file mirrors the wiki main page now.

											
										
										
											2012-06-21 19:31:00 +00:00
 								## Installation
-												Update card count in readme

And minor formatting fixes.
											
										
										
											2016-07-29 00:45:02 +00:00
-												Readme changes: fixed spelling error, improved some grammatical things, and added a couple more resources for developers.

											
										
										
											2015-06-09 14:54:31 +00:00
+								Download and install the [latest XMage release](http://XMage.de).
-												Readme: simplifying feature list + minor edits
											
										
										
											2015-07-27 11:06:34 +00:00
+								You will need to have Version 7 or later of the [Java Runtime Environment](http://java.com/en/).
-												Updated the readme of the git repository.
											
										
										
											2013-03-05 14:22:45 +00:00
-												Update card count in readme

And minor formatting fixes.
											
										
										
											2016-07-29 00:45:02 +00:00
+								Look [here](http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=13632) for more detailed instructions.
-												Readme changes: fixed spelling error, improved some grammatical things, and added a couple more resources for developers.

											
										
										
											2015-06-09 14:54:31 +00:00
+								[Here](http://github.com/magefree/mage/wiki/Release-changes) you can find a log of the latest changes.
-												Updated readme.md and mtg-cards-data.txt.
											
										
										
											2014-04-26 08:04:11 +00:00
-												The readme file mirrors the wiki main page now.

											
										
										
											2012-06-21 19:31:00 +00:00
+								## Developer
-												Readme changes: fixed spelling error, improved some grammatical things, and added a couple more resources for developers.

											
										
										
											2015-06-09 14:54:31 +00:00
+								If you are interested in developing XMage, here are some useful resources:
-												Update card count in readme

And minor formatting fixes.
											
										
										
											2016-07-29 00:45:02 +00:00
-												Fixed links in readme file

											
										
										
											2012-06-21 19:56:24 +00:00
+								* [Developer Getting Started](http://github.com/magefree/mage/wiki/Developer-Getting-Started)
 								* [Developer Notes](http://github.com/magefree/mage/wiki/Developer-Notes)
-												Readme changes: fixed spelling error, improved some grammatical things, and added a couple more resources for developers.

											
										
										
											2015-06-09 14:54:31 +00:00
+								* [Developer Testing Tools](http://github.com/magefree/mage/wiki/Developer-Testing-Tools)
-												Fixed links in readme file

											
										
										
											2012-06-21 19:56:24 +00:00
+								* [Double Faced Cards](http://github.com/magefree/mage/wiki/Double-Faced-Cards)
-												Readme changes: fixed spelling error, improved some grammatical things, and added a couple more resources for developers.

											
										
										
											2015-06-09 14:54:31 +00:00
+								* [Card Requests](http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=4554)
-												Updated list of formats

Updated list of formats, accounting for All Standards and Historic Standards
											
										
										
											2015-07-27 10:42:45 +00:00
+								* [Tournament Relevant Card Requests](http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=14062)