Skip to content

Instantly share code, notes, and snippets.

@lvl-svasseur
Last active August 29, 2015 14:04
Show Gist options
  • Save lvl-svasseur/fb5f011c350c853edd96 to your computer and use it in GitHub Desktop.
Save lvl-svasseur/fb5f011c350c853edd96 to your computer and use it in GitHub Desktop.
StorySync 2.0 Fields Spec

Spec 2.0

Existing barrels

Profile / Sign In

  • Username
  • email
  • password
  • Firstname optional
  • Lastname optional
  • watch-on optional How do you watch AMC?
  • barrel-Results
    • sync-id [number]
    • barrel-id
    • answer [number]: answer-id
  • sync-result
    • sync-id [number]
    • progress [string] "3/10"
    • character-id [number]
    • score: Determine if user succeeded
  • Season-Results
    • show-id: slug of the show name
    • season [number]
    • progress [string] "3/10"
    • character-id
    • score: Determine if user succeeded

Note: sync-result and season-results could be determined through barrel-results they would be stored only to save server-side calculations.

profile.json feed gist example

Slideshow Barrel

Standard Barrel Fields

  • Type
  • Timestamp: Time at which barrel drops.
  • Title: Title of the Barrel.
  • Name: Name of the Barrel.
  • Show Timer: Specify if the barrel should show clock
  • Platform Availability: Specify which platform this should be available for.
  • Scenario: Usage scenario for the clickthrough barrel
  • Caption
  • CSS Override: CSS to be written in.
  • twitter copy: Text that will be shared to twitter if user shares the page and not the specific barrels.
  • Facebook (OG) Title: Title of the Sync page if shared in Facebook.
  • Facebook (OG) Description: Description of the Sync page if shared in the Facebook.
  • Facebook (OG) Image: image url

+ 4 fields for each image (variable number of images)

  • Image url
    • 2730x1536
    • 1365x768
    • 1136x640
    • 960x540
    • 640x360
    • 320x180
    • 320x180
    • 226x127
  • link: url image links to when ckicked
  • twitter copy: Text that will be shared to twitter if user shares the page and not the specific barrels.
  • Facebook (OG) Title: Title of the Sync page if shared in Facebook.
  • Facebook (OG) Description: Description of the Sync page if shared in the Facebook.

Only one field could be used to open Wordpress's "Create Gallery" window and save the shortcode it generates containing the list of images IDs. [gallery ids="3119,3069,3037,3043,3038,3064"] Then Create Gallery should be modified to add Link To > Custom Url (Mimick ATTACHMENT DISPLAY SETTINGS)

Watch with Celebrity

Character entity

Consider creating an entity like for shows and sync Fields

  • Character name
  • Actor firstname
  • Actor lastname
  • Show (show-slug as per tag in syncs)

Sync

Fields Watch-with-celebrity [String] selectbox (cbox) listing actors for caracters of the show. Sselected from Character entity

Watch with Celebrity Barrel

Same as [image_default barrel][image-default.md]

Fields

  • type [String] "image:watch with"
Common fields
  • timestamp [Timestamp] Time at which barrel drops.
  • title [String] Title of the Barrel.
  • name [String] Name of the Barrel.
  • show-timer [Boolean] Specify if the barrel should show clock
  • platform Availability [String] Specify which platform this should be available for.
  • Images: Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Barrel image (2730x1536,1465x768), snap state image (640x360,320x180), and Zoomed Out Image (452x254,226x127) to be used for the barrel.
    • image-tf-2730x1536 [Url] (required)
    • image-tf-1365x768
    • image-tf-1136x640
    • image-tf-960x540
    • image-tf-640x360
    • image-tf-320x180
    • image-tf-452x254
    • image-tf-226x127
  • css-override [String] CSS to be written in.
  • twitter copy [String] Text that will be shared to twitter if user shares the page and not the specific barrels.
  • facebook-og-title [String] Title of the Sync page if shared in Facebook.
  • facebook-og-description [String] Description of the Sync page if shared in the Facebook.
  • facebook-og-image [Url] (300x300) Enter an URL or upload an image to be used in Facebook.
Specific fields
  • caption [String] Caption for the barrel. Supports limited HTML Markup. Only appears if specified.
  • caption-size [String=(large|small)] Size of the Caption.
  • link [String] Clickthrough Link. Should do nothing if not specified.

