Update README.md

README.md

@@ -30,7 +30,7 @@ tags:
 ---
 <h1><ins>GM-5: Game Mistress Environment ~ by Sphiratrioth</ins></h1>
 
-This is a TTRPG-like version of  my custom roleplaying system. It creates worlds, stories, quests for user character, not particular characters to roleplay with. It will generate NPCs, they are behaviorally guided so they use their own personalities consistently but if you want the typical user-character interaction, use SX-5 instead.
+This is a TTRPG-like version of  my custom roleplaying system. It creates worlds, stories, quests for user character, not particular characters to roleplay with. It will generate NPCs, they are behaviorally guided so they use their own personalities consistently but if you want the typical user-character interaction, use SX-5 instead (https://huggingface.co/sphiratrioth666/SX-5_Character_Roleplaying_System?not-for-all-audiences=true).
 
 <div style="text-align: justify">Finally, AI becomes the GM for your TTRPG sessions!
 
@@ -93,62 +93,59 @@ As a bonus, you will also find a lot of my other projects there. Some Reshade pr
 
 <h2><ins>Extra Lorebooks (fully optional)</ins></h2>
 <li>Sex Booster - better, more active and assertive characters in NSFW scenes (FEMALE & TS FEMALE CHARACTERS ONLY, AT LEAST FOR NOW);
-<li>TTRPG mode - you are the Game Master/Game Mistress and the LLM becomes the player in a world you control - role reversal of sorts;
 <li>Year Zero Engine & Powered by the Apocalypse TTRPG system lorebooks - to roll dice and use those systems in your roleplays;
-<li>Simple Events Injector/DC Dice Rolling Mechanism (DC: check/RNG: check - to determine if current action worked/failed or to introduce random opportunities/complications)
-<li>Sphiratrioth's Boutique - a fun system to make your characters wear different outfits each roleplay (it is all auto-rolled and adjusted to make sense/match - FEMALE CHARACTER ONLY, AT LEAST FOR NOW)</li></div>
+<li>Simple Events Injector/DC Dice Rolling Mechanism (DC: check/RNG: check - to determine if current action worked/failed or to introduce random opportunities/complications)</li></div>
 
-<br>
 <h1><ins>How to set it up?</ins></h1>
 
-<b>Download all the filest in the repository!</b>
+<b>Download all the filest in the GM-5 HuggingFace repository!</b>
 
-1. Navigate to the files section of this post and download all the files.
-2. Choose the AIO version or the modular version. AIO includes NSFW and it is just one lorebook to activate in SillyTavern. Modular version allows selecting separate modules freely but you need to activate more lorebooks. BEWARE: DO NOT MIX THE AIO AND THE MODULAR LOREBOOKS!
-3. Import the GM Character, the lorebooks & the GM sysprompts in SillyTavern. Use the character import functionality within the SillyTavern for a character card or copy-paste the .png character card file to (...):\SillyTavern\data\default-user\characters. Then, copy-paste the lorebook files into your SillyTavern lorebooks directory aka (...):\SillyTavern\data\default-user\worlds. You need just one "00. AIO - Game Mistress (Framework)" lorebook + all the scenario lorebooks or a varied number of the modular version framework lorebooks + all the scenario lorebooks. Choose just the AIO or just the MODULAR lorebooks, do not mix those two formats together. They are the same - in one pack or split into parts. Finally, copy the system prompt files to (...):\SillyTavern\data\default-user\sysprompt.
-5. Activate a proper GM-4 Sysprompt: (character) if you want the AI to be your GM or (user) if you want to be a GM and make AI roleplay a character in the world (experimental, it may or may not work, it works much better with SX-4 environment with a fully fleshed out character rather than within the GM-4 environment!)
+1. Navigate to the files section of this post and download all the files from the main directiory and from all the sub-folders.
+2. Copy lorebooks to (...)\SillyTavern\data\default-user\worlds.
+3. Copy character card to (...)\SillyTavern\data\default-user\characters.
+4. Copy the GX-5 sysprompt to (...)\SillyTavern\data\default-user\sysprompt.
+5. Use my custom context & instruct templates/samplers/regex from https://huggingface.co/sphiratrioth666/SillyTavern-Presets-Sphiratrioth - for better adherence to instructions and general quality improvements. There is a whole guide on how to import those and how to use them under the attached URL but the rule of thumb says: system prompt files go to (...)\SillyTavern\data\default-user\sysprompt, instruct template files go to (...)\SillyTavern\data\default-user\instruct, context string/template files go to (...)\SillyTavern\data\default-user\context, sampler files go to (...)\SillyTavern\data\default-user\TextGen Settings, then you load it up in SillyTavern.
+6. Open up SillyTavern.
+7. Select the GM-5 Sysprompt & instruct/context templates that match your LLM model (it's Mistral Tekken V7 for me). If you're using my REGEX (optional) - make sure to turn "Trim Incomplete Sentences" off. My REGEX does it better than standard SillyTavern solutions.
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/dnnbdduaeNu1FqPfnvUSA.png)
+![image](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/--Az-nDpePpcz0hmMja-o.png)
 
-7. Activate the lorebooks: Framework [AIO] + Scenario lorebooks or all the Framework [MODULAR] lorebooks + Scenario lorebooks in SillyTavern.
+8. Select the Game Mistress character in your character lists. Make sure to import the embedded Character Lorebook & Regex when you're asked to. An automatic prompt should appear when you click on the Game Mistress character in your character list. If previously imported character is not visible, navigate to (...)\SillyTavern\data\default-user\characters, delete the copy-pasted Game Mistress character and use the internal SillyTavern functionality to import the characters from a .png file.
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/mag2nJfOESUn_Xx5E2T-n.png)
+<h1><ins>How to use it?</ins></h1>
 
