WEIS

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== GUI Configurator ======
==== Purpose ====
The Configurator writes the Config.json file. This is the primary configuration file for AvaDroid.

----
==== The Configurator Elements ====

----
{{ :configurator-gui.png |}}
----

== 1. Identity ==
This section is about the AvaDroids Identity.
  * Avatar UUID: The AvaDroid's, Avatar UUID (Universally Unique IDentifier) from SL or OS. 
  * First Name: The First "Display" name. If there is no display name, use the firs login name. I recommend a Display name. <fc #ff0000>DO NOT USE FANCY CHARACTERS</fc>.
  * Last Name: The last "Display" name(s) as above.
  * Gender: Anything you want. Example: "Male Furry" is acceptable. 
  * Age: As you want.
  * Persona: This is the AvaDroids back story. Experiment here. Tell their story, but try and be concise.

==2. Parameters ==
The working Parameters for the AvaDroid. These set the persistent defaults stored in file. 

  * One Shot: The basis for Local Conversations is "Speak when Spoken to". 
    * One Shot On (TRUE) the AvaDroid will only respond if their Name or a Broadcast Word (everyone, everybody, you all) is detected in the chat.
    * One Shot Off (FALSE) the AvaDroid will respond to their Name and will keep responding in a conversation mode to the person who said their name UNTIL somebody else speaks. 
    * With One Shot Off and Greeter Off the AvaDroid will store the last 4 messages in local chat for back context in the conversation (listening). 
  * Greeter: On will cause the AvaDroid to greet anybody who enters Local Chat range with a short greeting. Greeter Off, the AvaDroid wont. NOTE: Do not teleport an AvaDroid into a crowd of people with Greeter On. <fc #ff0000>You have been warned</fc>. 
  * Mood: Sets the MOOD parameter of the AvaDroid. Beit Happy, Sad, Depressed, Silly, Surly e.t.c.
  * Action: What the AvaDroid is doing. It could be "Dancing to the good music" or "Gardening" or "Farming"
  * Number of Words: This is the NWord parameter and is the target for the number of words in the AvaDroids response. 10 is good for snappy one line responses. It is a soft limit and can be overridden in conversation by telling the AvaDroid, "you can be verbose". Example: "Anne tell me a story about kittens, you can be verbose".
  * Memory Depth: This is the number of "TURNS" the AvaDroid keeps in the conversational context memory. A "TURN" is one USER (you) and ASSISTANT (AvaDroid) sequence. Larger Memory Depths will use more context memory and make responses slower. Lower will may cause the AvaDroid to forget what the conversation was about. 
  * Broadcast triggers (comma-separated): List of other word the AvaDroid will respond to besides their name, such as everyone, everybody, you all.
  * Admin UUIDs (comma-separated): A comma delimited list of UUIDs belonging to those who have admin rights, at least yours should be there.  

== 3. AI Settings ==
Settings required to connect to the AI Engine Ollama.
  * Model: The Model name you will use. Confirm you have pulled this model and the name is correct. Do an ''ollama list'' on the machine running Ollama.
  * URL: The URL (Universal Resource Locator) for the Ollama API Endpoints. ''%%http://<IP Number>:11434/api/generate%%'' <fc #ffa500>NOTE</fc> the port 11434 and the endpoint /api/generate are default Ollama settings.
  * CTX: Context Length 4096 is the standard but if you are low on VRAM, reduce it to 2048 or 1024. If you have lots of VRAM and the Model has a large context, 200K for example, you can make it larger, but it will cause slower performance.
  * Temperature: The LLMs creativeness. If you want a Mad AvaDroid, you could try 1.8 or even 2.0. the lower the more sensible (boring) the AvaDroid becomes, going higher than 2.0 will eventually have the AvaDroid babbling gibberish. 
  * This is the first part of the AI "System Prompt" which tells the AvaDroid's AI how to function. Do not change this unless you know what you are doing. If you do change, take a copy of the included one first. There was a lot of research and trial and error to arrive at this one. See [[instruction_analysis|AI Instruction Design Analysis]]

== 4. Corrade Settings ==
These are the settings needed for the AvaDroid Container to talk to the Corrade Container.
  * IP Address/Name: The IP number of the Docker Host Corrade is on, it should be set from the initial configuration.
  * MQTT Port: The port you mapped to 1883 in the compose.yml file.
  * Nucleus Port: The port you mapped to 54377 in the compose.yml file.
  * Group: the group you created, the AvaDroid joines and you configured in Nucleus.
  * Password: The password you created in Nucleus for the group which is the AvaDroid software to Corrade authentication.

== 5. Save/Cancel ==
  * Save: Saves all the settings to the config.yml file and reloads this file. These are your default settings.
  * Cancel: Cancels the edit and reloads the config.yml.