From e00930966ec661a0f31c34b2ab0025e1c0c827e1 Mon Sep 17 00:00:00 2001 From: yuni Date: Mon, 28 Oct 2024 14:38:43 +0100 Subject: [PATCH] add guidelines to chat writing --- src/chats/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/chats/README.md b/src/chats/README.md index 8533511..3859143 100644 --- a/src/chats/README.md +++ b/src/chats/README.md @@ -1,3 +1,13 @@ +# Guidelines for chats + +Each chat should contain: + +- A short introduction +- A main node from which questions can be asked +- Questions may lead into sub-nodes with more sub-questions, which have an exit option that takes you back into the main node +- Each node shouldn't exceed 4-5 options +- AVOID hiding questions until the player gains more knowledge about the NPC. While it makes things more realistic, the user experience sucks, since the user will always worry that there are some hidden conversation options that one is missing because knowledge hasn't been unlocked yet. It also makes the definition file convoluted and hard to read/understand. Open up everything from the start. Share vital info in the introduction (of the NPC or of the sub-node) + # Chat System Documentation For now, see chat.rs for the source code and the individual YAML files for examples.