kulmapaikka-ircbot/README.md
2021-11-13 12:14:19 +02:00

41 lines
1.3 KiB
Markdown

# Kulmapaikka IRC Bot
Irkkibotti kulmapaikkalaisille. Sisältää seuraavat huimat ominaisuudet:
Ominaisuus|Kuvaus|
----------|------|
.sää / .saa | Antaa säätiedot tärkeimmille paikkakunnille. Hakee Tiedot OpenWeatherMapista ja Aurassa sijaitsevasta lämpöanturista. |
.sää / .saa *kaupunki* | Antää säätiedot annetulle kaupungille
.heita / .heitä x×d×n | Heittää x kertaa n-sivuista noppaa |
.op | Antaa operaattorioikeudet kaikille ketkä sen ansaitsevat |
.youtube *hakusana* | Hakee youtubesta hakusanalla |
.luohahmo | Luo D&D-hahmon (yksinkertainen) |
.luohahmo2 | Luo D&D-hahmon (monipuolinen) |
.kernel *tyyppi* | Kertoo nykyisen uusimman kernel-version. Tyyppi voi olla longterm/stable/mainline. Mainline on oletus. |
.wtf *kysymys* | Kertoo mitä termi tarkoittaa |
.vitsi | Kertoo puujalkavitsin englanniksi |
## Automaattiset toiminnot
- Youtube-linkeille tulee automaattisesti youtube-tiedot
- Twitter ja Mastodon -linkeistä automaattisesti näkyy sisältö
## Asennus
Muokkaa config.example.js ja tallenna config.js-tiedostona. Tämän jälkeen riittää:
```sh
npm install
npm run start
```
## Docker
```sh
docker build -t kulmapaikka-ircbot .
docker run -v $(pwd)/config.js:/app/config.js kulmapaikka-ircbot
```
## Tekijä
Jukka Susivainio <jukka.susivainio@posteo.fi>