magefree/mage

Magic Another Game Engine

XMage — Magic, Another Game Engine

XMage allows you to play Magic against one or more online players or computer opponents. It includes full rules enforcement for over 25 000 unique cards and more than 65 000 reprints from different editions. You can also find custom sets like Star Wars. All regular sets have nearly all implemented cards.

It supports single matches and tournaments with dozens of game modes like duel, multiplayer, standard, modern, commander, pauper, oathbreaker, historic, freeform, richman and much more.

Local server supports a special test mode for testing combos and other game situations with pre-defined conditions.

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 and resources:

• Official XMage support and feature request on github;
• Official XMage forum (outdated);
• Reddit XMage group;
• Reddit XMage discord channel;
• Latest changes;
• Latest news;
• Latest releases;
• Project documentation.

Servers status:

• http://xmage.today/servers/ (temporarily out of service)

Beta server with un-released or under development features:

• http://xmage.today/ (release version)

Features

• Multiplatform app: Windows, Linux, MacOS;
• Deck editor (support multiple deck formats and deck sources);
• Two player duel or a multiplayer free-for-all game with up to 10 players;
• Computer AI opponents;
• Players rating system (Glicko);
• Supports special formats like Commander (up to 10 players), Oathbreaker, Cube, Tiny Leaders, Super Standard, Historic Standard and more;
• Single matches or tournaments 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)

Bug report / feature request

The best way to report bug or feature request is github's issues page.

Installation / running

• Download latest XMage launcher and app files and un-pack it to any folder like D:\games\xmage;
• You need to have Java version 8 or later to run launcher.

Wiki page contains detail information about private or public server setup.

Server options

The XMage server locates by default the configuration file from the current working directory to the relative path config/config.xml (config\config.xml in Windows). To change this location, start the server with the property xmage.config.path set to the desired location, for example -Dxmage.config.path=config/otherconfig.xml. The option can be set from the XMageLauncher in Settings > Java > Server java options.

Troubleshooting / FAQ

Github issues page contain popular problems and fixes:

• Any: program freezes on startup (white/blue/black screen);
• Any: can't download images or it stops after some time;
• Any: can't run client, could not open ...jvm.cfg;
• Any: no texts or small buttons in launcher;
• Windows: ugly cards, buttons or other GUI drawing artifacts;
• MacOS: can't run on M1/M2;
• MacOS: can't open launcher;
• MacOS: client freezes in GUI (on connect dialog, on new match);
• Linux: run on non-standard OS or hardware like Raspberry Pi;
• Linux: ugly GUI and drawing artifacts;

Performance tweaks

If you have a good GPU, it's very likely you'll be able to increase performance by a lot through extra Java flags.

XMage runs on JRE 8, so this link should give you the available flags.

How to enable the extra flags

1. Launch XMage
2. In the menu bar from the launcher, click on "Settings", which will open up the Settings Window
3. Go to the "Java" tab
4. You can pass extra flags by editing the "Client java options" text field

Linux tweaks

Enable OpenGL

More info about OpenGL:

• -Dsun.java2d.opengl=true

Possible problems:

• Caveat: There's a bug with the file chooser when OpenGL is enabled (you use the file chooser when you, for instance, try to load a deck from disk). The suggested workaround will make the game crash, so it's not an option.
• Workaround: When using i3, you're able to work around the bug by toggling the "floating" capabilities of the window and forcing it to re-render.

Enable XRender

More info about XRender:

• -Dsun.java2d.xrender=true

Increase memory usage

This is not guaranteed to yield improvements, but it depends on your use-case. If you have a lot of RAM to spare, you can increase the initial heap size for good measure. More details about memory settings:

• -Xms1G -Xmx2G

Developer

Full project documentation and instructions for developers can be found in wiki pages.

First steps for Xmage's developers:

• Setting up your Development Environment
• Development Testing Tools
• Development Workflow
• Development HOWTO Guides

Torch icons created by Freepik - Flaticon

mage's Issues

The kicker ability

I was adding the Buyback ability and noticed that the KickerAbility (which I am using as a template) does not display the "Use kicker" text prompt during activation. In fact, it does not appear to use the activation code.

