Compare commits
No commits in common. "a1fa8e98c255d3b8ea9464cfd63ab76696714691" and "9d5d30e7435d49daed7fc4c4977d48d0e1ba67be" have entirely different histories.
a1fa8e98c2
...
9d5d30e743
23
README.md
23
README.md
|
@ -1,23 +0,0 @@
|
||||||
# matrix-bot-openai-wrapper
|
|
||||||
## What does this bot do?
|
|
||||||
This bot relays the prompt to the openai API and sends the answer back to the user who made the request. All this is done through the Matrix chat-client.
|
|
||||||
|
|
||||||
This way they can do less user-tracking if multiple people prompt through the same API token.
|
|
||||||
Also chat clients, such as Matrix, are more practical to interact with bots.
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
* Local environment requires `nodejs`, `yarn` and `nvm`
|
|
||||||
* Access token for the Matrix account. The access token can be obtained by using this [script](https://git.pub.solar/realestninja/fetch-matrix-access-token).
|
|
||||||
|
|
||||||
## Installation, setup and running the bot
|
|
||||||
* `yarn install`
|
|
||||||
* `nvm use`
|
|
||||||
* `cp config.ts.example config.ts`
|
|
||||||
* Edit the `config.ts`
|
|
||||||
* Run `yarn start` to start the bot
|
|
||||||
|
|
||||||
## Planned features
|
|
||||||
* Improve formatting
|
|
||||||
* Add logic for user management
|
|
||||||
* Add option to temporarily set context
|
|
||||||
* Add option to reset context
|
|
|
@ -7,7 +7,7 @@
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"start": "node --loader ts-node/esm src/main.ts"
|
"start": "ts-node src/main.ts"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@types/node": "^22.5.0",
|
"@types/node": "^22.5.0",
|
||||||
|
|
Loading…
Reference in a new issue