Skip to content

Commit c1d6f2f

Browse files
committed
Squashed 'public/stories/' changes from 2de504d..c193246
c193246 content(dnd): cat 9c34a97 content(dnd): the listener in the shadows 577ffdf content(dnd): the harvest of silence 1ee5f44 content(dnd): touch of rose 34fe43a content(dnd): the sewer 3c52188 content(dnd): the skulls 93722ba content(dnd): clinical note 395d30d content(dnd): story of Klaude Barral 73b87aa content(dnd): 22 stars e167e2b content(dnd): more stories 01548d0 refactor: dnd pages pt3 cdadd81 content(stories): first book 290a830 stories: authors.piml refactoring 11f944a feat: author cards. 5a79fdf feat: author cards. 924e804 feat: about card in stories 0a50475 docs: stories readme and example. a729392 style: dnd 5aecd7d feat: piml for stories a8c5c6b feat: new stories structure. git-subtree-dir: public/stories git-subtree-split: c193246d4b5bba42fc09c355c5e89488202183f7
1 parent 359fb33 commit c1d6f2f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+1969
-1
lines changed

MarkdownExample.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# A Markdown Test
2+
3+
Dragons have been a staple of fantasy literature and mythology for centuries. From their majestic wings to their fearsome breath, dragons come in various forms across different cultures and stories.
4+
5+
---
6+
7+
## **Interesting Facts About Dragons**
8+
9+
1. **Origins**: In mythology, dragons are often linked to the creation of natural landscapes (e.g., mountains, rivers).
10+
2. **Dragon Lore**: In *Dungeons & Dragons*, dragons have different alignments based on their color, such as lawful good for metallic dragons and chaotic evil for chromatic dragons.
11+
3. **Shape-Shifting**: Some cultures, like in *The NeverEnding Story*, feature dragons that can change their form or size.
12+
4. **Guardians of Treasure**: In many stories, dragons hoard treasures, often seen as symbols of greed or protection.
13+
14+
---
15+
16+
## **Dragon Myths Across Cultures**
17+
18+
- **Greek Mythology**: Dragons were often depicted as guardians of ancient knowledge or treasures, such as the Lernaean Hydra.
19+
- **Chinese Mythology**: The Lung dragons symbolize strength, wisdom, and good fortune, often associated with water and rain.
20+
- **Viking Mythology**: Dragons like Fafnir were seen as tragic figures, representing greed and destruction.
21+
- **Arthurian Legends**: Dragons, such as the one slain by St. George, symbolize the battle between good and evil.
22+
23+
---
24+
25+
### **Fun Fact:**
26+
27+
> "Did you know that in some stories, dragons are depicted as protectors rather than villains, especially in Eastern traditions like those of Japan and China?"
28+
29+
---
30+
31+
## **Dragon-Related Media**
32+
33+
1. **Books**:
34+
- *The Hobbit* by J.R.R. Tolkien
35+
- *A Song of Ice and Fire* by George R.R. Martin
36+
2. **Movies**:
37+
- *How to Train Your Dragon* (2010)
38+
- *Reign of Fire* (2002)
39+
3. **Games**:
40+
- *The Elder Scrolls V: Skyrim*
41+
- *Dungeons & Dragons* (Tabletop RPG)
42+
43+
---
44+
45+
### **Conclusion**
46+
47+
Dragons are more than just mythical creatures; they represent complex themes such as power, wisdom, and the balance between good and evil. Whether they are guarding treasure, controlling the elements, or shaping the fate of kingdoms, dragons will always hold a special place in fantasy lore.
48+
49+
---
50+
51+
#### *Which dragon type would you choose to tame?*

README.md