Livewire Lash is not implemented correctly

Just met it in the game, creature with Infect was targeted by me and dealt damage but it was usual.

I looked at the code and it is really so: DamageTargetEffect deals 2 damage from source.getSourceId() but as it comes from Livewire Lash it happens so that Livewire Lash deals that damage not equipped creature.

Please reimplement when have time.

Can play card revealed by opponent

Description

One can play a card from the list revealed by an opponent.

Setup

hand:Computer:Relentless Skaabs:1
hand:Computer:Appetite for Brains:1
battlefield:Human:Swamp:2
hand:Human:Appetite for Brains:1

Elderscale Wurm Tooltip incomplete

When picking order of triggered abilities, the tooltip of the Elderscale Wurm only shows "When Elderscale Wurm enters the battlefield,."

Craterhoof Behemoth calculates +x/+x wrong

The +x/+x is equal to all creatures on the battlefield but is only has to be +x/+x for each creature Craterhoof Behemoth controller controls.
The
static {
filter.add(new ControllerPredicate(TargetController.YOU));
}
is missing.

Phantasmal Image needs to be reimplemented

I think this should have a stand alone replacement effect.

ConcurrentModificationException when one player loses the game in multiplayer

reported by player

When they play 4-players game, and one lost, they got the stacktrace with ConcurrentModificationException

I have a screenshot

SearchLibraryPutInHandEffect reveal and forceShuffle changes

As I've seen, the only cards that have an optional shuffle are the ones from optional abilities. As such, the optional part should either be in the effect or in the ability. There is forceShuffle in the effect, but unless using player.chooseUse, it is only inducing bugs.

Also, the default for reveal should be true. This means all the cards using this effect must be checked while refactoring.

Edit: All search effects should be refactored. I am thinking over using a builder.

Faith's Reward tooltip missing

The tooltip of Faith's Reward is empty.

Huntmaster of the Fells triggered ability shouldn't be optional

The triggered ability of Huntmaster of the Fells shouldn't be optional.
It must be mandatory because there is no "may" in the wording of the ability.

Rule:
603.5. Some triggered abilities' effects are optional (they contain "may," as in "At the beginning of your upkeep, you may draw a card"). These abilities go on the stack when they trigger, regardless of whether their controller intends to exercise the ability's option or not. The choice is made when the ability resolves. Likewise, triggered abilities that have an effect "unless" something is true or a player chooses to do something will go on the stack normally; the "unless" part of the ability is dealt with when the ability resolves.

Create User Guide on wiki

Create a wiki page with screenshots explaining various aspects of the game:

• hot keys
• configuring phase skipping
• downloading images/icons
• setting avatars
• generating decks (e.g. saying that {X}{X} means double color deck where two color are defined randomly)
• etc. etc. etc.

Some sort of user manual, with pictures.

Check Vanguard's shield able to block two creatures

Player said he couldn't do it or maybe he doesn't know how to block two creatures

AI blocked Chapel Geist with Tangle Mantis

AI: mad ai
Version: 0.8.4

Sometimes AI blocks creature it can't block. This time it blocked creature with flying by creature without flying.
Tangle Mantis was equipped with Wolfhunter's Quiver

Hint: seems the method that determines the available blockers is not correct

Creature with undying didn't forget -1/-1 after dying and returning from graveyard

Version 0.9.0 Human vs. Human
Turn 4 - Player A casting a Strangleroot Geist (2/1, Haste, Undying)
Turn 5 - Player B casting Cower in Fear (Opponent Creatures get -1/-1 until end of turn)
Strangleroot Geist dies and returns with a +1/+1 counter. But P/T will only be shown with 2/1.
So it seems like the -1/-1 of the Cower in Fear will be used for the returned Strangleroot geist.
Turn 6 - Strangleroot Geist now has P/T 3/2

But this is wrong imho.
Rule:
An object returned to the battlefield with the undying ability is a new object with no memory of its previous existence. It has "summoning sickness".
7/1/2012: Cower in Fear affects only creatures your opponents control at the time it resolves. It won't affect creatures that come under their control later in the turn.

