# girl cock inator

it finds twitter links and turns them into girlcock links for better embed

# setup

## easiest way

docker image published at `git.cesium.one/kira/cockinator:latest` only needs `DISCORD` passed as a variable with your token

### examples

```
docker run -e "DISCORD=TOKEN_HERE" git.cesium.one/kira/cockinator:latest
```

or if you like docker compose:

```yml
services:
  bot:
    image: git.cesium.one/kira/cockinator
    environment:
      - DISCORD=TOKEN_HERE
```

## easy way

this also works in not docker with regular node.js, and pass it the `DISCORD` variable however you like

```bash
npm i # run once to install dependencies
DISCORD=TOKEN_HERE node index.js
```

## other ways

you can build the image yourself with `docker build . -t cockinator` to then run with `docker run -e "DISCORD=TOKEN_HERE" cockinator`

you can also build the image with docker-compose, by replacing `image: git.cesium.one/kira/cockinator` with `build: .`

## the config file

for the advanced functionality (see below) of the bot, 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`

# functionality

listens to messages and if one contains a twitter.com or x.com link, it'll send a new message containing girlcockx.com version of that link with extra garbage removed, and then clears the embed of the original message so only the new embed shows.

## advanced functionality

everything in here needs to be set up with `config.json` mentioned above

### jellyfin

read a Jellyfin library and generate direct links to the file, intended for vrchat media players.

**WARNING: the output of this feature is restricted to DMs because the links output expose the API key**, so also don't paste the output links anywhere

### avatar rotation

if you add images to `./avatars` (`/app/avatars` in the docker container), the bot will shuffle them all and cycle through daily. this will work without `config.json`, but can be configured further using it. for docker, you can mount `./avatars` to the container by adding `-v ./avatars:/app/avatars` to the docker run command