guidokessels / xwing-data

An easy-to-use collection of data and images from X-Wing: The Miniatures Game by Fantasy Flight Games.
93 stars 37 forks source link

Support for Second Edition? #202

Open mludowise opened 6 years ago

mludowise commented 6 years ago

X-Wing Second Edition was announced today and it contains updated rules, cards, and ship maneuvers.

Does it make sense to update xwing-data to reflect the second edition cards & maneuvers? Or does it make more sense for the second edition stuff to live in a different data repository so that all of the first edition data is still available? The second edition doesn't come out until September 2018, so there's plenty of time to figure it out and update our apps appropriately.

I have opinions about how I might want to update my Dial Vision app for the second edition, but I'm interested to hear what other developers think who also use xwing-data.

guidokessels commented 6 years ago

I hope FFG will create an API that can be used by developers to build X-Wing apps. They haven't announced any plans yet so I don't think this is likely.

So yes, I think xwing-data will exist in some form for Second Edition. This could live in a new branch (which would eventually replace master as the main branch) or a separate repository.

As FFG is launching their own squad builder app and website I think most of the contents in the data folder could just be scraped from there. We could have a recurring job that checks the FFG Squad Builder for changes and automatically updates the data files and images. Then we can manually add things that FFG has not yet added to their site (info from preview articles, etc.)

mludowise commented 6 years ago

It would be great if FFG maintained an API, but I suspect that, since their app will focus on squad building and tournaments, it likely won't support everything xwing-data (like ship maneuvers). Only time will tell though.

In my case, I only utilize the ship maneuver data from ships.js to let users preview their ship maneuvers in-app. I'm trying to decide if...

  1. I want to allow my users to select whether they're using 1st or 2nd edition ship dials
  2. Assume the users are on 2nd edition and use the corresponding data

I'm curious what other xwing app developers are planning to do but I think that it might make the most sense to make a branch for 1st edition and update master to 2nd edition. That way apps will automatically pickup the changes for 2nd edition but developers can make both editions available if they choose by displaying data from both branches.

That said, it sounds like there would need to be some schema modifications to accommodate the new rule set since they're doing away with points and changing how actions and upgrade slots work. That could be argument to make 2nd edition a separate repo so that schema updates don't break existing apps before they have a chance to make updates.

breynolds-dev commented 6 years ago

Personal preference for me basing of it API work would be to keep both in a v1 or firstEdition and v2 or secondEdition format. Eventually you'll want to depreciate and phase out the first edition content, but some of things I'm working on are not likely to change quickly (HotAC / Battlestar Pallas). A format like firstEdition and secondEdition allows for easier transitions IMO then having to entirely switch branches that I'm pulling from and rewrite everything from day one.

I'm super excited that this project exists and really appreciate the work you've done thus far :)

ajmath commented 6 years ago

+1 to keeping it all in one branch. My personal experience is that things that won't ever be merged shouldn't go in different branches (i.e. gh-pages). If anything, maybe split it off into a separate repo?

On Fri, May 4, 2018 at 1:28 PM Brian Reynolds notifications@github.com wrote:

Personal preference for me basing of it API work would be to keep both in a v1 or firstEdition and v2 or secondEdition format. Eventually you'll want to depreciate and phase out the first edition content, but some of things I'm working on are not likely to change quickly (HotAC / Battlestar Pallas). A format like firstEdition and secondEdition allows for easier transitions IMO then having to entirely switch branches that I'm pulling from and rewrite everything from day one.

I'm super excited that this project exists and really appreciate the work you've done thus far :)

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/guidokessels/xwing-data/issues/202#issuecomment-386671251, or mute the thread https://github.com/notifications/unsubscribe-auth/AAQRt-CQY9IHkLUaNo0SdF_BjDryLBWnks5tvI-0gaJpZM4TunDB .

rune-b commented 6 years ago

I don't think the first edition content should be phased out at all. People may still use first edition for HotAC etc. I would prefer if data for both editions (and possible future editions)

guidokessels commented 6 years ago

Hey all!

I just watched the conversion kit unboxing and I'm slowly putting all the content into json files in a new repository: https://github.com/guidokessels/xwing-data2

