Skip to content

thedrhax-dockerfiles/spaghetti-logger

 
 

Repository files navigation

Spaghetti Logger

Spaghetti Logger is a Twitch.tv chat logger.

Fake Spaghetti Logger is a Beam.pro chat logger. See README.beam.md for instructions for Beam.

Docker

Build container image manually:

    docker build -f docker/Dockerfile -t thedrhax/spaghetti-logger .

... or pull it from Docker Hub:

    docker pull thedrhax/spaghetti-logger

Now you can start spaghetti-logger using this command:

    docker run -d -v logs:/logs -e CHANNELS="channel1 channel2" \
               thedrhax/spaghetti-logger --host HOST --port PORT

Quick Start

Requires

You can install the required Python libraries using Pip. Assuming Linux system:

    pip3 install irc

Add the --user option to not use sudo.

Then run

    python3 spaghettilogger.py CHANNELS_FILE LOGGING_DIR
  • where CHANNELS_FILE is the filename of a text file containing IRC channel names one per line (include the # symbol)
  • and LOGGING_DIR is the directory name of logs to be placed.

Operation

The logger will place logs under directories for each channel and log to files named by date. It will reconnect automatically.

The logger will check the channels file for modification every 30 seconds. It will join and part the channels as needed.

The logger will log the following

  • PRIVMSG with tags
  • NOTICE
  • JOIN
  • PART
  • MOD
  • CLEARCHAT
  • USERNOTICE

For group chats, the logger needs to be logged in. Check https://chatdepot.twitch.tv/room_memberships?oauth_token=OAUTH_TOKEN_HERE for IP addresses and channel name. Use --nickname and --oauth-path OAUTH_FILENAME where OAUTH_FILENAME is a text file containing your oauth token.

For details of the IRC protocol, see https://dev.twitch.tv/docs/v5/guides/irc/ .

In the event the IRC address changes, use --host option when running the logger.

Credits

Copyright 2015-2018 Christopher Foo. License: GPLv3

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.3%
  • Dockerfile 1.1%
  • Shell 0.6%