diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..c2da638 --- /dev/null +++ b/FAQ.md @@ -0,0 +1,51 @@ +# FAQ + +## Is there a standard way / best practice for conveying dialogue? + +> "Best practice" is 👍 do whatever you want. 👍 +> +> The context is being sent to Neuro and she will interpret it herself, as long as it's consistent throughout the game it doesn't matter how you signify speaker and other info. + + + +## How do I give Neuro persistent context? + +Right now, Neuro is in charge of what she remembers. If it is very important, you can send reminders every so often. + + + +## How do I best send large amounts of data? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## Should I prefer multiple actions or a single action? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## What is the maximum length of a context message / action description / etc.? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## How should the `state` of `actions/force` be formatted? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## How much assistance should Neuro get? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## When should I use `actions/force`? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## When should I return a message with an `action/result`? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## What happens when an `actions/force` arrives while Neuro is busy? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/43) + +## What happens if an `actions/force` gets filtered? + +(Waiting on https://github.com/VedalAI/neuro-game-sdk/issues/49) diff --git a/README.md b/README.md index e1efc31..5f7a240 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ Significant API and SDK changes will be documented in the [CHANGELOG.md](./CHANG Last update: 7th of January 2025, 12:20 GMT +## FAQ + +FAQs are documented in the [FAQ.md](./FAQ.md) file. Before opening an issue, please check if your question has already been answered here. + ## Contents ### API Documentation