justlog/README.MD

31 lines
1.6 KiB
Markdown
Raw Normal View History

2020-06-01 10:18:48 -04:00
# justlog [![Build Status](https://github.com/gempir/justlog/workflows/ci/badge.svg)](https://github.com/gempir/justlog/actions?query=workflow%3Aci)
2017-03-08 18:16:37 -03:00
### What is this?
2018-12-01 13:46:24 -03:00
justlog is a bot I maintain for a couple of channels. Its features differ from other bots in that it doesn't support
commands, etc. yet, it focuses on logging and providing an api for the logs.
### Commands
- `!justlog status` will respond with uptime
- `!justlog join gempir,pajlada` will join the channels and append them to the config
- `!justlog messageType gempir 1,2` will set the recorded message types to 1 and 2 in channel gempir (will fetch the userid on its own)
- `!justlog messageType gempir reset` will reset to default
### Config
```
{
"admin": "gempir", // will only respond to this user with !status
"logsDirectory": "./logs", // the directory to log into
"username": "gempbot", // bot username (can be justinfan123123 if you don't want to use an account)
"oauth": "oauthtokenforchat", // bot token can be anything if justinfan123123
"clientID": "mytwitchclientid", // your client ID, needed for fetching userids or usernames etc
"logLevel": "debug", // the log level, keep this to info probably
"channels": ["77829817", "11148817"], // the channels you want to log
"channelConfigs": { // channel specific settings
"77829817": { // only applies to this channel
"messageTypes": [1] // will only log messages of type 1 (check go-twitch-irc MessageType https://github.com/gempir/go-twitch-irc/blob/master/message.go#L17), default is all
}
}
}
```