Skip to content

Latest commit

 

History

History
92 lines (69 loc) · 3.15 KB

README.md

File metadata and controls

92 lines (69 loc) · 3.15 KB
Raw

TwcLazer

Twitcasting recorder and chat exporter

  _______           _
 |__   __|         | |
    | |_      _____| |     __ _ _______ _ __
    | \ \ /\ / / __| |    / _` |_  / _ \ '__|
    | |\ V  V / (__| |___| (_| |/ /  __/ |
    |_| \_/\_/ \___|______\__,_/___\___|_|

    Record Twitcast streams!

    Developed By EF1500 | Holoarchivists
    https://github.com/ef1500 | https://github.com/HoloArchivists



Required Arguments
  -u, --username              Channel to download the stream from

Optional arguments
  -ff, --fileformat FORMAT    filename format for the stream
  -p, --path PATH             Path to download the stream to
  -c, --cookies COOKIES       Path to a cookies file
  -q, --quality [low, best, worst]
  -s, --secret SECRET         Secret word, used to access password-protected streams

Flags
  -nW, --noWarn               Don't display lagspike warning when downloading high bitrate streams
  -nR, --noRetry              Don't try to reconnect if the websocket connection drops
  -pC, --printChat            Print the chat to the terminal
  -wC, --withChat             Export the stream's chat to a file

Misc (Required if --withChat is True)
  -cF, --chatFormat           Override The chat's default formatting
  -gF, --giftFormat           Override The gift's default formatting


Chat Formatting Options

By default, the twitcast chat is recorded in the output file like so:

  Comments:
  <author_screenName>: <message> | <createdAt>

  Gifts:
  <item_name> | <message> | <sender_screenName>

However, you may override this if you so choose. the following is a list of percent arguments to format the chat however you wish:

  Comments:
  %Ag - Author Grade          %Ai - Author ID
  %An - Author Name           %Ap - Author Profile Image
  %As - Author Screen Name    %Ca - Created At
  %Ei - Event ID              %Mg - Message
  %Nc - Comment Number        %Et - Event Type

  Gifts:
  %Ca - Created At            %Ei - Event ID
  %Id - Item Detail Image     %Ie - Item Effect Command
  %Ii - Item Image            %In - Item Name
  %Is - ItemSowsSenderInfo    %Mg - Message
  %Sg - Sender Grade          %Si - Sender ID
  %Sn - Sender Name           %Sp - Sender Profile Image
  %Ss - Sender Screen Name    %Et - Event Type


Filename Formatting Options

By Default, the output file is formatted like so:
Twitcasting-<username>-<year>_<month>_<day>

However, you may override this if you so choose. The following is a list of formatting options you may use:

  %Tt - Title           %Dm - Month
  %Tl - Telop           %Un - Username
  %Mi - Movie ID
  %Dy - Year
  %Dd - Day

Basic Usage

python3 twclazer.py -u <username> TwcLazer will take care of the rest for you.

Note

Downloading at the highest possible bitrate will throw a warning message that reads:

Downloading at the highest possible source may cause visible lagspikes in the video file. Please ensure that your connection can accomodate high-bitrate streaming. To disable this warning, use the --nowarn argument (-nW) or select a lower bitrate source.
You've been warned!

TwcLazer selects the "middle" video quality by default, however you can easily override this with the --quality argument.