stoat basic functionality, most things just dont work with this api yet
All checks were successful
Build and Push Docker Image / build (push) Successful in 17s
All checks were successful
Build and Push Docker Image / build (push) Successful in 17s
This commit is contained in:
22
README.md
22
README.md
@@ -2,41 +2,39 @@
|
||||
|
||||
it finds twitter links and turns them into girlcock links for better embed
|
||||
|
||||
rebuilt for [Stoat](https://stoat.chat), missing everything but the core functionality
|
||||
|
||||
## easiest way
|
||||
|
||||
docker image published at `git.cesium.one/kira/cockinator:latest` only needs `DISCORD` passed as a variable with your token
|
||||
docker image published at `git.cesium.one/kira/cockinator:stoat` only needs `TOKEN` passed as a variable with your token
|
||||
|
||||
### examples
|
||||
|
||||
`docker run -e "DISCORD=TOKEN_HERE" git.cesium.one/kira/cockinator:latest`
|
||||
`docker run -e "TOKEN=TOKEN_HERE" git.cesium.one/kira/cockinator:stoat`
|
||||
|
||||
```yml
|
||||
services:
|
||||
bot:
|
||||
restart: unless-stopped
|
||||
image: git.cesium.one/kira/cockinator
|
||||
image: git.cesium.one/kira/cockinator:stoat
|
||||
environment:
|
||||
- DISCORD=TOKEN_HERE
|
||||
- TOKEN=TOKEN_HERE
|
||||
```
|
||||
|
||||
## easy way
|
||||
|
||||
this also works in not docker with regular node.js, and pass it the `DISCORD` variable however you like
|
||||
this also works in not docker with regular node.js (v22.15+), and pass it the `TOKEN` variable however you like
|
||||
|
||||
`npm i && DISCORD=TOKEN_HERE node index.js`
|
||||
`npm i && TOKEN=TOKEN_HERE node index.js`
|
||||
|
||||
## other ways
|
||||
|
||||
you can build the image yourself with `docker build . -t cockinator` to then run with `docker run cockinator`
|
||||
|
||||
you can also build the image with docker-compose, by replacing `image: git.cesium.one/kira/cockinator` with `build: .`
|
||||
you can also build the image with docker-compose, by replacing `image: git.cesium.one/kira/cockinator:stoat` with `build: .`
|
||||
|
||||
## the config file
|
||||
|
||||
for the full functionality of the bot, you can copy `config.json.default` to `config.json` and fill it in.
|
||||
we only need the config to customize the initial status of the bot, so if you wanna do that, you can copy `config.json.default` to `config.json` and fill it in
|
||||
|
||||
it'll need to be in the main directory, and for docker that means mounting it as a volume with `-v ./config.json:/app/config.json`
|
||||
|
||||
## profile picture rotation
|
||||
|
||||
it'll take everything in ./avatars and shuffle them before rotating through them. this can also be mounted for docker with `-v ./avatars:/app/avatars`
|
||||
|
||||
Reference in New Issue
Block a user