I decide to create a new repository for now so I can try out some things before merging it back into xwing-data. You'll notice that the schema is a bit different. I am trying out some different things to adjust to the new changes, to fix some issues we had with the original schema and also to (hopefully) make it easier to adapt to anything crazy FFG might come up with later.

Nothing is set in stone though, and I welcome all suggestions and feedback! If anyone wants to contribute please fork it and make a pull request :heart:

You’ll notice that each ship has its own json file now. The files in xwing-data were starting to get waaaay too long so I’d like to try and have multiple files and perhaps add a build step that generates The Big File and/or export a JS api to fetch things from the data files

guidokessels commented 6 years ago

Hey all. I've gathered all the content for 2.0 and I'm busy transcribing it to JSON. It's a lot of content so it'd be great to have some help.

I hacked together a little website that you can use to help out. Once we have transcribed all images we can then generate JSON files for xwing-data2.

Here’s how you can help:

Let me know if you find any issues. Right now it only supports pilots, but I'll add upgrades and ships soon.

cmveas commented 6 years ago

Hey @guidokessels I fill some yesterday but the rest seems to be finished by today. Let me know when you have more.

acosoi commented 6 years ago

Pilot / ship abilities are not described in a consistent format (Focus for example is sometimes described as (eye), other times as [Focus]).

Is there any documentation anywhere on how to annotate symbols? Beyond just using the name from the official rule book.

cmveas commented 6 years ago

I was also wondering about that @acosoi. I tried to use the same format is it is in the previous version but I also agree that there are some inconsistencies and also there are new terminologies / icons.

For example: Soontir Fel in his description names a small area in front of the ship whose name I dont know. So if anybody can review that one, it would be great

https://guidokessels.github.io/xwing-data-crowdsourcing/#/pilots/5b0347fb9c81923d57641580

breynolds-dev commented 6 years ago

Looks like that is the Bullseye Arc, looks correct in the description text

guidokessels commented 6 years ago

Thanks everyone who helped out! I only launched the page around midnight last night and already all 99 pilots have been transcribed!

I've found a few more images and will add those this evening, and I'll get working on upgrades as well

@acosoi When we're done I'll go through all pilots and make sure the text format is consistent. I'll also update the page to add info on how to transcribe the icons.

For maneuvers you can use any of these: [Bank Left] [Bank Right] [Koiogran Turn] [Reverse Bank Left] [Reverse Bank Right] [Reverse Straight] [Segnor's Loop Left] [Segnor's Loop Right] [Stop] [Straight] [Tallon Roll Left] [Tallon Roll Right] [Turn Left] [Turn Right]

For arcs use these: [Front] [Rear] [Turret] [Front180] [Rear180] [Turret180] [Bullseye]

For actions use these: [Barrel Roll] [Boost] [Cloak] [Coordinate] [Evade] [Focus] [Jam] [Recover] [Reinforce] [Reload] [Rotate Arc] [SLAM] [Lock]

Note that Target Lock is now called Lock (I believe they mentioned in one of the videos that they'd renamed it).

acosoi commented 6 years ago

Awesome, thanks for the list!

guidokessels commented 6 years ago

I've added a few more pilot images that need transcribing: https://guidokessels.github.io/xwing-data-crowdsourcing

I'll start to add support for upgrades this weekend. Thanks everyone for your help.

cmveas commented 6 years ago

@guidokessels Either I cant see the new data or someone was realllly fast to transcribe what you added :O

guidokessels commented 6 years ago

@cmveas Yep it's all done already :)

I'll try and add upgrades this weekend, and get started in generating JSON files from the data.

guidokessels commented 6 years ago

I've added all the pilots that've been revealed from the Rebel Conversion Kit. If you have a minute or two to spare, please help to transcribe some of the cards :)

https://guidokessels.github.io/xwing-data-crowdsourcing

cmveas commented 6 years ago

late today will do some if available :+1

acosoi commented 6 years ago

Looks like the pilots from the Rebel Conversion Kit have been transcribed.

guidokessels commented 6 years ago

Looks like the pilots from the Rebel Conversion Kit have been transcribed.

Yep, you guys are awesome! Thanks all!