Textbox for tooltip is sometimes too small to show all the text

Textbox for tooltip is sometimes too small to show all the text.
There should be a scrollbar or the size of the box has to be dynamic to show all the text.

AI killed non attacking creature with Divine Verdict

Not sure it is only AI bug

AI casts Pacifism on its own creatures

It's strange as Pacifism has effect with outcome=Detriement

Disabling "Show tooltips" doesn't affect battlefield and stack cards

Discard selection in Preferences dialog for "Show tooltips" option.

Play the game.

Result: tooltips are not shown only for hand cards, and are still displayed for other zone
Expected: no tooltips are displayed in any zone in the game (battlefield, stack, grave, hand)

Vile Rebirth or Revive always fizzles when cast by AI

Vile Rebirth (M13) always fizzles when cast by AI (MAD).
i guess tarageting in opponent graveyard may cause the problem.

Same is true for Revive, cast by the AI with green card in graveyard.

Fatal Frenzy doesn't boost target creature

it gives only trample

Creature can't block because of Blazing Torch equipment

The bug is in BlazingTorchEvasionEffect extending CantBlockSourceEffect that automatically adds
@OverRide
public boolean canBlock(Permanent attacker, Permanent blocker, Ability source, Game game) {
return false;
}

Assigning to you, Robert, because seems it was implemented by you first.

BoostSourceWhileControlsEffect rule text

Rule text doesn't display filterDescription as it should.
Example card: Crimson Muckwader.

Exalted doesn't work correctly

play Sublime Archangel
play Captain's Call

all tokens will get Exalted (according to tooltips)
but when Sublime Archangel attacks alone, it will get exalted bonus only from two creatures - Sublime Archangel and one token

if you play any other creature, only two bonus will be applied anyway

Creature display order on the battlefield random

Wouldn't it be better to display the creatures on the battlefield in the order they first entered the battlefield?
Now the order seems to me random and it's less convenient to find the last cast creature on the battlefield.

Add common effect for putting cards from top to graveyard

We need to make putting cards from library to graveyard as game method.
It is rather common effect, so won't it be better if we have

game.putCardsFromTopToGraveyard(player, amount)
or at least
new PutCardsFromTopToGraveyardEffect(player, amount).apply(game, source)

have a look at cards like Altar of Dementia

Scope:

• add common effect
• refactor all cards with such effect

Jace's Phantasm doesn't work

Opponent had 16 cards in hius graveyard, I had 4.
Jace's Phantasm was still 1/1

Unrecoverable error on server with copy tokens

http://s45.radikal.ru/i109/1207/11/acf022ee6b1d.jpg

Could reproduce it with
hand:player:Cackling Counterpart:1

AI choosing can only choose one target

Description

Issue found at mage.player.ai.ComputerPlayer.choose(Outcome outcome, Target target, UUID sourceId, Game game, Map<String, Serializable> options)

For every target it is always considered to require only one choice.

Setup

battlefield:Computer:Glistener Elf:3
battlefield:Human:Swamp:5
hand:Human:Barter in Blood:1

Additional cost for creatures is not displayed

Test case:
hand:Human:Stitched Drake:1

Fix target required behavior

The target should be required by default. It becomes optional just for abilities with optional effects. As such, this behavior should be implemented there. It can also be found in some custom effects implementations that handle the optional part themselves.

AI untaps opponents land

AI uses Arbor Elf's ability to untap player's land.

It's possible to equip opponents creature

At first, it was found during playing vs AI: it simply equipped my creature with its own equipment

I've created EquipAbilityTest that proved the bug existance.
Probably it's related to new filters somehow.

It is possible to cancel creature attack even if it must attack

In case creature must attack this turn, game forces it to attack if possible without asking player.

But later, during declare attacker step, player can cancel such attack. That shouldn't be possible.

It is not possible to redirect damage to its own planeswalker

if players casts Shock targeting himself, game doesn't ask him about redirecting damage to his planeswalker.
Though redirecting works when Shock targets opponents.

Islandwalk from Master of the Pearl Trident remains after the Master is in the graveyard

