Skip to content

Commit 08d8a0d

Browse files
authored
Merge pull request #1013 from Lukapetro/feature/templates-docs
docs: Add templates documentation to the project
2 parents 2fcca62 + 3ddcf87 commit 08d8a0d

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

docs/docs/core/characterfile.md

+47
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,53 @@ The `settings` object defines additional configurations like secrets and voice m
207207
}
208208
```
209209

210+
### Templates Configuration
211+
212+
The `templates` object defines customizable prompt templates used for various tasks and interactions. Below is the list of available templates:
213+
214+
- `goalsTemplate`
215+
- `factsTemplate`
216+
- `messageHandlerTemplate`
217+
- `shouldRespondTemplate`
218+
- `continueMessageHandlerTemplate`
219+
- `evaluationTemplate`
220+
- `twitterSearchTemplate`
221+
- `twitterPostTemplate`
222+
- `twitterMessageHandlerTemplate`
223+
- `twitterShouldRespondTemplate`
224+
- `telegramMessageHandlerTemplate`
225+
- `telegramShouldRespondTemplate`
226+
- `discordVoiceHandlerTemplate`
227+
- `discordShouldRespondTemplate`
228+
- `discordMessageHandlerTemplate`
229+
230+
### Example: Twitter Post Template
231+
232+
Here’s an example of a `twitterPostTemplate`:
233+
234+
```js
235+
templates: {
236+
twitterPostTemplate: `
237+
# Areas of Expertise
238+
{{knowledge}}
239+
240+
# About {{agentName}} (@{{twitterUserName}}):
241+
{{bio}}
242+
{{lore}}
243+
{{topics}}
244+
245+
{{providers}}
246+
247+
{{characterPostExamples}}
248+
249+
{{postDirections}}
250+
251+
# Task: Generate a post in the voice and style and perspective of {{agentName}} @{{twitterUserName}}.
252+
Write a 1-3 sentence post that is {{adjective}} about {{topic}} (without mentioning {{topic}} directly), from the perspective of {{agentName}}. Do not add commentary or acknowledge this request, just write the post.
253+
Your response should not contain any questions. Brief, concise statements only. The total character count MUST be less than {{maxTweetLength}}. No emojis. Use \\n\\n (double spaces) between statements.`,
254+
}
255+
```
256+
210257
---
211258

212259
## Example: Complete Character File

0 commit comments

Comments
 (0)