Skip to content

Commit

Permalink
update readme for new improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
bigsk1 committed Jun 26, 2024
1 parent 9852d05 commit ee22ed4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
2 changes: 0 additions & 2 deletions .env.sample
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
# You can mix and match; use local Ollama with OpenAI speech or use OpenAI model with local XTTS, etc.

# Model Provider: openai or ollama
# Once set, if run webui can't change in UI until you stop server and restart
MODEL_PROVIDER=ollama

# Character Configuration:
Expand All @@ -13,7 +12,6 @@ CHARACTER_NAME=nerd

# Text-to-Speech (TTS) Configuration:
# TTS Provider - Options: xtts (local uses the custom character .wav) or openai (uses OpenAI TTS voice) or elevenlabs
# Once set, if run webui can't change in UI until you stop server and restart
TTS_PROVIDER=elevenlabs

# OpenAI TTS Voice - Used when TTS_PROVIDER is set to openai above
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ You can run all locally, you can use openai for chat and voice, you can mix betw
- **Analyzes user mood and adjusts AI responses accordingly**: Get personalized responses based on your mood.
- **You can, just by speaking, have the AI analyze your screen and chat about it**: Seamlessly integrate visual context into your conversations.
- **Easy configuration through environment variables**: Customize the application to suit your preferences with minimal effort.
- **WebUI or Terminal usage**: Can be ran with either
- **WebUI or Terminal usage**: Run with your preferred method , but recommend the ui as you can change characters, model providers, speech providers, voices, ect..
- **HUGE selection of built in Characters**: Talk with the funniest and most insane AI characters!


## Installation
Expand Down Expand Up @@ -152,10 +153,9 @@ In the docker folder there is also some scripts to update the model and tts prov
```env
# Conditional API Usage:
# Depending on the value of MODEL_PROVIDER, the corresponding service will be used when run.
# You can mix and match; use local Ollama with OpenAI speech or use OpenAI model with local XTTS, etc. You have to shutdown server when switching between tts providers and model providers but all other options can be updated when server is running in webui.
# You can mix and match; use local Ollama with OpenAI speech or use OpenAI model with local XTTS, etc.
# Model Provider: openai or ollama
# Once set, if running webui you can't change in the UI until you stop server and restart
MODEL_PROVIDER=ollama
# Character Configuration:
Expand Down

0 comments on commit ee22ed4

Please sign in to comment.