Other Barrel

New Fields

For following barrel type

  • trivia_default
  • poll-buttons 2
  • poll-buttons 3-5
  • poll_gauge button
  • poll_threat meter

We add a select box (like correct-option [trivia-default]) to choose celebrity-option

  • celebrity-option
  • celebrity-answer [String] value option-1/option-2/option-3/option-4/option-5

Auto Poll Results dev (locked/unlocked/not signed in)

Fields

Specific fields

  • twitter-character-alike-copy [String] Text of the character alike result shared in Twitter.
  • facebook-character-alike-title [String] (OG) Title of the character alike result shared in Facebook.
  • facebook-character-alike-description [String] (OG) Description of the character alike result shared in Facebook.
  • facebook-character-alike-img [String] (OG) Title of the character alike result shared in Facebook.
  • twitter-success-copy [String] Text of the success result shared in Twitter. i.e. <<I survived The Walking Dead Season 2 episode 1 #AMC-The-waking-dead-StorySync>>
  • facebook-success-title [String] (OG) Title of the success result shared in Facebook.
  • facebook-success-description [String] (OG) Description of the success result shared in Facebook. <<I defeated loyalists in Turn Season 1 episode 3 #AMC-Turn-StorySync >>
  • facebook-success-img [String] (OG) Title of the success result shared in Facebook.

c.f. results.json feed gist example

Updated Menu

c.f. Profile fields and profile.json feed gist example

Ad_default barrel

  • Type [String] "add_default" -> "add:default" (feed.json) -> "ad" (slider.js)

  • timestamp [Timestamp] Time at which barrel drops (hh:mm:ss).

  • title [String] Title of the Barrel.

  • name [String] Name of the Barrel.

  • show-timer [Boolean] Specify if the barrel should show clock

  • platform Availability [String] Specify which platform this should be available for.

  • Images: Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Barrel image (2730x1536,1465x768), snap state image (640x360,320x180), and Zoomed Out Image (452x254,226x127) to be used for the barrel.

    • image-tf-2730x1536 [Url] (required)
    • image-tf-1365x768
    • image-tf-1136x640
    • image-tf-960x540
    • image-tf-640x360
    • image-tf-320x180
    • image-tf-452x254
    • image-tf-226x127
  • css-override [String] CSS to be written in.

<< To Spec 2.0

Ad_video barrel

  • Type [String] "add_video" -> "add:video" (feed.json) -> "video-ad" (slider.js)

  • timestamp [Timestamp] Time at which barrel drops (hh:mm:ss).

  • title [String] Title of the Barrel.

  • name [String] Name of the Barrel.

  • show-timer [Boolean] Specify if the barrel should show clock

  • platform Availability [String] Specify which platform this should be available for.

  • alignment [String] (Required) Alignment of the video on desktop / table version of the app.

  • Images: Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Barrel image (2730x1536,1465x768), snap state image (640x360,320x180), and Zoomed Out Image (452x254,226x127) to be used for the barrel.

    • image-tf-2730x1536 [Url] (required)
    • image-tf-1365x768
    • image-tf-1136x640
    • image-tf-960x540
    • image-tf-640x360
    • image-tf-320x180
    • image-tf-452x254
    • image-tf-226x127
  • css-override [String] CSS to be written in.

<< To Spec 2.0

Common fields

  • timestamp [Timestamp] Time at which barrel drops (hh:mm:ss).
  • title [String] Title of the Barrel.
  • name [String] Name of the Barrel.
  • show-timer [Boolean] Specify if the barrel should show clock
  • platform Availability [String] Specify which platform this should be available for.
  • Images: Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Barrel image (2730x1536,1465x768), snap state image (640x360,320x180), and Zoomed Out Image (452x254,226x127) to be used for the barrel.
    • image-tf-2730x1536 [Url] (required)
    • image-tf-1365x768
    • image-tf-1136x640
    • image-tf-960x540
    • image-tf-640x360
    • image-tf-320x180
    • image-tf-452x254
    • image-tf-226x127
  • css-override [String] CSS to be written in.
  • twitter copy [String] Text that will be shared to twitter if user shares the page and not the specific barrels.
  • facebook-og-title [String] Title of the Sync page if shared in Facebook.
  • facebook-og-description [String] Description of the Sync page if shared in the Facebook.
  • facebook-og-image [Url] (300x300) Enter an URL or upload an image to be used in Facebook.

