mahiatlinux commited on
Commit
6299766
1 Parent(s): 4e3fbe0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -44
README.md CHANGED
@@ -1,44 +1,8 @@
1
- <div align="center">
2
- <h1><a href="#"></a>Discord AI Bot</h1>
3
- <h3 align="center"><a href="#"></a>Discord bot to interact with <a href="https://github.com/jmorganca/ollama">Ollama</a> as a chatbot</h3>
4
- <h3><a href="#"></a><img alt="Stars" src="https://img.shields.io/github/stars/mekb-turtle/discord-ai-bot?display_name=tag&style=for-the-badge" /></h3>
5
- <h3><a href="#"></a><img alt="Discord chat with the bot" src="assets/screenshot.png" /></h3>
6
- </div>
7
-
8
- ### Archived
9
- I have decided to archive this project as I no longer have the time to maintain it. If you would like to take over the project, [please let me know](https://github.com/mekb-turtle).
10
-
11
- ### Set-up instructions
12
- 1. Install [Node.js](https://nodejs.org) (if you have a package manager, use that instead to install this)
13
- - Make sure to install at least v14 of Node.js
14
- 2. Install [Ollama](https://github.com/jmorganca/ollama) (ditto)
15
- 3. Pull (download) a model, e.g `ollama pull orca` or `ollama pull llama2`
16
- 4. Start Ollama by running `ollama serve`
17
- 5. [Create a Discord bot](https://discord.com/developers/applications)
18
- - Under Application » Bot
19
- - Enable Message Content Intent
20
- - Enable Server Members Intent (for replacing user mentions with the username)
21
- 6. Invite the bot to a server
22
- 1. Go to Application » OAuth2 » URL Generator
23
- 2. Enable `bot`
24
- 3. Enable Send Messages, Read Messages/View Channels, and Read Message History
25
- 4. Under Generated URL, click Copy and paste the URL in your browser
26
- 7. Rename `.env.example` to `.env` and edit the `.env` file
27
- - You can get the token from Application » Bot » Token, **never share this with anyone**
28
- - Make sure to change the model if you aren't using `orca`
29
- - Ollama URL can be kept the same unless you have changed the port
30
- - You can use multiple Ollama servers at the same time by separating the URLs with commas
31
- - Set the channels to the channel ID, comma separated
32
- 1. In Discord, go to User Settings » Advanced, and enable Developer Mode
33
- 2. Right click on a channel you want to use, and click Copy Channel ID
34
- - You can edit the system message the bot uses, or disable it entirely
35
- 8. Start the bot with `npm start`
36
- 9. You can interact with the bot by @mentioning it with your message
37
-
38
- ### Set-up instructions with Docker
39
- 1. Install [Docker](https://docs.docker.com/get-docker/)
40
- - Should be atleast compatible with version 3 of compose (docker engine 1.13.0+)
41
- 2. Repeat steps 2—7 from the other setup instructions
42
- 3. Start the bot with `make compose-up` if you have Make installed
43
- - Otherwise, try `docker compose -p discord-ai up` instead
44
- 4. You can interact with the bot by @mentioning it with your message
 
1
+ ---
2
+ title: Test1234
3
+ emoji: 📉
4
+ colorFrom: pink
5
+ colorTo: blue
6
+ sdk: docker
7
+ pinned: false
8
+ ---