https://github.com/minimaxir/mtg-card-creator-api

Code for running a Magic card image generator API
https://github.com/minimaxir/mtg-card-creator-api

api flask magic-the-gathering

Last synced: 2 months ago
JSON representation

Code for running a Magic card image generator API

• Host: GitHub
• URL: https://github.com/minimaxir/mtg-card-creator-api
• Owner: minimaxir
• License: other
• Created: 2019-07-06T03:46:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-13T20:31:31.000Z (over 5 years ago)
• Last Synced: 2024-10-04T13:42:50.616Z (3 months ago)
• Topics: api, flask, magic-the-gathering
• Language: Python
• Homepage:
• Size: 710 KB
• Stars: 16
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# mtg-card-creator-api

![](/card_image_examples/mark_rosewater.jpg)

API to create Magic card images by using [Magic Set Editor](http://magicseteditor.sourceforge.net) and [wine](https://www.winehq.org), enclosed in a Docker container. Input is an encoded card string via [mtg-gpt-2-cloud-run](https://github.com/minimaxir/mtg-gpt-2-cloud-run), outputs are Gatherer-formated text and a card image.

The API wraps code from Bill Zorn's [mtgencode](https://github.com/billzorn/mtgencode) (MIT, and Python 2 so the container includes a Python 2.7 runtime), and Magic Set Editor to render the cards into JPEGs.

This is *incredibly* jank programming, but it is not the bottleneck in the card generation (the GPT-2 text generation is) and streamlining the code workflow would not have a noticable effect on performance (image generation currently takes about 3s while card generation takes 10s-30s).

NB: The container will not work on [Google Cloud Run](https://cloud.google.com/run/) itself since the processor architecture forbids [running 32-bit apps](https://cloud.google.com/run/docs/reference/container-contract) like wine.

## Installation

Because the licensing for Magic Set Editor and fonts are ambigious, they are not included in this repo:

* For Magic Set Editor, download Basic [Magic Set Editor 2.0.1](http://magicseteditor.boards.net/page/downloads) (*not* 2.0!) and move the resulting `MSE` folder to the repo folder.

* For the fonts, download the "Fonts for Magic Templates" [here](http://msetemps.sourceforge.net/phpBB3/viewtopic.php?t=144#p601). Copy the fonts from the `Magic - All` and `Magic - After M15` folders into a `fonts` folder in the repo folder.

## Helpful Notes

* The image is returned as a base64-encoded string. It's the user's responsibility to add an approrpiate MIME-type if necessary.

* The card formatting issues are due to the underlying mtgencode/MSE implementations and are not easy to fix (most notable with Planeswalker cards). I am not actively searching for fixes, but will accept suggestions/PRs.

## Maintainer/Creator

Max Woolf ([@minimaxir](https://minimaxir.com))

*Max's open-source projects are supported by his [Patreon](https://www.patreon.com/minimaxir). If you found this project helpful, any monetary contributions to the Patreon are appreciated and will be put to good creative use.*

## License

MIT

## Disclaimer

This repo has no affiliation or relationship with Wizards of the Coast.