Skip to content

Commit 5eb80f4

Browse files
fezcodefezcode
committed
feat: new stories structure.
1 parent 7fe8469 commit 5eb80f4

8 files changed

Lines changed: 119 additions & 48 deletions

File tree

‎public/dnd/episodes.json‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎public/stories/README.md‎

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,65 @@
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+
├── books.json
12+
└── [book-directory-name]/
13+
├── episode1.txt
14+
└── episode2.txt
15+
└── ...
16+
```
17+
18+
* `books.json`: This JSON file serves as the main index for all D&D books and their respective episodes.
19+
* `[book-directory-name]/`: Each book's individual episode content files are stored in their own dedicated subdirectories. For example, `book-one/` would contain episodes for "Book One".
20+
* `episodeX.txt`: These are plain text files containing the actual narrative content for each episode.
21+
22+
## Book Structure (books.json)
23+
24+
The `books.json` file is an array of book objects. Each book object defines a collection of episodes and their metadata.
25+
26+
```json
27+
[
28+
{
29+
"bookId": 1,
30+
"bookTitle": "Book One: The Shadowed Path",
31+
"episodes": [
32+
{
33+
"id": 1,
34+
"filename": "book-one/episode1.txt",
35+
"title": "Episode 1: The Whispering Woods",
36+
"author": "fezcode"
37+
},
38+
{
39+
"id": 2,
40+
"filename": "book-one/episode2.txt",
41+
"title": "Episode 2: The Goblin Ambush",
42+
"author": "fezcode"
43+
}
44+
],
45+
"overlay": "red"
46+
},
47+
// ... more book objects
48+
]
49+
```
50+
51+
### Book Object Properties:
52+
53+
* `bookId` (Number): A unique identifier for the book.
54+
* `bookTitle` (String): The full title of the book.
55+
* `episodes` (Array): An array of episode objects belonging to this book.
56+
* `overlay` (String): A color string (e.g., "red", "blue", "black") used for visual styling in the application.
57+
58+
### Episode Object Properties:
59+
60+
* `id` (Number): A unique identifier for the episode within its book.
61+
* `filename` (String): The relative path to the plain text file containing the episode's content. This path is relative to the `public/stories/` directory (e.g., `book-one/episode1.txt`).
62+
* `title` (String): The title of the episode.
63+
* `author` (String): The author of the episode.
64+
65+
This structure allows the application to dynamically load and display D&D campaign content, organizing it into books and episodes with associated metadata.

public/dnd/book-one/episode1.txt renamed to public/stories/book-one/episode1.txt

File renamed without changes.

public/dnd/book-one/episode2.txt renamed to public/stories/book-one/episode2.txt

File renamed without changes.

‎public/stories/books.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"authors": [
3+
{
4+
"name": "fezcode",
5+
"website": "https://fezcode.com"
6+
}
7+
],
8+
"books": [
9+
{
10+
"bookId": 1,
11+
"bookTitle": "Book One: The Shadowed Path",
12+
"episodes": [
13+
{ "id": 1, "filename": "book-one/episode1.txt", "title": "Episode 1: The Whispering Woods", "author": "fezcode" },
14+
{ "id": 2, "filename": "book-one/episode2.txt", "title": "Episode 2: The Goblin Ambush", "author": "fezcode" }
15+
],
16+
"overlay": "red"
17+
},
18+
19+
{
20+
"bookId": 2,
21+
"bookTitle": "Book Two: Separated Riches",
22+
"episodes": [
23+
{ "id": 1, "filename": "book-one/episode1.txt", "title": "Episode 1: The Whispering Woods", "author": "fezcode" },
24+
{ "id": 2, "filename": "book-one/episode2.txt", "title": "Episode 2: The Goblin Ambush", "author": "fezcode" }
25+
],
26+
"overlay": "blue"
27+
},
28+
29+
{
30+
"bookId": 3,
31+
"bookTitle": "Book Three: Separated Riches",
32+
"episodes": [
33+
{ "id": 1, "filename": "book-one/episode1.txt", "title": "Episode 1: The Whispering Woods", "author": "fezcode" },
34+
{ "id": 2, "filename": "book-one/episode2.txt", "title": "Episode 2: The Goblin Ambush", "author": "fezcode" }
35+
],
36+
"overlay": "black"
37+
},
38+
39+
{
40+
"bookId": 4,
41+
"bookTitle": "Book Four: Separated Riches",
42+
"episodes": [
43+
{ "id": 1, "filename": "book-one/episode1.txt", "title": "Episode 1: The Whispering Woods", "author": "fezcode" },
44+
{ "id": 2, "filename": "book-one/episode2.txt", "title": "Episode 2: The Goblin Ambush", "author": "fezcode" }
45+
],
46+
"overlay": "green"
47+
}
48+
]
49+
}

‎src/pages/DndBookPage.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ function DndBookPage() {
4848
useEffect(() => {
4949
const fetchBookData = async () => {
5050
try {
51-
const response = await fetch(`${process.env.PUBLIC_URL}/dnd/episodes.json`);
51+
const response = await fetch(`${process.env.PUBLIC_URL}/stories/books.json`);
5252
if (!response.ok) {
5353
throw new Error(`HTTP error! status: ${response.status}`);
5454
}
5555
const data = await response.json();
56-
const foundBook = data.find(b => b.bookId === parseInt(bookId));
56+
const foundBook = data.books.find(b => b.bookId === parseInt(bookId));
5757
if (foundBook) {
5858
setBook(foundBook);
5959
setPageTitle(foundBook.bookTitle);

‎src/pages/DndEpisodePage.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,12 +58,12 @@ function DndEpisodePage() {
5858
useEffect(() => {
5959
const fetchAllBooks = async () => { // Renamed function
6060
try {
61-
const response = await fetch(`${process.env.PUBLIC_URL}/dnd/episodes.json`);
61+
const response = await fetch(`${process.env.PUBLIC_URL}/stories/books.json`);
6262
if (!response.ok) {
6363
throw new Error(`HTTP error! status: ${response.status}`);
6464
}
6565
const data = await response.json();
66-
setAllBooks(data);
66+
setAllBooks(data.books);
6767
} catch (error) {
6868
console.error("Failed to fetch all books:", error);
6969
}

‎src/pages/DndLorePage.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,12 @@ function DndLorePage() {
6060
useEffect(() => {
6161
const fetchEpisodes = async () => {
6262
try {
63-
const response = await fetch(`${process.env.PUBLIC_URL}/dnd/episodes.json`);
63+
const response = await fetch(`${process.env.PUBLIC_URL}/stories/books.json`);
6464
if (!response.ok) {
6565
throw new Error(`HTTP error! status: ${response.status}`);
6666
}
6767
const data = await response.json();
68-
setEpisodes(data);
68+
setEpisodes(data.books);
6969
} catch (error) {
7070
console.error("Failed to fetch episodes:", error);
7171
}

0 commit comments

Comments
 (0)