examples

README

Examples library

This is a supplementary repo to the main unofficial documentation. This one contains only captured payloads for various services.

Table of contents

• IRC
  • USERNOTICE
    • Announcement
  • PRIVMSG
• Pubsub
  • Chat moderator actions
  • Whispers
• Data format
  • Syntax for examples

Contributing

If you want to contribute, please follow the Data format rules. You can create a pull request or send a patch to mm2pl+patches＠kotmisia.pl (encoded with a Unicode at symbol so I don't get spam)

Documentation

Index

• func ExamplesIrcPrivmsg() []string
• func ExamplesIrcUsernoticeAnnouncement() []string
• func ExamplesPubsubChatModeratorActions() []string
• func ExamplesPubsubWhispers() []string
• func IrcPrivmsgConfusingRendering() string
• func IrcPrivmsgDisplayNameSpace() string
• func IrcPrivmsgFirstMsg() string
• func IrcPrivmsgTypicalMessage() string
• func IrcUsernoticeAnnouncementAnnounce() string
• func IrcUsernoticeAnnouncementAnnounceBlue() string
• func IrcUsernoticeAnnouncementAnnounceGreen() string
• func IrcUsernoticeAnnouncementAnnounceOrange() string
• func IrcUsernoticeAnnouncementAnnouncePurple() string
• func IrcUsernoticeAnnouncementIRCAnnounce() string
• func PubsubChatModeratorActionsUserBanned() string
• func PubsubWhispersReceived() string
• func PubsubWhispersReceivedWithEmotes() string
• func PubsubWhispersSent() string
• func PubsubWhispersSentWithEmotes() string
• func PubsubWhispersThreadUpdate() string
• func RandomIrcPrivmsg() string
• func RandomIrcUsernoticeAnnouncement() string
• func RandomPubsubChatModeratorActions() string
• func RandomPubsubWhispers() string
• type Example
  • func ReadFile(file *os.File) ([]Example, error)

Functions

func ExamplesIrcPrivmsg

func ExamplesIrcPrivmsg() []string

ExamplesIrcPrivmsg returns all examples from IRC -> PRIVMSG

func ExamplesIrcUsernoticeAnnouncement

func ExamplesIrcUsernoticeAnnouncement() []string

ExamplesIrcUsernoticeAnnouncement returns all examples from IRC -> USERNOTICE -> Announcement

func ExamplesPubsubChatModeratorActions

func ExamplesPubsubChatModeratorActions() []string

ExamplesPubsubChatModeratorActions returns all examples from Pubsub -> Chat moderator actions

func ExamplesPubsubWhispers

func ExamplesPubsubWhispers() []string

ExamplesPubsubWhispers returns all examples from Pubsub -> Whispers

func IrcPrivmsgConfusingRendering

func IrcPrivmsgConfusingRendering() string

IrcPrivmsgConfusingRendering returns a message that was rendered incorrectly by Chatterino

func IrcPrivmsgDisplayNameSpace

func IrcPrivmsgDisplayNameSpace() string

IrcPrivmsgDisplayNameSpace returns a message sent by someone with strange display name which has a space at the end

func IrcPrivmsgFirstMsg

func IrcPrivmsgFirstMsg() string

IrcPrivmsgFirstMsg returns a message with the `@first-msg=1` tag (2021-06-11)

func IrcPrivmsgTypicalMessage

func IrcPrivmsgTypicalMessage() string

IrcPrivmsgTypicalMessage returns a message with just text (2022-04-16)

func IrcUsernoticeAnnouncementAnnounce

func IrcUsernoticeAnnouncementAnnounce() string

IrcUsernoticeAnnouncementAnnounce returns a /announce from web chat (2022-04-01)

func IrcUsernoticeAnnouncementAnnounceBlue

func IrcUsernoticeAnnouncementAnnounceBlue() string

IrcUsernoticeAnnouncementAnnounceBlue returns a /announceblue from web chat (2022-04-01)

func IrcUsernoticeAnnouncementAnnounceGreen

func IrcUsernoticeAnnouncementAnnounceGreen() string

IrcUsernoticeAnnouncementAnnounceGreen returns a /announcegreen from web chat (2022-04-02)

func IrcUsernoticeAnnouncementAnnounceOrange

func IrcUsernoticeAnnouncementAnnounceOrange() string

IrcUsernoticeAnnouncementAnnounceOrange returns a /announceorange from web chat (2022-04-02)

func IrcUsernoticeAnnouncementAnnouncePurple

func IrcUsernoticeAnnouncementAnnouncePurple() string

IrcUsernoticeAnnouncementAnnouncePurple returns a /announcepurple from web chat (2022-04-02)

func IrcUsernoticeAnnouncementIRCAnnounce

func IrcUsernoticeAnnouncementIRCAnnounce() string

IrcUsernoticeAnnouncementIRCAnnounce returns a /announce from IRC (2022-04-02)

func PubsubChatModeratorActionsUserBanned

func PubsubChatModeratorActionsUserBanned() string

PubsubChatModeratorActionsUserBanned returns a message notifying of user `1xcelerate` (ID: `140114344`) getting permabanned from `#mm2pl` by `mm2pl` (ID: `117691339`) (2021-11-20)

func PubsubWhispersReceived

func PubsubWhispersReceived() string

PubsubWhispersReceived returns a whisper received from `Mm_sUtilityBot`

func PubsubWhispersReceivedWithEmotes

func PubsubWhispersReceivedWithEmotes() string

PubsubWhispersReceivedWithEmotes returns a whisper received from `Mm_sUtilityBot` with an emote inside

func PubsubWhispersSent

func PubsubWhispersSent() string

PubsubWhispersSent returns a whisper getting sent from `Mm2PL` to `Mm_sUtilityBot`

func PubsubWhispersSentWithEmotes

func PubsubWhispersSentWithEmotes() string

PubsubWhispersSentWithEmotes returns a whisper sent from `Mm2PL` to `Mm_sUtilityBot` with an emote inside

func PubsubWhispersThreadUpdate

func PubsubWhispersThreadUpdate() string

PubsubWhispersThreadUpdate returns a thread getting marked as read?

func RandomIrcPrivmsg

func RandomIrcPrivmsg() string

RandomIrcPrivmsg returns a random example from IRC -> PRIVMSG

func RandomIrcUsernoticeAnnouncement

func RandomIrcUsernoticeAnnouncement() string

RandomIrcUsernoticeAnnouncement returns a random example from IRC -> USERNOTICE -> Announcement

func RandomPubsubChatModeratorActions

func RandomPubsubChatModeratorActions() string

RandomPubsubChatModeratorActions returns a random example from Pubsub -> Chat moderator actions

func RandomPubsubWhispers

func RandomPubsubWhispers() string

RandomPubsubWhispers returns a random example from Pubsub -> Whispers

Types

type Example

type Example struct {
	// headers which lead to this example
	Path []string `json:"path"`
	// after -
	Name string `json:"name"`
	// after :
	Comment string `json:"comment"`
	// content of code fence
	Data string `json:"data"`
}

func ReadFile

func ReadFile(file *os.File) ([]Example, error)