Turn 5 Computer casts Master of the Pearl Trident
Turn 15 Computer casts Talrand, Sky Summoner, getting the "Islandwalk" and the "+1/+1/ from the master.
also in turn 15 the computer attacked with the Master of the Pearl Trident and I blocked it and the Master died.
Turn 17 computer attacked with the Talrand, Sky Summoner and I couldn't select the Talrand to block like he has islandwalk. The "Islandwalk" in the tooltip was gone, but it seems as if the islandwalk was internaly not removed.

Have lightweight cards representation

I propose to keep a database with all the meta-information that we update dynamically.

There will be a column with the className so that we can easily instantiate the cards implementation in a game. This is the field we will check against to see if the card is already added to the database. This way, there is no need to instantiate all the cards.

We can use the file we currently have for card generation to add the exact oracle text for the abilities.

Graveyard dialog not displayed when multiple games played

If you create two games and you open Graveyard dialog in the first game then you won't be able to open the graveyard dialog in second one.
Whenever you click grave button in the second game, dialog is opened in the first game instead.

Again non flying creature blocked creature with flying

TODO: add double checking in combat and tracing all available data to find out the root cause

Gravecrawler could block creatures with and without flying.

Gravecrawler could block creatures with and without flying.

http://www.slightlymagic.net/forum/viewtopic.php?f=70&t=7850&p=96541#p96541

War Falcon - Attack condition does not work properly

Vers. 0.9.0 Human vs. Human

Turn 12 - Opponent casts a Switcheroo giving me his Faerie Invaders and taking my War falcon. I have a 1/1 soldier from Captains's call on my side.
Turn 16 - He can attack with the War Falcon without having any Knight or Soldier (guess he could have attacked also on turn 14).
Seems like my soldier count for the attack condition.

You can re-cast Bond Beetle from battlefield

For unknown reason it is possible to cast Bond Beetle again from battlefield. Could reproduce it in several games.
Checked on other (this time white) creature, it didn't happen.

it may relate to the bug with giving to all green creature flash.

AI equips creatures over and over

Sometime it ruins PvAI games as AI stops casting spells spending all mana for the same equipment reequiping pair of its own creatures from one to another and back

Now sure what can be done here, but at least it shouldn't happen so easily as evaluation function should return less value as reequipping almost always results in tapped lands what shouldn't happen as there is a big penalty for tapped permanents.
It is especially seems strange when AI starts reequipping from first creature and ends with it through several cycles: so AI has the same game board position but with all lands tapped, that means that it is not because of horizon effect.

Should be fixed before Mage Release 0.9

End combat icon will not be shifted to left if it's the current phase

The Icon from the current phase will be shifted to left in the phase bar.
But if the current phase is the "end combat" phase, this icon won't be shifted.

Server hangs time to time

And it happens more often for multiplayer
report from players:
http://s014.radikal.ru/i328/1207/54/a4ddca79361d.jpg

As for me, I regulary see such warning messages in server logs and it is very very old.
As far as I remember it relates to passing priority within the game.

Add notification if a player joins your table

Now it is not possible to know if someone joined your table except in GUI
That's the problem as you may create a game and switch Mage.Client to any other program while waiting for a player to join.
But now the only option to start the game is check regulary the gui for player joined.

Rewrite filters

Filters need to be changed to offer more flexibility. This shouldn't come by having to modify the filter class. A strategy pattern shall be applied.

Card display order in graveyard random

Wouldn't it be better to show the cards in graveyard in the order they went to the graveyard.
Currently the order seems to me is random, so it's sometimes hard to find out, which card(s) went to the graveyard lately.

Improve DynamicValues for effect texts

I don't have a clear idea at the moment on how this should change. Some "research" must be done first to come up with a set of specifications for the dynamic values.

This will have an impact on the effect texts and should provide a cleaner way of implementing a DynamicValue. Currently, some conventions were used like the toString method should return some specific text. This isn't a good practice.

AI may use Evil Twin to kill any creature

mad ai used its Evil Twin to kill all my creatures one by one

Tooltip doesn't show by default

Tooltips doesn't shown until you remove and set again this option in preferences