search

taw / magic-search-engine

Search engine for Magic cards
MIT License
47 stars 19 forks source link

First draft of YAML sheet documentation #199

Closed axxroytovu closed 1 year ago

axxroytovu commented 1 year ago

Add documentation for creating boosters with YAML.

taw commented 1 year ago

This looks reasonable to me. I could make multipart print sheets more flexible if that surprises people. The system was developed for early Magic sets long before any multipart cards.

axxroytovu commented 1 year ago

It's really not that big of a deal once you get used to it. It just took me a minute to figure out why Brazen Borrower wasn't working but now I'm just used to it.

Are there any sections I'm missing or need more detail?

taw commented 1 year ago

I think the missing part is how to run it locally and debug it or view the boosters.

Which might be not so obvious, as the image download script is not part of the repo, and Rails pack interface is very image-centric.

taw commented 1 year ago

If you are adding a new booster or modifying a set code you will need to execute

ruby ./indexer/bin/indexer

This shouldn't be needed anymore. There are some leftover things it affects like is:booster and st:booster queries, which I still need to move to the new system, but other than that you shouldn't need reindexing.

axxroytovu commented 1 year ago

I tested it and you are correct. I was still reindexing every time I added a new booster so this is very convenient!

taw commented 1 year ago

Actually I forgot one case, changing print sheets still requires reindexing, and I don't think that one is going away.

axxroytovu commented 1 year ago

Yeah I kept that bit and removed the reference to adding boosters. 👍

taw commented 1 year ago

I moved style section to the end, as it's not really what new reader needs to know first.

Also marked blocks with yaml tag so github knows how to highlight it.