<< To Spec 2.0

Image clickthrough barrel

  • Type [String] "image_clickthrough" -> "image:clickthrough" (feed.js) -> "clickthrough" (slider.js)

Specific fields

  • scenario [String=(default|itunes-list|end-of-sync)] (Required) cbox for usage scenario for the clickthrough barrel.
  • caption [String] Caption to be displayed.
  • prefix-1 [String]
  • copy-1 [String]
  • clickthrough-1 [String] Link and Clickthrough 1 on the barrel
  • prefix-2 [String]
  • copy-2 [String]
  • clickthrough-2 [String] Link and Clickthrough 2 on the barrel
  • prefix-3 [String]
  • copy-3 [String]
  • clickthrough-3 [String] Link and Clickthrough 3 on the barrel
  • prefix-4 [String]
  • copy-4 [String]
  • clickthrough-4 [String] Link and Clickthrough 4 on the barrel
  • prefix-5 [String]
  • copy-5 [String]
  • clickthrough-5 [String] Link and Clickthrough 5 on the barrel
  • prefix-6 [String]
  • copy-6 [String]
  • clickthrough-6 [String] Link and Clickthrough 6 on the barrel
  • prefix-7 [String]
  • copy-7 [String]
  • clickthrough-7 [String] Link and Clickthrough 7 on the barrel
  • prefix-8 [String]
  • copy-8 [String]
  • clickthrough-8 [String] Link and Clickthrough 8 on the barrel
  • prefix-9 [String]
  • copy-9 [String]
  • clickthrough-9 [String] Link and Clickthrough 9 on the barrel
  • prefix-10 [String]
  • copy-10 [String]
  • clickthrough-10 [String] Link and Clickthrough 10 on the barrel
  • logo [File upload] Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Overlayed logo for the sync
    • logo-1304x173
    • logo-652x87
    • logo-458x61
    • logo-306x41
    • logo-153x21
    • logo-216x29
    • logo-108x15

<< To Spec 2.0

Image default barrel

  • Type [String] "image_default" -> "image:default" (feed.json) -> "image" (slider.js)

Specific fields

  • caption [String] Caption for the barrel. Supports limited HTML Markup. Only appears if specified.
  • caption-size [String=(large|small)] Size of the Caption.
  • link [String] Clickthrough Link. Should do nothing if not specified.

<< To Spec 2.0

Image document barrel

  • Type [String] "image_document" -> "image:document" (feed.json) -> "preshow" (slider.js)

Specific fields

  • caption [String] Caption for the barrel. Supports limited HTML Markup. Only appears if specified.
  • caption-size [String=(large|small)] Size of the Caption.
  • document [File upload] PDF to be displayed.

<< To Spec 2.0

Image Quote barrel

  • Type [String] "image: quote" -> slider.js: "quote"

Specific fields

  • Caption [String] (Required) Quote to be displayed. Supports limited HTML Markup.
  • Author [String] (Required) Author (or speaker) of the quote

<< To Spec 2.0

