sij/llux
sij/llux
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
sij-ai 2025-01-07 22:51:27 -08:00 • committed by GitHub
parent d8ad15d4f7
commit 58b8bede57
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions

8
README.md
View file

@ -1,6 +1,6 @@
# llux
llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It uses local LLMs via [Ollama]([https://ollama.ai/](https://ollama.com) for chat and image recognition, and offers image generation via [FLUX.1](https://github.com/black-forest-labs/flux). Each user in a Matrix room can set a unique personality (or system prompt), and conversations are kept per user, per channel. Model switching is also supported if you have multiple models installed and configured.
llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It uses local LLMs via [Ollama](https://ollama.ai/) and supports both image recognition and image generation. Each user in a Matrix room can set a unique personality (or system prompt), and conversations are kept per user, per channel. Model switching (OpenAI or Ollama) is also supported if you have multiple models configured.
## Getting Started
@ -17,7 +17,8 @@ llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It us
- Create a Matrix account for your bot (on a server of your choice).
- Record the server, username, and password.
- Add these details, along with any custom models, to your `config.json`.
- **Copy `config.yaml-example` to `config.yaml`** (e.g., `cp config.yaml-example config.yaml`).
- In your new `config.yaml`, fill in the relevant fields (Matrix server, username, password, channels, admin usernames, etc.). Also configure the Ollama section for your model settings and the Diffusers section for image generation (model, device, steps, etc.).
4. **Run llux**
`python3 llux.py`
@ -45,9 +46,8 @@ llux is an AI chatbot for the [Matrix](https://matrix.org/) chat protocol. It us
### Admin Commands
- **.model modelname**
- Omit `modelname` to show the current model and available options.
- Include `modelname` to switch.
- Include `modelname` to switch to that model.
- **.clear**
Reset llux for everyone, clearing all stored conversations and returning to the default settings.