-8. Select the Game Mistress character.
+1. Navigate to the chat window. You should be greeted with a "generic" GM-5 style roleplay message. This is where you roleplay and generate different starting messages (by using the normal chat window).
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/ophtVDNyNaW8zD3X0JH0T.png)
+![image](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/yc1q4z43Y6ywmMBU5bQoZ.png)
 
-10. Swipe the default starting message left to find the alternate starting messages - they are just convenient lists of all the available options and their trigger words. There are also examplary trigger chains in one of the messages - aka example things you will type in the chatting window to start the roleplay - but ONLY UNDER A DEFAULT STARTING MESSAGE.
+2. For now, navigate left to the alternate starting messages to check the list of all the available scenarios, locations and variables to select from - together with their trigger words.
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/Fgj52Nl1qcZV8lu5oyCOq.png)
+![image](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/mY7zmnDTqaOMQw9NpbUD8.png)
 
 <b>Roleplay:</b>
 
-1. Return to the DEFAULT STARTING MESSAGE. BEWARE: THIS IS THE ONLY MESSAGE WHERE YOU START YOUR ROLEPLAYS. ALL THE ALTERNATIVE STARTING MESSAGES ARE JUST THE TRIGGER WORDS LISTS - FOR CONVENIENCE. DO NOT ROLEPLAY THERE!
+3. Return to the DEFAULT STARTING MESSAGE. BEWARE: THIS IS THE ONLY MESSAGE WHERE YOU ROLEPLAY. ALL THE ALTERNATIVE STARTING MESSAGES ARE JUST THE TRIGGER WORDS LISTS - FOR CONVENIENCE. DO NOT ROLEPLAY THERE!
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/i2-qghXAAEU_iOlXCH942.png)
+![image](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/yc1q4z43Y6ywmMBU5bQoZ.png)
 
-3. Type in the trigger words you want. You need a scenario/setting at minimum, you can add the location if you want (and it is highly suggested). Something like: "GM: fantasy, Location: dungeon" or "GM: 03, L: street" (see the included lists of options in the alternative starting messages to find what is available!)
+4. Optional: after deciding what you want to roleplay (but before generating the message), you can activate one of the additional "World" lorebooks to make the roleplay experience better.
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/UMPeFO3qponfzfBoHHjiA.png)
+5. Type in the trigger words you want. You need a scenario at minimum, you can add the location if you want or roll it randomly.
 
-4. Hit ENTER - the actual starting scene/message for your roleplay will be generated. If the LLM makes a mistake, does not jump right into the world of your choice or blabbers somethihng about the Game Mistress and the TTRPG session, try again.
+![image](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/gQ_2XJLa-E5s5Lmaq4NsR.png)
 
-![image/png](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/KEsi4p2p9Q72SMoWPLSST.png)
+6. Hit ENTER - the actual starting scene/message for a roleplay will be generated. If LLM makes a mistake, just try again. From now on, just roleplay and have fun!
 
-6. Optional: after deciding what you want to roleplay, you can also activate one of the additional "World" lorebooks to make the roleplay experience better.
+![image](https://cdn-uploads.huggingface.co/production/uploads/66a2a6820c4cd36ffbc95623/EyXL-UkeSvJffFIyiN3L-.png)
 
 <div style="text-align: justify"><h2><ins>Tips & Tricks</ins></h2>
 
 - always roleplay in the default starting message. If you edit it, just remember that it needs to include a suggestion/set-up for roleplaying - so the LLM understands instructions from a lorebook properly and generates the actual starting message for a roleplay.
 - edit the scenarios & other interesting things within the framework and scenario lorebooks;
-- you can turn the options on & off by changing the value "trigger" from 0 to 100 to turn something on and from 0 to 100 to turn something off. This way, you can permanently select something for your roleplays and turn all the rest off. However, you will still need to use the trigger words if they're defined within the trigger words field. If you want to just always roleplay in a given setting, change this setting's activation to a "blue dot" and delete the trigger words, then set all the other entires within the group Trigger values to 0.
+- you can turn the options on & off by changing the value "trigger" from 0 to 100 to turn something on and from 0 to 100 to turn something off. This way, you can permanently select something for your roleplays and turn all the rest off. However, you will still need to use the trigger words if they're defined within the trigger words field. If you want to always roleplay in a given setting, change this setting's activation to a "blue dot" and delete the trigger words, then set all the other entires within the group Trigger values to 0. If you're having problems understanding it - refer to the full SX-5 instructions for a detailed guide on how such lorebook editing works (https://huggingface.co/sphiratrioth666/SX-5_Character_Roleplaying_System?not-for-all-audiences=true).
 - some things may be triggered with a full word or with a "quick trigger" like fantasy: 01 vs F: 01; see the scenario lists in the alternate starting messages for more information on what can be triggered and how. It is very convenient and intuitive!</div>
 
 <h2><ins>UPDATES</ins></h2>
 
-<li>v.1.0</li>
-<div style="text-align: justify">RELEASE
-
-<li>v.1.1</li>
-<div style="text-align: justify">TTRPG SYSTEM LOREBOOKS ADDED (PBTA & YZE) [SETTING NEUTRAL]
+<li>v.5.0</li>
+<div style="text-align: justify">RELEASE