Usage
After enabling the module for a world, click on the actor of your choice.
Click on "Make UnKenny" and enter some of the following data:
* **Alias**: An UnKenny alias to refer to the actor in chat messages. Only alphanumeric characters and underscores are allowed here.
* **Preamble**: This is a short description of what the character needs to know about themselves.
* **Model**: Pick one of the available [large language models](https://en.wikipedia.org/wiki/Large_language_model).
* **OpenAI API key**: Most models are free of any charge and run in your Foundry instance or web browser, but to interact with OpenAI's GPT you will need to [set up and pay for an API key](https://blog.streamlit.io/beginners-guide-to-openai-api/). This option is only displayed for models that require it.
* **Min/Max number of generated tokens**: Effectively constrains the length of the generated output.
* **Repitition penalty**: The higher the number, the more the model tries to avoid repeating itself.
* **Prefix with /talk**: If this option is checked and the [Talking Actors Module](https://foundryvtt.com/packages/acd-talking-actors) is set up, the model's responses are read out loud by an AI voice.
As long as the alias is not empty, the actor is considered *unkenny* and can be adressed. To speak to the actor, begin a chat message with the text macro `/<alias>`, where `<alias>` is the *UnKenny alias* of the actor. Alternatively, mention the actor anywhere in your message using `@<alias>`. In the first case, the macro is removed from your chat message, while in the second case the mention is replaced with the actor's full name.
Your chat message is posted, and a short while later, the response generated by the large language model is posted below it.