{
"success": true,
"status": 10000,
"data": {
"type": "poll",
"subtype": "gauge button",
"timestamp": "00:36:00",
"title": "TitleGaugeBarrel",
"name": "NameGaugeBarrel",
"show-timer": true,
"question": "question 1",
"option": {
"option-1": "option1",
"option-2": "option2",
"option-3": "option3",
"option-4": "option4",
"option-5": "option5"
},
"images": {
"2730x1536": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-2730x1536.jpg",
"width": "2730",
"height": "1536"
},
"1365x768": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-1365x768.jpg",
"width": "1365",
"height": "768"
},
"1136x640": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-1136x640.jpg",
"width": "1136",
"height": "640"
},
"960x540": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-960x540.jpg",
"width": "960",
"height": "540"
},
"640x360": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-640x360.jpg",
"width": "640",
"height": "360"
},
"320x180": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-320x180.jpg",
"width": "320",
"height": "180"
},
"452x254": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-452x254.jpg",
"width": "452",
"height": "254"
},
"226x127": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/108-21-HALT-img1-226x127.jpg",
"width": "226",
"height": "127"
}
},
"css-override": "",
"twitter-copy": "",
"facebook-og-title": "",
"facebook-og-description": "",
"facebook-og-image": {
"300x300": {
"src": "",
"width": "300",
"height": "300"
}
},
"permalink": "http:\/\/dev2.amctv.com\/shows\/halt-and-catch-fire\/episodes\/season-1\/halt-lvl-test\/story-sync?hash=f3b4c239ac2003703c6602c0d00ea63e"
}
}
{
"success": true,
"status": 10000,
"data": {
"type": "trivia",
"subtype": "default",
"timestamp": "00:00:05",
"title": "TRIVIA_5Answers_Good=1",
"name": "Name_TRIVIA_5Answers_Good=1",
"show-timer": true,
"extended-answeroverlay": "yes",
"question": "This is the question to be asked to the user.",
"option-count": "5",
"option": {
"option-1": "Good",
"option-2": "Bad1",
"option-3": "Bad2",
"option-4": "Bad3",
"option-5": "Bad4"
},
"correct-option": "option-1",
"answer": "This is the correct answer to the question asked.",
"answer-link": "https:\/\/itunes.apple.com\/us\/album\/the-magnificent-seven\/id647246297?i=647246399&uo=4",
"extended-answer-images": {
"230x230": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/Richard-Hell-230.jpg",
"width": "230",
"height": "230"
},
"165x165": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/Richard-Hell-230.jpg",
"width": "165",
"height": "165"
},
"78x78": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/Richard-Hell-230.jpg",
"width": "78",
"height": "78"
},
"39x39": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/Richard-Hell-230.jpg",
"width": "39",
"height": "39"
}
},
"images": {
"2730x1536": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-2730x1536.jpg",
"width": "2730",
"height": "1536"
},
"1365x768": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-1365x768.jpg",
"width": "1365",
"height": "768"
},
"1136x640": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img.jpg",
"width": "1136",
"height": "640"
},
"960x540": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-960x540.jpg",
"width": "960",
"height": "540"
},
"640x360": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-640x360.jpg",
"width": "640",
"height": "360"
},
"320x180": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-320x180.jpg",
"width": "320",
"height": "180"
},
"452x254": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-452x254.jpg",
"width": "452",
"height": "254"
},
"226x127": {
"src": "http:\/\/images.test.sync.amctv.com.s3.amazonaws.com\/wp-content\/uploads\/2013\/09\/102-17-HALT-img-226x127.jpg",
"width": "226",
"height": "127"
}
},
"css-override": "",
"twitter-copy": "",
"facebook-og-title": "",
"facebook-og-description": "",
"facebook-og-image": {
"300x300": {
"src": "",
"width": "300",
"height": "300"
}
},
"permalink": "http:\/\/dev2.amctv.com\/shows\/halt-and-catch-fire\/episodes\/season-1\/halt-lvl-test\/story-sync?hash=d3c7ef758203c8c8ae4c5c6ee8afac29"
}
}

Poll Buttons 2

  • Type [String] "poll:buttons 2" -> slider.js: "poll-2"

Specific fields

  • Question [String] (required) Question for the poll.
  • Option 1 [String] (required)
  • Option 2 [String] (required) Specify options for the poll.

<< To Spec 2.0

Poll Buttons 3-5

  • Type [String] "poll:buttons 3-5" -> slider.js: "poll"

Specific fields

  • Extended Answer [String] Set to yes, if this requires extended answers
  • Question [String] (required) Question for the poll.
  • Option Count [Number] (required) Number of Options.
  • Option 1 [String] (required)
  • Answer 1 [String] (required)
  • Option 2 [String] (required)
  • Answer 2 [String] (required)
  • Option 3 [String] (required)
  • Answer 3 [String] (required)
  • Option 4 [String]
  • Answer 4 [String]
  • Option 5 [String]
  • Answer 5 [String] Option and Answer for 1-5 of the poll

<< To Spec 2.0

Poll Matrix barrel

  • Type [String] "poll:gauge button" -> slider.js: "gauge"

