mirror of
https://github.com/NekoMonci12/RakunNakun-AI.git
synced 2025-12-19 14:59:15 +00:00
ReadMe.md update
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2025 NekoMonci12
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
56
README.md
56
README.md
@@ -1,2 +1,54 @@
|
|||||||
# RakunNakun-AI
|
<div align="center">
|
||||||
|
<img src="https://cdn.yuemi.org/yuemi/YueMi-Banner-Dark.png" width="320" alt="YueMi Logo"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
---
|
||||||
|
## 📃 Description
|
||||||
|
```
|
||||||
|
RakunNakun is an Discord Bot that integrate LLM into chat on discord.
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
## 🔧 Dependencies
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/mysql.svg" width="32" height="32" alt="MySQL Logo" style="vertical-align:middle;"/> MySQL Database
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/mongodb-1.svg" width="32" height="32" alt="MongoDB Logo" style="vertical-align:middle;"/> MongoDB Database
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/jsIconGreen.svg" width="32" height="32" alt="NodeJS Logo" style="vertical-align:middle;"/> NodeJS 21
|
||||||
|
|
||||||
|
---
|
||||||
|
## ⚙️ Installation
|
||||||
|
1. Copy `.env.example` to `.env`
|
||||||
|
2. Fill Credentials on `.env`
|
||||||
|
3. Run This Commands
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
node index.js
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
## 🚧 Features
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/mongodb-1.svg" width="32" height="32" alt="MongoDB Logo" style="vertical-align:middle;"/> Caching System
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/voyage-ai.svg" width="32" height="32" alt="Voyage Logo" style="vertical-align:middle;"/> [Text Embedding](https://www.voyageai.com/)
|
||||||
|
- LLM API Compability
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/openai.svg" width="32" height="32" alt="OpenAI Logo" style="vertical-align:middle;"/> [OpenAI](https://openai.com/)
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/deepseek.svg" width="32" height="32" alt="Deepseek Logo" style="vertical-align:middle;"/> [Deepseek](https://chat.deepseek.com/)
|
||||||
|
- <img src="https://cdn.yuemi.org/logo/llm7.png" width="32" height="32" alt="LLM7 Logo" style="vertical-align:middle;"/> [LLM7](https://llm7.io/)
|
||||||
|
- Guilds Tokens
|
||||||
|
- API Endpoint
|
||||||
|
|
||||||
|
---
|
||||||
|
## 📲 Pregenerate (Using [LLM7](https://llm7.io/))
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
node batchpull.js
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
## 🎥 Preview
|
||||||
|
### `/chat` - Chat with LLM Models
|
||||||
|
<img src="https://i.imgur.com/N6MlQgd.gif" width="480"/>
|
||||||
|
|
||||||
|
### `/debugmode` - Toggle Debug Mode
|
||||||
|
<img src="https://i.imgur.com/NXhMMVR.gif" width="480"/>
|
||||||
|
|
||||||
|
### `/generate-api` - API Endpoint System
|
||||||
|
<img src="https://i.imgur.com/PtF4xu4.gif" width="480"/>
|
||||||
|
|||||||
Reference in New Issue
Block a user