mirror of
https://github.com/Cockatrice/Magic-Spoiler.git
synced 2026-03-21 17:54:59 -05:00
49 lines
3.2 KiB
Markdown
49 lines
3.2 KiB
Markdown
[](https://github.com/Cockatrice/Magic-Spoiler/blob/files/spoiler.xml)
|
|
[](https://github.com/Cockatrice/Magic-Spoiler/blob/files/spoiler.xml)
|
|
[)](https://github.com/Cockatrice/Magic-Spoiler/blob/files/spoiler.xml)
|
|
|
|
<br>
|
|
|
|
# Magic-Spoiler [](https://discord.gg/3Z9yzmA) [](https://gitter.im/Cockatrice/Magic-Spoiler) #
|
|
|
|
Magic-Spoiler is a Python script to query the <i>[Scryfall](https://scryfall.com)</i> API to compile XML files (Cockatrice formatted) and application-ready JSON files (MTGJSON formatted) with information about spoiled cards from upcoming sets.
|
|
|
|
## Output [](https://github.com/Cockatrice/Magic-Spoiler/actions?query=workflow%3ADeploy+event%3Aworkflow_dispatch+event%3Aschedule+branch%3Amaster) ##
|
|
>**Enable "Download Spoilers Automatically" in `Cockatrice → Settings → Card Sources → Spoilers` to get updates automatically pushed to your client!**<br>
|
|
You can also [add the desired <b>.xml</b> file(s) to your <i>customsets</i> folder manually](https://github.com/Cockatrice/Cockatrice/wiki/Custom-Cards-&-Sets#to-add-custom-sets-follow-these-steps) to make Cockatrice use it.
|
|
|
|
Just looking for XML or JSON files? [They are in our `files` branch!](https://github.com/Cockatrice/Magic-Spoiler/tree/files)
|
|
|
|
When run by our CI, the script automatically updates the files and uploads new versions to this branch. ([History of changes](https://github.com/Cockatrice/Magic-Spoiler/commits/files))<br>
|
|
GitHub Actions are scheduled to autoamtically run on a daily basis.
|
|
|
|
## Contributing ##
|
|
Noticed an error in the card data? Check out our [Contributing file](https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md) for information on how to help fixing it!
|
|
|
|
We do happily accept PR's that improve our script as well!
|
|
|
|
## Running ##
|
|
|
|
### Requirements ###
|
|
* Python 3.6
|
|
* several Python Modules (see [requirements.txt](https://github.com/Cockatrice/Magic-Spoiler/blob/master/requirements.txt))
|
|
|
|
```
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
### Usage ###
|
|
|
|
```
|
|
$> python -m magic_spoiler
|
|
```
|
|
|
|
### Output ###
|
|
|
|
All XML and JSON spoiler files are written to the `out/` directory:
|
|
|
|
| File Name | Content |
|
|
|:--|:--|
|
|
| `spoiler.xml`, `spoiler.json` | files contain **all** currently available spoilers from different **sets** |
|
|
| `{SET_CODE}.xml`, `{SET_CODE}.json` | files contain just the spoiler available for this **single set** |
|