Common fields

  • timestamp [Timestamp] Time at which barrel drops.
  • title [String] Title of the Barrel.
  • name [String] Name of the Barrel.
  • show-timer [Boolean] Specify if the barrel should show clock
  • platform Availability [String] Specify which platform this should be available for.
  • Images: Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Barrel image (2730x1536,1465x768), snap state image (640x360,320x180), and Zoomed Out Image (452x254,226x127) to be used for the barrel.
    • image-tf-2730x1536 [Url] (required)
    • image-tf-1365x768
    • image-tf-1136x640
    • image-tf-960x540
    • image-tf-640x360
    • image-tf-320x180
    • image-tf-452x254
    • image-tf-226x127
  • css-override [String] CSS to be written in.
  • twitter copy [String] Text that will be shared to twitter if user shares the page and not the specific barrels.
  • facebook-og-title [String] Title of the Sync page if shared in Facebook.
  • facebook-og-description [String] Description of the Sync page if shared in the Facebook.
  • facebook-og-image [Url] (300x300) Enter an URL or upload an image to be used in Facebook.

Specific fields

  • Question [String] (required) Question for the gague.
  • Option 1 [String] (required) Option 1-5 for the gauge
  • Option 2 [String] (required) Option 1-5 for the gauge
  • Option 3 [String] (required) Option 1-5 for the gauge
  • Option 4 [String] (required) Option 1-5 for the gauge
  • Option 5 [String] (required) Option 1-5 for the gauge

<< To Spec 2.0

Poll Matrix barrel

  • Type [String] "poll:matrix" -> slider.js: "matrix"

Common fields

  • timestamp [Timestamp] Time at which barrel drops.
  • title [String] Title of the Barrel.
  • name [String] Name of the Barrel.
  • show-timer [Boolean] Specify if the barrel should show clock
  • platform Availability [String] Specify which platform this should be available for.
  • Images: Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct. Barrel image (2730x1536,1465x768), snap state image (640x360,320x180), and Zoomed Out Image (452x254,226x127) to be used for the barrel.
    • image-tf-2730x1536 [Url] (required)
    • image-tf-1365x768
    • image-tf-1136x640
    • image-tf-960x540
    • image-tf-640x360
    • image-tf-320x180
    • image-tf-452x254
    • image-tf-226x127
  • css-override [String] CSS to be written in.
  • twitter copy [String] Text that will be shared to twitter if user shares the page and not the specific barrels.
  • facebook-og-title [String] Title of the Sync page if shared in Facebook.
  • facebook-og-description [String] Description of the Sync page if shared in the Facebook.
  • facebook-og-image [Url] (300x300) Enter an URL or upload an image to be used in Facebook.

Specific fields

  • Question [String] (required) Question for the poll.
  • Option 1 [String] (required) Option 1-4 for the poll
  • Option 2 [String] (required) Option 1-4 for the poll
  • Option 3 [String] (required) Option 1-4 for the poll
  • Option 4 [String] (required) Option 1-4 for the poll

<< To Spec 2.0

Social spotify barrel

  • Type [String] "social_spotify" -> "social:spotify" (feed.js) -> "spotify" (slider.js)

Specific fields

  • playlist-url [String] Playlist URL of the spotify to be used for twitter barrel
  • footer-copy [String] (Required) Copy to used in the footer for spotify.
  • footer-link [String] (Required) Link to used in the footer for spotify.

<< To Spec 2.0

Social twitter barrel

  • Type [String] "social_twitter" -> "social:twitter" (feed.js) -> "twitter" (slider.js)

Specific fields

  • widget-id [String] Twitter Widget ID to be used for twitter barrel

<< To Spec 2.0

Trivia barrel

  • Type [String] "trivia:default" -> slider.js: "poll"

Specific fields

  • Extended Answer/Overlay [String] Set to yes, if this requires extended answers and overlay
  • Question [String] (required) Question for the Trivia.
  • Option Count [Number] (required) Number of Options.
  • Option 1 [String] (required)
  • Option 2 [String] (required)
  • Option 3 [String]
  • Option 4 [String]
  • Option 5 [String]
  • Correct Option [String] (required) Values (option-1|option-2|option-3|option-4|option-5). Option that is correct
  • Answer [String] Answer to the option
  • Answer Link [String] Link on the answer field
  • Extended Answer Images: (required) Try uploading the largest image first then save to see if it suffices as it will automatically resize to smaller image. Image will ONLY resize if the dimesnion of the uploaded image is correct.
    • (230x230)
    • (165x165)
    • (78x78)
    • (39x39)

<< To Spec 2.0

Welcome pre-show barrel

  • Type [String] "welcome_pre-show" -> "welcome:pre-show" (feed.json) -> "preshow" (slider.js)

Specific fields

clickthrough [String] Link and clickthrough on the barrel

<< To Spec 2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment