sphiratrioth666 commited on
Commit
ae24d5e
·
verified ·
1 Parent(s): aecade6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +55 -1
README.md CHANGED
@@ -85,4 +85,58 @@ Ghorza Barg'nash (Adventurer)
85
  <br>
86
  <h1><ins>How to use:</ins></h1>
87
 
88
- I will not lie to you. All you see here works best with my SillyTavern presets (https://huggingface.co/sphiratrioth666/SillyTavern-Presets-Sphiratrioth). You can theoretically try different presets as well - but as much as I always suggest trying them all out (I like the Marinara's and Virt-dude's ones myself) - this time, I sadly need to auto-promote. I tailored my presets to work exactly with this format here since that's how I am personally roleplaying since last summer (2024). Feel free to try it with other presets - but do not complain if something goes wrong!
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
  <br>
86
  <h1><ins>How to use:</ins></h1>
87
 
88
+ I will not lie to you. All you see here works best with my SillyTavern presets (https://huggingface.co/sphiratrioth666/SillyTavern-Presets-Sphiratrioth). You can theoretically try different presets as well - but as much as I always suggest trying them all out (I like the Marinara's and Virt-dude's ones myself) - this time, I sadly need to auto-promote. I tailored my presets to work exactly with this format here since that's how I am personally roleplaying since last summer (2024). Feel free to try it with other presets - but do not complain if something goes wrong!
89
+
90
+ Download Example Characters:
91
+
92
+ 1. Navigate to the files section of this post and download the characters.
93
+ 2. Import Characters in SillyTavern.
94
+ 3. Click on the SX-2 Character on the list - it should ask you to import the embedded lorebook and to turn the attached REGEX on.
95
+
96
+ Character Set-Up:
97
+
98
+ 1. Make sure that the character-attached REGEX is on under the SillyTavern tab Extensions/Regex/Scoped Scripts.
99
+
100
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/-449u-JOgQVzDzuVMFO1g.png)
101
+
102
+ 2. Make sure that the character embedded lorebook has been imported: click on the green globe button under the character tab to make sure that the embedded lorebook loads up properly. SillyTavern should ask if you're ant to import the embedded lorebook automatically - when you import a character and click on it for the first time. Thus, this step is just to make sure that everything works as intended.
103
+
104
+ ![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/f4QefnKjNB8pwFdeGXRif.png)
105
+
106
+ Starting Roleplay:
107
+
108
+ 1. Default starting message - this is where you roleplay. You activate scenarios through their trigger words and the LLM will generate the actual starting message for a given scene. A starting message will be always a bit different - so - no more boring, repetitive roleplays!
109
+ 2. Swipe left (to the last starting message) - to see the list of all the available scenarios embedded in the character lorebook. They are activated with trigger words: SC01, SC02, SC03... or SC: 01, SC: 02, SC: 03... or Scenario: 01, Scenario 02, Scenario 03... or Scene: 01, Scene: 02, Scene: 03... Which must be typed under the default starting message. Do not use any other window than a default starting message for the actual roleplay!
110
+ 3. You can also define the optional variables of your scenes - such as a current weather or a relationship with {{user}}. To do that, simply add the given conditions keywords after SC01, SC02, SC03. The list of pickable options is just below the scenarios list.
111
+
112
+ Example - this is what you type in a normal chat window under the default starting message:
113
+
114
+ ```SC03, weather: rain, relationship: friend, residence: apartment```
115
+
116
+ 4. If you swipe left again - you will see the list of all the available clothes in a wardrobe of your character. You can pick up what you like and dress up a character in that - also mid-roleplay!
117
+
118
+ Example - again, what you need to type in a normal chat under the default starting message:
119
+
120
+ ```SC03, outfit: 8, weather: rain, relationship: friend, residence: apartment```
121
+
122
+ 5. You can also create your own scene/scenario and generate a starting message for it. In such a case, you will need to navigate to the default starting message again and type exactly this in a normal chat window:
123
+
124
+ Custom Scenario/Scene: clear, short instructions on what each character is doing, where they are, how scene looks like
125
+
126
+ Example:
127
+
128
+ ```Custom Scenario: I am driving a car on the German highway, you are sitting next to me, I pull off to the gas station.```
129
+
130
+ or
131
+
132
+ ```Custom Scene: {{char}} is a cyberpunk mercenary, {{user}} is a fixer, {{char}} visits {{user}} in a bar to get the new job.```
133
+
134
+ 6. As long as you type at least a predefined scenario trigger word or you define a scenario yourself, LLM will generate a starting message and you can start your roleplay!
135
+
136
+ 7. You can also roll a scenario from the list. Just use a command: scenario: roll or scene: roll.
137
+
138
+ 8. If generated messages are not good enough, try using my SillyTavern presets - the characters were actually tailored to work best with them: (https://huggingface.co/sphiratrioth666/SillyTavern-Presets-Sphiratrioth).
139
+
140
+ 9. Quick-start message - by using it, you can just start the roleplay without generating anything. In this scene, you wake up and {{char}} knocks on the door of your bedroom, which serves as a nice starter for a slice of life roleplay. It is currently set-up as the second starting message so swipe right to see it. Just remember that the default (first) starting message remains the main, functional one to generate anything and to take full advantage of the SX-2 format. A secondary starting message comes purely as a bonus - when you do not want to use the pre-defined scenarios or craft your own scene.
141
+
142
+ 10. Quick Triggers - weather, mood, relationship state, sexuality, everyday outfits may be also triggered or rolled with quick triggers instead of the whole words. For weather, just use W: your choice, for mood, use M: your choice, for relationship, use R: your choice, for sexuality, use S: your choice. You can also roll everything with the quick triggers aka W: roll, M: roll, R: roll, S: roll.