Commit eae26af4 authored by David Revoy's avatar David Revoy

Merge branch '44-structured-metadata-file-for-each-episode' into 'master'

RFC: Structured metadata file for each episode

Closes #44

See merge request !43
parents 9b5dd993 a7f9ba65
# info.yaml specification
This information is meant for people wishing to develop an API about the Pepper&Carrot episodes.
There are efforts to build a full API on top of this:
* https://www.peppercarrot.com/0_sources/episodes.json
* https://framagit.org/valvin/peppercarrot-api/
* https://framagit.org/Midgard/peppercarrot_api
---
Each episode directory has a `info.yaml` file that contains raw metadata about the episode. It may
contain the following keys. Unless otherwise stated below, any and all of those may be blank or
omitted, which means the information is not available.
## Character set
The files are encoded in UTF-8.
## Languages
All languages are expressed in *Pepper&Carrot pseudo-ISO-639 two letter language codes*. They are
defined in [langs.json](langs.json).
## Keys
### `id`
`string` This key will always be present and contain a unique, meaningful value that will never
change for published episodes. (It might change for unpublished episodes.) It is URL safe but might
not be particularly human readable. Human readable denotations of the episode should be extracted
from the episode SVGs.
### `serial`
`int≥0` This key will always be present and contain a unique value: the serial number in the
series. Values are consecutive across episodes (i.e. there are no gaps in the numbering), and
sorting on this field yields the intended order of the episodes. There is no explicit relationship
with `id`.
### `published`
`date` Publication date. If this key is omitted or blank, the episode is not yet published.
### `url`
`string` URL to the page on the official website where the episode is published. If `published` is
present, this key MUST be present and contain a valid URL.
### `original language`
`string` The language that the first version of the comic was originally written in.
### `financial supporters`
`{ string: int≥0|string }` Map of payment method to the amount of backers who supported this
episode with it. Some people might donate using several methods, but we don't track those. The
total amount of backers `n` is `min(ints) ≤ n ≤ sum(ints)`, but you may assume `n ≈ sum(ints)`.
The value in the map is an int ≥0 (exact number), a string of the form `~int` (approximate number)
or a string of the form `int1-int2` (approximately between given low and high; int1 is always less
than int2).
There's a special case: if present, the field "total" contains the total number of backers. It is
as least as precise as the other fields combined, and may be more precise.
The payment methods that are currently supported are:
Patreon
Liberapay
PayPal
Tipeee
Ğ1
bank transfer
mail
But these may change at any time.
### `credits`
`{ string: {string: [string]|string} }` Map from scope (the language or special value `all`) to map from names to roles (free text). If the contributor is credited for multiple roles, the value is a list of them, otherwise it's just a string.
### `software`
`[ {string: string} ]` List of software used in episode production. The list entries are maps that
contain at least the key `name`, and may contain a `version`.
### `notes`
`[ {string: string} ]` List of official notes by episode contributors. The list entries are maps
that contain at least the key `author` (name of the note's author) and at least one language. The
language is the key, and the corresponding value is the body of the note in that language.
## Example
```yaml
---
published: 2030-04-13
url: https://www.peppercarrot.com/episodes/100/pepper-s-birthday-party-2
original language: jb
financial supporters:
Patreon: 80135
Liberapay: 203498
bank transfer: 503
credits:
all:
David Revoy: [art & scenario, universe creator]
Hazel Sherman: art & scenario
Chasidy Naftali: [beta feedback, script doctor]
en:
Tessie Darkis: translator
Alesha Sa: proofreader
fr:
Maxime Denis: [initial translator, corrector]
Christian Bonnevie: reinterpreter
Alphonse Reynaud: corrector
Nadége Duval: proofreader
nl:
Tijs Van Belleghem: translator
Guus Krijgsman: translator
software:
- name: Krita
version: "7.0.2"
- name: Inkscape
version: "1.2.2"
- name: Kubuntu
version: "29.10"
notes:
- by: David Revoy
en: >
Hi, today my big, big dream to reach 100 episodes comes true! A great thank you to everyone
who made this possible by supporting my work over these past 16 years.
fr: >
Salut, aujourd'hui mon grand, grand rêve de parvenir à l'épisode 100 est réalisé! Un gros
merci à tous qui en ont aidé par financer mon travail pendant cettes 16 années.
nl: >
Hoi, vandaag komt mijn grote, grote droom uit van 100 afleveringen te maken! Een enorme
dankjewel aan iedereen die dit mogelijk heeft gemaakt door mijn werk deze afgelopen 16 jaren
te steunen.
```
......@@ -29,3 +29,7 @@ For documentation and their license, read [`fonts/README.md`](fonts/README.md).
Content in this repository is licensed under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) License, except for the files in the `fonts/` directory, which are released under their own separate license agreements.
By submitting content to this repository, one agrees to the contributor's terms at the bottom of [CONTRIBUTING.md](CONTRIBUTING.md).
## Episode metadata
Each episode contains a metadata file called `info.yaml`. The format is documented in [INFO-YAML.md](INFO-YAML.md).
---
id: "1"
serial: 0
published: 2014-05-10
url: https://www.peppercarrot.com/article234/potion-of-flight
original language: en
financial supporters: []
---
id: "2"
serial: 1
published: 2014-07-25
url: https://www.peppercarrot.com/article237/episode-2-rainbow-potions
original language: en
financial supporters:
Patreon: 21
software:
- name: Krita
- name: GNU/Linux
---
id: "3"
serial: 2
published: 2014-10-03
url: https://www.peppercarrot.com/article241/episode-3-the-secret-ingredients
original language: en
financial supporters:
Patreon: 93
software:
- name: Krita
- name: G'MIC
- name: Xubuntu
- name: GNU/Linux
---
id: "4"
serial: 3
published: 2014-11-21
url: https://www.peppercarrot.com/article243/episode-4-moment-of-genius
original language: en
financial supporters:
Patreon: 156
software:
- name: Krita
- name: G'MIC
- name: Blender
- name: GIMP
- name: Ubuntu GNOME
- name: GNU/Linux
---
id: "5"
serial: 4
published: 2014-12-19
url: https://www.peppercarrot.com/article244/special-holiday-episode
original language: en
financial supporters:
Patreon: 170
software:
- name: Krita
- name: G'MIC
- name: Blender
- name: Ubuntu GNOME
- name: GNU/Linux
---
id: "6"
serial: 5
published: 2015-03-28
url: https://www.peppercarrot.com/article271/episode-6-the-potion-contest
original language: fr
financial supporters:
Patreon: 245
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
- name: Linux Mint
---
id: "7"
serial: 6
published: 2015-04-30
url: https://www.peppercarrot.com/article273/episode-7-the-wish
original language: fr
financial supporters:
Patreon: 273
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
- name: Linux Mint
---
id: "8"
serial: 7
published: 2015-06-28
url: https://www.peppercarrot.com/article285/episode-8-pepper-s-birthday-party
original language: fr
financial supporters:
Patreon: 354
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
- name: Inkscape
- name: Linux Mint
- name: GNU/Linux
---
id: "9"
serial: 8
published: 2015-07-31
url: https://www.peppercarrot.com/en/article289/episode-9-the-remedy
original language: fr
financial supporters:
Patreon: 406
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.6"
- name: Inkscape
version: "0.91"
- name: Linux Mint
version: "17"
---
id: "10"
serial: 9
published: 2015-08-29
url: https://www.peppercarrot.com/en/article298/episode-10-summer-special
original language: fr
financial supporters:
Patreon: 422
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.6"
- name: Inkscape
version: "0.91"
- name: Linux Mint
version: "17"
---
id: "11"
serial: 10
published: 2015-09-30
url: https://www.peppercarrot.com/en/article301/the-witches-of-chaosah
original language: fr
financial supporters:
Patreon: 502
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.7"
- name: G'MIC
version: "1.6.5.2"
- name: Inkscape
version: "0.91"
- name: Linux Mint
version: "17"
---
id: "12"
serial: 11
published: 2015-10-31
url: https://www.peppercarrot.com/en/article331/episode-12-autumn-clearout
original language: fr
financial supporters:
Patreon: 575
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.8"
- name: Inkscape
version: "0.91"
- name: Blender
version: "2.71"
- name: GIMP
version: "2.8.14"
- name: G'MIC
version: "1.6.7"
- name: Linux Mint
version: "17.2"
---
id: "13"
serial: 12
published: 2015-12-08
url: https://www.peppercarrot.com/en/article338/episode-13-the-pyjama-party
original language: fr
financial supporters:
Patreon: 602
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.9"
- name: Inkscape
version: "0.91"
- name: Linux Mint
version: "17"
---
id: "14"
serial: 13
published: 2016-01-29
url: https://www.peppercarrot.com/en/article350/episode-14-the-dragon-s-tooth
original language: fr
financial supporters:
Patreon: 671
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.10"
- name: Inkscape
version: "0.91"
- name: Linux Mint
version: "17"
---
id: "15"
serial: 14
published: 2016-03-25
url: https://www.peppercarrot.com/en/article364/episode-15-the-crystal-ball
original language: fr
financial supporters:
Patreon: 686
credits:
all:
David Revoy: art & scenario
software:
- name: Krita
version: "2.9.11"
- name: Inkscape
version: "0.91"
- name: Linux Mint
version: "17"
notes:
- author: David Revoy
en: >
About the story, it's the fourth story of the "witches of Chaosah". Ep12 was about Cayenne,
ep13 was about Cumin and now ep15 is a bit about Thyme. This episode introduces a new
'technology' in the little world of Pepper&Carrot and the real themes are: video, erotism and
parental control, video-games, bugs, blue-screen-of-death, coding/fixing, network and the
World Wide Web. It was a little challenge to insert these elements in the fantasy world of
Hereva.
About what I experimented: I'm back to storytelling with wide panel only, it's easier to
read, but it add more pages to draw (it's an 8 pages long story, I usually draw around 6). I
also experimented with framing and cropping to be more cinematic and I try to treat light and
color as actors. It's also a rare time where I use the 'parody' humor form in a episode,
making many references to internet, computers and our world.
I hope you'll like this one! Feel free to let me know your reaction, I'll be around.
---
id: "16"
serial: 15
published: 2016-04-30
url: https://www.peppercarrot.com/en/article369/episode-16-the-sage-of-the-mountain
original language: fr
financial supporters:
Patreon: 671
credits:
all:
David Revoy: [art & scenario, universe creator]
Craig Maloney: universe contributor
Alex Gryson: universe corrector
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
- name: Blender
- name: G'MIC
- name: Inkscape
- name: Ubuntu
notes:
- author: David Revoy
en: >
After a *very* intensive production time, I'm happy to release episode 16, "The Sage of the
Mountain". In this new episode, I tried to produce a visual direction more looking like an
animation; with painted landscapes and almost thin line cell-shaded characters. A challenge!
The episode features Saffron, Thyme, Cayenne and of course Pepper and Carrot. Also, 16
translations are available at release, thanks to the very active and lovely translation team.
---
id: "17"
serial: 16
published: 2016-06-30
url: https://www.peppercarrot.com/en/article377/episode-17-a-fresh-start
original language: fr
financial supporters:
Patreon: 719
credits:
all:
David Revoy: [art & scenario, universe creator]
Craig Maloney: universe contributor
Alex Gryson: universe corrector
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
- name: G'MIC
- name: Inkscape
- name: Ubuntu
notes:
- author: David Revoy
en: >
Hi! It's a longer episode than usual with 7 pages. The episode already has 16 translations
(at release time) thanks to the super translation team. The production of all panels with
this level of rendering was a real challenge. Wind, beams of light, a lot of different color
palettes... not easy to paint. I spent a lot of nights and days on polishing this one. ;-)
I'm even a little sad to leave this ep17 now: I had good times painting the various scenes,
expressions, places and characters of this story. I hope you'll like it!
---
id: "18"
serial: 17
published: 2016-08-05
url: https://www.peppercarrot.com/en/article379/episode-18-the-encounter
original language: fr
financial supporters:
Patreon: 720
credits:
all:
David Revoy: [art & scenario, universe creator]
Craig Maloney: [scenario inspirer, universe contributor]
Alex Gryson: universe corrector
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
version: "3.0"
- name: Inkscape
version: "0.91"
- name: Manjaro XFCE
notes:
- author: David Revoy
en: >
Hi! This is a special episode built around a flashback scene of an important time in the past
of Pepper and Carrot. I really wanted to draw this episode, it was an opportunity to
introduce many background elements around Pepper; how she started at the Hippiah school, how
she met Carrot, how she was found by the witches of Chaosah and a hint about her hidden
enormous potential as a witch... So, we go back in time with this flashback, not very far
before episode 1; that's why you probably are already familiar with the color of the Hippiah
dress.
From a technical point of view, this episode has a large amount of panels, almost two times
the amount of a usual episode. All these additional panels were necessary to smooth the
storytelling and get a more cinematic feeling (and not a comic-strip one). That's why I'm
posting this episode not at the end of July as planed at first, but at the end of the first
week of August. A proof I always put priority on quality. :)
Before jumping on the production of the next episode (in September), I will focus a bit on
adding new tutorial and maintaining the YouTube channel. But first, I have a little week of
holidays in August. :)
I hope you liked this episode! Thanks again for all your comments, reshares, contributions
and support!
---
id: "19"
serial: 18
published: 2016-10-26
url: https://www.peppercarrot.com/en/article383/episode-19-pollution
original language: fr
financial supporters:
Patreon: 755
credits:
all:
David Revoy: [art & scenario, universe creator]
Juan José Segura: scenario inspirer
Craig Maloney: [script doctor, universe contributor]
Alex Gryson: [proofreader and dialog assister, universe corrector]
Seblediacre: proofreader and dialog assister
Valvin: proofreader and dialog assister
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
version: "3.0.1"
- name: Inkscape
version: "0.91"
- name: Arch Linux
- name: XFCE
notes:
- author: David Revoy
en: >
Episode 19 is an episode about pollution, and also about the fighting of Pepper against the tradition. It's an answer to episode 12 'Autumn Clearout' (with the black hole of potions) and also an answer to the bad behavior of the witches of Chaosah "to bury everything".
I wanted to take an unusual point of view on this topic: about the embarassing 'history log' the pollution can leave in the layer of sediment soil. Also, in this episode, it's the first time Pepper really 'wins' against the three witches of Chaosah. But she doesn't win the way she tried to (by embarassing the witches) but because of the new situation.
This episode production was longer than usual because many topics:
- Happy ones like my wedding with Alicja and the honeymoon trip ♥
- 'Meh' ones, like the polemic in France about the printed version of Pepper&Carrot...
- A 'bonus' one, because the production in august of a very long free video tutorial on Youtube.
- A technical one: because I wanted to open the storyboard to collaborative work on our IRC channel, and that was a good move.
That was maybe too much for me ^_^ , and it made me dive in an 'over-busy' mode. Sorry for all unreplied emails, comments, etc... I'll work on it.
About the technique: This episode was painted fully digitally with Krita. For inking, I used the preset 'Pencil 2B' (from my "8.1" brushkit) at size 7px, the style was made to match the episode 12; colorful with a focus on the precision of drawing and inking, and not so much on painting this time. It was longer, out of my comfort zone but I learned a lot.
Many thanks to all who contributed to this episode, and all the patrons for funding Pepper&Carrot!
---
id: "20"
serial: 19
published: 2016-12-17
url: https://www.peppercarrot.com/en/article393/episode-20-the-picnic
original language: fr
financial supporters:
Patreon: 825
credits:
all:
David Revoy: [art & scenario, universe creator]
Craig Maloney: universe contributor
Alex Gryson: universe corrector
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
version: "3.1"
- name: Inkscape
version: "0.91"
- name: Manjaro XFCE
---
id: "21"
serial: 20
published: 2017-02-23
url: https://www.peppercarrot.com/en/article400/episode-21-the-magic-contest
original language: fr
financial supporters:
Patreon: 816
credits:
all:
David Revoy: [art & scenario, universe creator]
Craig Maloney: [brainstormer, dialogue improver, universe contributor]
Nicolas Artance: [brainstormer, dialogue improver]
Valvin: [brainstormer, dialogue improver]
Quiralta: brainstormer
Talime: brainstormer
Jookia: dialogue improver
Inkscape team: special thanks
Mc: special thanks
Alex Gryson: universe corrector
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
version: "3.2.1"
- name: Inkscape
version: "0.91"
- name: Linux Mint XFCE
version: "18.1"
---
id: "22"
serial: 21
published: 2017-05-30
url: https://www.peppercarrot.com/en/article412/episode-22-the-voting-system
original language: fr
financial supporters:
Patreon: 864
credits:
all:
David Revoy: [art & scenario, universe creator]
Craig Maloney: [dialogue improver, universe contributor]
Nicolas Artance: dialogue improver
Valvin: dialogue improver
Alex Gryson: universe corrector
CGand: universe corrector
Hali: universe corrector
Moini: universe corrector
Willem Sonke: universe corrector
software:
- name: Krita
version: "3.1.3"
- name: Inkscape
version: "0.92.1"
- name: Linux Mint
version: "18.1"
notes:
- author: David Revoy
en: >
Hi! A quick note: this episode is an obvious metaphor of the voting system proposed by any