Lines changed: 158 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,159 @@
11
# fezcodex.stories
2-
Stories shown in Fezcodex.
2+
3+
This directory contains the **stories** content for Fezcodex, structured to be easily consumed by the application.
4+
5+
## Directory Structure
6+
7+
The content is organized as follows:
8+
9+
```
10+
public/stories/
11+
├── authors.piml
12+
├── books.piml
13+
├── characters.piml
14+
├── places.piml
15+
├── MarkdownExample.md
16+
├── _items_/
17+
│ ├── items.piml
18+
│ ├── [item-image].png
19+
│ └── ...
20+
└── [book-directory-name]/
21+
├── episode1.txt
22+
└── episode2.txt
23+
└── ...
24+
```
25+
26+
* `authors.piml`: This PIML file contains the definitions for all authors.
27+
* `books.piml`: This PIML file serves as the main index for all story books and their respective episodes.
28+
* `characters.piml`: This PIML file contains the definitions for all characters (Dramatis Personae).
29+
* `places.piml`: This PIML file contains the definitions for all places and locations (The Atlas).
30+
* `_items_/`: Contains item definitions and their respective images.
31+
* `items.piml`: Definitions for artifacts and tools (The Armory).
32+
* `[book-directory-name]/`: Each book's individual episode content files are stored in their own dedicated subdirectories.
33+
* `episodeX.txt`: These are plain text files containing the actual narrative content for each episode.
34+
35+
## Episode File Contents
36+
37+
Every file should end with `.txt` format however you can write `markdown` in it (**highly recommended**).
38+
39+
**Important**: Tables are not supported.
40+
41+
[A Markdown Example](./MarkdownExample.md) is added for to show you which elements are supported.
42+
43+
When you don't have to show underline in a `h2` (`##`), use `h3` (`###`) header instead. Do not go under h3. (i.e. do not use h4 and below)
44+
45+
## Book Structure (books.piml)
46+
47+
The `books.piml` file is a PIML document that, when parsed, results in an object containing a `books` array.
48+
49+
```piml
50+
(books)
51+
> (book)
52+
(bookId) 1
53+
(bookTitle) Book One: The Shadowed Path
54+
(episodes)
55+
> (episode)
56+
(id) 1
57+
(filename) book-one/episode1.txt
58+
(title) Episode 1: The Whispering Woods
59+
(author) fezcode
60+
(date) 2025-11-14
61+
(updated) 2025-11-14
62+
(overlay) red
63+
```
64+
65+
### Book Object Properties:
66+
67+
* `bookId` (Number): A unique identifier for the book.
68+
* `bookTitle` (String): The full title of the book.
69+
* `episodes` (Array): An array of episode objects belonging to this book.
70+
* `overlay` (String): A color string (e.g., "red", "blue", "black") used for visual styling in the application.
71+
72+
### Episode Object Properties:
73+
74+
* `id` (Number): A unique identifier for the episode within its book.
75+
* `filename` (String): The relative path to the plain text file. Relative to the `public/stories/` directory.
76+
* `title` (String): The title of the episode.
77+
* `author` (String): The alias of the author, matching an `alias` in `authors.piml`.
78+
* `date` (String): Original release date.
79+
* `updated` (String): Last update date.
80+
81+
## Author Structure (authors.piml)
82+
83+
```piml
84+
(authors)
85+
> (author)
86+
(name) Samil
87+
(alias) fezcode
88+
(website) https://fezcode.com
89+
(image) https://avatars.githubusercontent.com/u/49845895?v=4
90+
```
91+
92+
### Author Object Properties:
93+
94+
* `name` (String): The name of the author.
95+
* `alias` (String): A unique alias for the author.
96+
* `website` (String, Optional): The website URL.
97+
* `image` (String): A URL to the author's profile picture.
98+
99+
## Character Structure (characters.piml)
100+
101+
```piml
102+
(characters)
103+
> (character)
104+
(name) Corrigan
105+
(role) Private Investigator
106+
(book) The Broken Path
107+
(description) A cynical detective...
108+
(status) Alive (Haunted)
109+
```
110+
111+
### Character Object Properties:
112+
113+
* `name` (String): The name of the character.
114+
* `role` (String): The occupation or role.
115+
* `book` (String): Primary book appearance.
116+
* `description` (String): Brief biography.
117+
* `status` (String): Current status (e.g., Alive, Deceased).
118+
119+
## Place Structure (places.piml)
120+
121+
```piml
122+
(places)
123+
> (place)
124+
(name) Blade's Clinic
125+
(type) Medical Facility
126+
(book) The Tales of Doctor Blade
127+
(description) A sanctuary of white marble...
128+
(status) Active
129+
```
130+
131+
### Place Object Properties:
132+
133+
* `name` (String): The name of the location.
134+
* `type` (String): The type of place (e.g., Tavern, City).
135+
* `book` (String): The book where it is featured.
136+
* `description` (String): Description of the atmosphere.
137+
* `status` (String): Current status (e.g., Active, Destroyed).
138+
139+
## Item Structure (_items_/items.piml)
140+
141+
```piml
142+
(items)
143+
> (item)
144+
(name) Alilberry Extract
145+
(type) Potion / Poison
146+
(book) The Tales of Doctor Blade
147+
(description) A pearlescent grey mist...
148+
(owner) Doctor Blade
149+
(image) /stories/_items_/alilberry_extract.png
150+
```
151+
152+
### Item Object Properties:
153+
154+
* `name` (String): The name of the artifact or item.
155+
* `type` (String): The classification (e.g., Weapon, Tool, Potion).
156+
* `book` (String): The book where it first appears.
157+
* `description` (String): Detailed description of the item.
158+
* `owner` (String): The character or entity that owns the item.
159+
* `image` (String, Optional): Relative path to the item's image file.

