Skip to content

Add an FAQ page #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Pasu4 wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add an FAQ page #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5510740
Create FAQ file
Pasu4 Feb 18, 2025
8962e80
Add content to FAQ
Pasu4 Feb 18, 2025
01ae911
Add FAQ link to README.md
Pasu4 Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# FAQ <!-- Not sure if that is the right title, I think they were only ever asked once and not frequently -->

## 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.

<!-- Source: https://github.com/VedalAI/neuro-game-sdk/issues/7#issuecomment-2533745279 -->

## 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.

<!-- Source: https://github.com/VedalAI/neuro-game-sdk/issues/7#issuecomment-2536405147 -->

## 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)
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down