13 |
14 | ## Features
15 | - Generates multiple response options for user selection
16 | - Customizable number of response options
17 | - Impersonation of selected responses
18 | - Slash command integration for quick access
19 | - Customizable prompts for option generation and impersonation
20 |
21 | ## Installation
22 | Use SillyTavern's built-in extension installer with this URL:
23 |
24 | ## Usage
25 | 1. Open the extension settings in SillyTavern.
26 | 2. Configure the LLM prompts for option generation and impersonation.
27 | 3. Set the desired number of response options.
28 | 4. Use the `/cyoa` slash command in chat to generate CYOA options.
29 |
30 | ### CYOA Buttons
31 | After generating CYOA options, you'll see a set of buttons for each suggestion:
32 | - **Suggestion Button**: Clicking on the main suggestion button will automatically impersonate the selected option. This means the AI will act as if the user had chosen that particular story beat.
33 | - **Edit Button**: Next to each suggestion is an edit button (pencil icon). Clicking this will copy the suggestion text to the input area, allowing you to modify it before sending or use it as inspiration for your own response.
34 |
35 | ### Settings
36 |
37 |
38 |
39 |
40 | - **LLM Prompt for Options**: Customize the prompt used to generate CYOA response options. You can use `{{suggestionNumber}}` as a placeholder for the number of responses.
41 | - You must ensure the LLM response contains each suggestion between `` tags. The plugin also support `< suggestion >` and `Suggestion N: text...` as valid tags.
42 | - **LLM Prompt for Impersonation**: Set the prompt used when impersonating the selected response. Use `{{suggestionText}}` as a placeholder for the chosen option's text.
43 | - **Apply World Info / Author's Note**: Toggle to include World Info and Author's Note in the CYOA generation process.
44 | - **Number of Responses**: Adjust the slider to set how many CYOA options are generated (1-10).
45 |
46 | ### LLM Prompt Examples:
47 | ```
48 | Stop the roleplay now and provide a response with {{suggestionNumber}} brief distinct single-sentence suggestions for the next story beat on {{user}} perspective. Ensure each suggestion aligns with its corresponding description:
49 | 1. Eases tension and improves the protagonist's situation
50 | 2. Creates or increases tension and worsens the protagonist's situation
51 | 3. Leads directly but believably to a wild twist or super weird event
52 | 4. Slowly moves the story forward without ending the current scene
53 | 5. Pushes the story forward, potentially ending the current scene if feasible'
54 |
55 | Each suggestion surrounded by `` tags. E.g:
56 | suggestion_1
57 | suggestion_2
58 | ...
59 |
60 | Do not include any other content in your response.
61 | ```
62 |
63 | ### Impersonate Prompt Example:
64 | ```
65 | [Event Direction for the next story beat on {{user}} perspective: {{suggestionText}}]
66 | [Based on the expected events, write the user response]
67 | ```
68 |
69 | ## Slash Command
70 | The extension exposes the `/cyoa` slash command, which can be added to SillyTavern's QuickSettings for easy access. This command triggers the generation of CYOA response options.
71 |
72 | ## Prerequisites
73 | - SillyTavern version 1.12.4 or higher
74 |
75 | ## Support and Contributions
76 | For support or questions, use the github issues or join the SillyTavern discord server.
77 |
78 | Contributions to improve this extension are welcome. Please submit pull requests or issues on the GitHub repository.
79 |
80 | ## Credits
81 | This extension was inspired by the work of LenAnderson. Original idea: https://gist.github.com/LenAnderson/7686604c9da30dee21b76a633a0027f4
82 |
83 | ## License
84 | No License, feel free to use this extension for whatever you want.
85 |
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | import {
2 | extension_settings,
3 | getContext,
4 | } from "../../../extensions.js";
5 |
6 | import { saveSettingsDebounced,
7 | setEditedMessageId,
8 | generateQuietPrompt,
9 | is_send_press,
10 | substituteParamsExtended,
11 | } from "../../../../script.js";
12 |
13 | import { SlashCommandParser } from '../../../slash-commands/SlashCommandParser.js';
14 | import { SlashCommand } from '../../../slash-commands/SlashCommand.js';
15 | import { getMessageTimeStamp } from '../../../RossAscends-mods.js';
16 | import { MacrosParser } from '../../../macros.js';
17 | import { is_group_generating, selected_group } from '../../../group-chats.js';
18 |
19 | const extensionName = "Sillytavern-CYOA";
20 | const extensionFolderPath = `scripts/extensions/third-party/${extensionName}`;
21 | const defaultSettings = {
22 | enabled: false,
23 | llm_prompt: `Stop the roleplay now and provide a response with {{suggestionNumber}} brief distinct single-sentence suggestions for the next story beat on {{user}} perspective. Ensure each suggestion aligns with its corresponding description:
24 | 1. Eases tension and improves the protagonist's situation
25 | 2. Creates or increases tension and worsens the protagonist's situation
26 | 3. Leads directly but believably to a wild twist or super weird event
27 | 4. Slowly moves the story forward without ending the current scene
28 | 5. Pushes the story forward, potentially ending the current scene if feasible
29 |
30 | Each suggestion surrounded by \`\` tags. E.g:
31 | suggestion_1
32 | suggestion_2
33 | ...
34 |
35 | Do not include any other content in your response.`,
36 | llm_prompt_impersonate: `[Event Direction for the next story beat on {{user}} perspective: \`{{suggestionText}}\`]
37 | [Based on the expected events, write the user response]`,
38 | apply_wi_an: true,
39 | num_responses: 5,
40 | response_length: 500,
41 | };
42 | let inApiCall = false;
43 |
44 | /**
45 | * Parses the CYOA response and returns the suggestions buttons
46 | * @param {string} response
47 | * @returns {string} text
48 | */
49 | function parseResponse(response) {
50 | const suggestions = [];
51 | const regex = /(.+?)<\/suggestion>|Suggestion\s+\d+\s*:\s*(.+)|Suggestion_\d+\s*:\s*(.+)|^\d+\.\s*(.+)/gim;
52 | let match;
53 |
54 | while ((match = regex.exec(`${response}\n`)) !== null) {
55 | const suggestion = match[1] || match[2] || match[3] || match[4];
56 | if (suggestion && suggestion.trim()) {
57 | suggestions.push(suggestion.trim());
58 | }
59 | }
60 |
61 | if (suggestions.length === 0) {
62 | return;
63 | }
64 |
65 | const newResponse = suggestions.map((suggestion) =>
66 | ``);
67 | return `
12 | 
38 |