documentation updates - Githubissues

Cockatrice / Magic-Spoiler

Tools for generating Cockatrice-compatible cards.xmls for unreleased magic cards

GNU General Public License v3.0

16 stars 18 forks source link

Open tooomm opened 7 years ago

tooomm commented 7 years ago

[ ] CONTRIBUTING.md (e.g. code style conventions: https://github.com/Cockatrice/Magic-Spoiler/pull/98#issuecomment-313163870)
[ ] README.md: part for developer and part for user (e.g. quick links to user editable files)
[ ] Wiki maybe

dev-id commented 7 years ago

skwerlman commented 7 years ago

[x] Explain (either in release notes or in the wiki) the difference between spoiler.xml and <setcode>.xml

tooomm commented 7 years ago

Groundwork for correction files documentation layout done in #133

Notes for myself:

Still missing a hint for copy and paste workflow from error log to corrections file
manual file: change Form part something like this possible?
```
- name attribute: value
other fields: value
```
explanation comments: (additionally? instead?) link to wiki with more details and explanations of all keys etc.
important key fields are: name, manaCost (calculation for cmc and color) and type to make subtype, supertype, and check to see if a card should have certain properties (loyalty for PW, p/t for creature), rarity and url also very important for draft page (and information on booster in set_info)

dev-id commented 7 years ago

tooomm commented 3 years ago

[x] Explain (either in release notes or in the wiki) the difference between spoiler.xml and <setcode>.xml

[x] CONTRIBUTING.md has some remaining json references

The old references to the former correction json files are gone, we don't use them as the script fundamentally changed in between and utilizes the Scryfall API after a rewrite: https://github.com/Cockatrice/Magic-Spoiler/blob/master/.github/CONTRIBUTING.md