_items_/alilberry_extract.png

1.37 MB
Loading
1.31 MB
Loading

_items_/items.piml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
(items)
2+
> (item)
3+
(name) Alilberry Extract
4+
(type) Potion / Poison
5+
(book) The Tales of Doctor Blade
6+
(description) A pearlescent grey mist derived from a rare herb, processed through dwarven glass and sung over by a mute bard. One drop cures; two drops kill.
7+
(owner) Doctor Blade
8+
(image) /stories/_items_/alilberry_extract.png
9+
10+
> (item)
11+
(name) Soul of Viyu
12+
(type) Artifact
13+
(book) The Broken Path
14+
(description) A fragment of an ancient soul, pulsating with a faint, rhythmic light. It whispers to those who hold it, promising power at a terrible cost.
15+
(owner) Unknown
16+
(image) /stories/_items_/soul_of_viyu.png
17+
18+
> (item)
19+
(name) Dark Green Beret
20+
(type) Military Apparel
21+
(book) The Sins of Glareach
22+
(description) A wool beret with twenty-two silver stars stitched into the side by Lenia. It is the only thing Lorhud Krauper has left from his daughter, and he never takes it off.
23+
(owner) Lorhud Krauper
24+
(image) /stories/_items_/beret_of_lorhud_krauper.png
25+
26+
> (item)
27+
(name) Chronometer of Ash
28+
(type) Tool / Artifact
29+
(book) The Chronomancer's Dust
30+
(description) A brass sphere powered by the ash of Glareach. It allows the user to relive exactly one hour of their past. The glass is unbreakable, ensuring the user can only observe, never intervene.
31+
(owner) Klaude Barral
32+
(image) /stories/_items_/the_chronometer.png
33+
34+
> (item)
35+
(name) Valeth's Notebook
36+
(type) Journal
37+
(book) The Diplomat's Journal
38+
(description) A navy blue notebook with a single silver star on the cover. It contains the observations of a diplomat who sees too much, documenting the rot at the heart of Thornus. Recently stolen by Nex Orlong outside the Kosnak Estate.
39+
(owner) Nex Orlong (Current Holder) / Valeth Vanceshire (Original Owner)
40+
(image) /stories/_items_/valeth_notebook.png
41+
42+
> (item)
43+
(name) Touch of Rose
44+
(type) Disease / Mark
45+
(book) The Petals of Predymesh
46+
(description) A devastating affliction that manifests as a crimson rose-leaf mark on the forehead. It slowly drains the victim's motor functions and speech, eventually leaving them in a vegetative state. Its only known cure is a rare drop of Alilberry.
47+
(owner) Pellera Orlong (Afflicted)
48+
(image) /stories/_items_/touch_of_rose.png
49+
50+
> (item)
51+
(name) Government Medal for Science
52+
(type) Award
53+
(book) The Harvest of Silence
54+
(description) A heavy gold disc awarded for exceptional scientific achievement. To Avalia Krones, it is a symbol of her gilded cage and the government's attempt to buy her loyalty.
55+
(owner) Avalia Krones
56+
57+
> (item)
58+
(name) The Krones Formula
59+
(type) Scientific Data / Discovery
60+
(book) The Harvest of Silence
61+
(description) A revolutionary method for accelerating agricultural growth. While publicly used to end hunger, the government seeks its hidden 'weaponized' potential, which Avalia carefully conceals.
62+
(owner) Avalia Krones (Knowledge)
63+
64+
> (item)
65+
(name) Leatherwave's Dried Fish
66+
(type) Food / Treat
67+
(book) The Cat of Craninal
68+
(description) Simple, salty snacks used to bribe the Council of Three. They represent the simple joys of a quiet life.
69+
(owner) Prostex Leatherwave

_items_/soul_of_viyu.png

1.39 MB
Loading

_items_/the_chronometer.png

1.23 MB
Loading

_items_/touch_of_rose.png

1.2 MB
Loading

_items_/valeth_notebook.png

1.29 MB
Loading

authors.piml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
(authors)
2+
> (author)
3+
(name) Samil
4+
(alias) fezcode
5+
(website) https://fezcode.com
6+
(image) https://avatars.githubusercontent.com/u/49845895?v=4
7+
> (author)
8+
(name) Sabri
9+
(alias) TheLastRoadRunner
10+
(website) https://github.com/TheLastRoadRunner
11+
(image) https://avatars.githubusercontent.com/u/99679216?v=4
12+
> (author)
13+
(name) Constellation
14+
(alias) Constellation
15+
(website) https://fezcode.com
16+
(image) /images/avatar/greg-rakozy-oMpAz-DN-9I-unsplash.jpg

0 commit comments

Comments
 (0)