Skip to content

README.md

Latest commit

 

History

History
74 lines (58 loc) · 2.13 KB

README.md

File metadata and controls

74 lines (58 loc) · 2.13 KB

cupcake

Cytube chat recorder for daiseihai.

Downloads

Pre-built binaries are available on the releases page for the following platforms:

Operating system Architectures
Linux (glibc) ARM64 ARMv7 x86-64
macOS ARM64 x86-64
Windows ARM64 x86-64

Latest development builds are also available as build artifacts on the actions page if you are logged into GitHub.

Usage

cupcake [OPTIONS] <DOMAIN> <CHANNEL>

For full usage instructions, run cupcake --help.

Docker

cupcake is also available as a Docker image.

Example Docker Compose manifest:

version: '3.7'
services:
  cupcake:
    container_name: cupcake
    image: ghcr.io/hamuko/cupcake:latest
    command: cytu.be xxxx
    volumes:
      - /path/to/cupcake/dir:/cupcake
    restart: on-failure

Filtering messages

Cytube sends all chat messages, including ones from shadow-banned users, to anonymous connections. This can be prevented by logging in as a guest user using the --guest-login option with a unique, non-registered username. This also means that cupcake is visible in the channel's member list as a guest.

Limitations

cupcake currently only supports Cytube servers that use Engine.IO version 4. However, all cup-related servers should be already using Engine.IO version 4, so this should not be an issue.