summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWildX <wildx@evolonline.org>2020-10-11 14:51:19 +0000
committerWildX <wildx@evolonline.org>2020-10-11 14:51:19 +0000
commit7bee0a3c5044361c5b7ce999f5ace1318c4feab8 (patch)
tree5fa947cbd7d4dd15cdcda95123a74a32a4855478
parentf027674c8586399ff2a8d2c2e8a151ef107e9234 (diff)
downloadnarrative-master.tar.gz
narrative-master.tar.bz2
narrative-master.tar.xz
narrative-master.zip
Update README.mdHEADmaster
-rw-r--r--README.md32
1 files changed, 27 insertions, 5 deletions
diff --git a/README.md b/README.md
index 531b0c6..5292adf 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,31 @@
-The Lore folder will usually contain plain text files describing any particular aspect of the game's lore.
-These are all canon and can be used for reference when developing other content.
+This repository consists of three main directories: Dialogues, Lore and Storylines. Other files relating to the game's narrative will be in the main repository, including narrative design, level progression and other such design elements.
+**Dialogues**: This directory will usually contain HTML files to be imported to Twine 2 at https://twinery.org/2/ in order to view and play the NPC dialogues in a text-based format.
-The Dialogues folder will usually contain HTML files to be imported to Twine 2 at https://twinery.org/2/ in order to view and play the storyboard.
+**Lore**: This directory will usually contain plain text files describing any particular aspect of the game's lore. Once published here by a developer these are all canon elements of the world of Gasaron and can be used for reference when developing other content.
-The Storylines folder will contain a narrated summary of the main storyline and other stories that various quests may follow.
+**Storylines**: This directory will contain plain text files consisting of a narrated summary of the main storyline and other stories that various quests may follow.
-Other files relating to the game's narrative will be in the main repository, including level progression and other such design elements.
+How to create storylines and storyline chapters:
+
+The "main campaign" (the central plot followed by the game) is organised within its own folder under Storylines and divided by chapters. Each individual text file is one chapter of the story. Side-stories longer than one chapter should be similarily organised whithin a dedicated folder. Stories consisting of a single chapter should be submitted directly under Storylines.
+
+To create a chapter specify the author, zone in which the story takes place and name/title of the story (for the main campaign it's simply "main campaign").
+
+Example:
+```
+Author: Uruk-hai
+
+Zone: Rohan
+
+Story: Taking The Hobbits To Isengard, chapter 1
+```
+
+When the specific location of NPCs is relevant to the story, this can be specified using map coordinates (xx, yy; map hook). Quests tied to the story should be included using the following format:
+```
+QUEST: Name
+
+Description, including goals, required items and any other relevant information.
+
+Reward: should usually include experience and money along with any other desired reward.
+```