From ce2902e6a3fe7333dd15e1d727f2e5a86e1a5c67 Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 19 May 2025 08:34:04 -0400 Subject: [PATCH] Updated README.md --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3f59bea..e778c79 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,11 @@

ollama+discord

-

Discord Ollama Integration

-

Ollama as your Discord AI Assistant

-

License - Release - Build Status - Deploy Status - Testing Status - Code Coverage +

Discord Ollama Chatbot Integration

+

A Discord chatbot with a little "magic" added

+

A fork of https://github.com/kevinthedang/discord-ollama

-## About/Goals v 1.1 +## About/Goals v 1.0 Ollama is an AI model management tool that allows users to install and use custom large language models locally. The project aims to: * [x] Create a Discord bot that will utilize Ollama and chat to chat with users! @@ -27,10 +22,15 @@ The project aims to: * [x] Administrator Role Compatible * [x] Multi-User Chat Generation (Multiple users chatting at the same time) - This was built in from Ollama `v0.2.1+` * [x] Automatic and Manual model pulling through the Discord client + * [x] Leverage function calling capabilities in Gemma3 + * [x] json-formatted replies allowing hidden COT and statefulness + * [x] base ollama system prompt providing json formatting, jailbreak resistance, and sentiment tracking + * [ ] function calling to imagegen + * [ ] integrate image recognition + * [x] Store self- and per-user-sentiment in redis + * [x] tell the model to create redis set and get commands itself + * [x] Separate bot personality from base bot instructions (src/personality.json) -Further, Ollama provides the functionality to utilize custom models or provide context for the top-layer of any model available through the Ollama model library. -* [Customize a model](https://github.com/ollama/ollama#customize-a-model) -* [Modelfile Docs](https://github.com/ollama/ollama/blob/main/docs/modelfile.md) ## Documentation These are guides to the features and capabilities of this app. @@ -38,7 +38,7 @@ These are guides to the features and capabilities of this app. * [Client Events](./docs/events-guide.md) ## Environment Setup -* Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo. +* Clone this repo using `git clone https://gitea.matrixwide.com/alex/discord-aidolls` * You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables. * For example, `CLIENT_TOKEN = [Bot Token]` * Please refer to the docs for bot setup. @@ -63,5 +63,3 @@ These are guides to the features and capabilities of this app. ## Acknowledgement * [Kevin Dang](https://github.com/kevinthedang) * [Jonathan Smoley](https://github.com/JT2M0L3Y) - -[discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)