Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spec: {catalog/manifest}.behaviorHints #16

Open
Ivshti opened this issue Sep 14, 2018 · 5 comments
Open

Spec: {catalog/manifest}.behaviorHints #16

Ivshti opened this issue Sep 14, 2018 · 5 comments
Assignees

Comments

@Ivshti
Copy link
Member

Ivshti commented Sep 14, 2018

catalogs in the manifest (and possibly other things) should have this property called behaviorHints, which allows to tell the app how it prefers to be visualized or how it should behave

the most obvious example: if it's adult content, have adult set to true; the app will visualize it as adult, meaning it will hide it before some additional step is done

if we want it to appear only on discover or on board, have a flag for that

furthermore, this can be used for very special stuff, for example a different visualization of meta items that is used in specific cases: e.g. recommendations

it could also be used to tweak how things are handled; for example, if you return stuff with video with a stream from your search results, you might want to have a flag that commands stremio to go straight to the player, skipping the detail page

@Ivshti
Copy link
Member Author

Ivshti commented Sep 14, 2018

the format of this object should be lef open-ish

since there's so many possibilities, this is a matter of negotiation between add-on developers and app developers; over time, a de-facto standard might appear

@Ivshti
Copy link
Member Author

Ivshti commented Sep 15, 2018

Also, a nice one would be to customize the message shown to the user when the catalog is empty; e.g. "Your Trakt watchlist is empty"

@Ivshti
Copy link
Member Author

Ivshti commented Sep 19, 2018

Use cases:

  1. Specific messages from add-ons
  2. Specific types of stuff that has to be displayed; e.g. notifications - they sometimes have a hint (balloon-style) saying what they are
  3. Different views altogether, e.g. recommendations
  4. not wanting stuff shown in some sections of the product

@Ivshti Ivshti changed the title Spec: visualizationHints Spec: behaviorHints Sep 19, 2018
@Ivshti
Copy link
Member Author

Ivshti commented Nov 27, 2018

two more notes:

  • consider behaviorHints being an array of strings/objects; for data consistency/data-oriented approach; or, key/value pairs in Rust
  • it will be filled automatically/automagically for legacy add-ons, the worst/most blunt example being for the adult add-on: we will check whether the description contains porn

@Ivshti Ivshti changed the title Spec: behaviorHints Spec: {catalog/manifest}.behaviorHints Jan 16, 2019
@Ivshti
Copy link
Member Author

Ivshti commented Jan 16, 2019

ideas for manifest behaviorHints:

we also need this to be auto-suggested, see: #32

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants