------------------------------------------------------------ SIMPLE NPC PROMPT GENERATOR GUIDE ------------------------------------------------------------ 1. GETTING STARTED: SETUP AND API KEY a) API KEY: - What it is: A unique code provided by your API service (OpenRouter) that allows the tool to send requests. - How to use it: * Locate the "API Key" field at the top left. * Paste your API key into the field. * Click "Save API Key" to store it. * A confirmation message is logged in the debug console. b) MODEL SELECTION: - What it is: Different versions of the language model used to generate your NPC prompt. - How to use it: * Select a model from the "Model" dropdown next to the API Key field. * Click "Refresh Models" if you need to update the list. * Use "Save as Favorite" to mark a model for quick access. ------------------------------------------------------------ 2. MASTER TEMPLATE & TEMPLATE MANAGEMENT a) MASTER TEMPLATE: - Purpose: Contains the instructions (with placeholders like #HERIKA_NAME# and #PLAYER_BIOS#) that guide prompt generation. - How to use it: * The large text area shows default instructions which you can modify. * This field scales with the window, giving you plenty of room to edit. b) TEMPLATE NAME DROPDOWN: - Purpose: Manage your templates by saving and loading them using names. - How to use it: * The "Template Name" combobox (editable) lets you type a new template name or select a previously saved template. * Click "Save Template" to save the current template under the chosen name. * Click "Load Template" to load a saved template into the Master Template field. ------------------------------------------------------------ 3. PLAYER BIO INPUT a) #PLAYER_BIOS# FIELD: - Purpose: Enter the player character description as perceived by the NPC. - How to use it: * Type your description into the "#PLAYER_BIOS#" text area. * Hover over the field to see a tooltip for guidance. * The field scales horizontally with the window. ------------------------------------------------------------ 4. NPC INFORMATION a) NPC NAME (#HERIKA_NAME#): - Purpose: Enter or select the NPC’s name (must match the in-game name exactly). - How to use it: * Use the dropdown to select an existing NPC name or type a new one. * Hover over the field for tooltip guidance: "NPC Name. MUST MATCH their Skyrim in-game NPC name!" b) ZODIAC SIGN: - Purpose: Optionally assign a zodiac sign to your NPC. - How to use it: * Select a zodiac sign from the "Zodiac Sign" dropdown. * If you choose "Random", a zodiac sign is automatically assigned. c) NPC DESCRIPTION (#HERIKA_PERS#): - Purpose: Provide details about the NPC’s static personality (core traits and facts that do not change). - How to use it: * Enter the NPC’s description in the "#HERIKA_PERS#" text area. * Hover over the field to see a tooltip: "1st half of NPC Bio. NPC Static Personality. Should be core traits and facts about a person that does not change." ------------------------------------------------------------ 5. PROMPT GENERATION a) GENERATE PROMPT: - Purpose: Create a formatted NPC prompt using all the provided inputs. - How to use it: * At the bottom, enter the maximum number of tokens (default is 500) in the "Max Result Tokens" field. * Click "Generate Prompt". * The generated prompt will appear in the "Generated Prompt" field, which scales with the window. ------------------------------------------------------------ 6. ADDITIONAL FUNCTIONS a) SAVE/LOAD NPC: - Purpose: Save your NPC profiles to a local database and load them later. - How to use it: * Use "Save NPC" to store the current NPC details. * Use "Load NPC" to retrieve a previously saved NPC profile. b) DEBUG CONSOLE: - Purpose: View detailed logs of operations and API responses for troubleshooting. - How to use it: * Click "Show Debug Console" to open the log window. ------------------------------------------------------------ 7. TIPS FOR BEST USE - Experiment with different Master Template instructions to see how they affect the output. - Make sure your NPC name exactly matches the in-game character name to avoid errors. - Use tooltips (hover over fields) if you’re unsure about what to enter. - Regularly save your templates and NPC profiles for future reuse. ------------------------------------------------------------ Enjoy using the Simple NPC Prompt Generator to create engaging NPC prompts for your Skyrim-inspired mods! ------------------------------------------------------------