diff options
Diffstat (limited to 'docs/emotes')
| -rw-r--r-- | docs/emotes/count.md | 33 | ||||
| -rw-r--r-- | docs/emotes/sim.md | 30 | ||||
| -rw-r--r-- | docs/emotes/top.md | 44 |
3 files changed, 107 insertions, 0 deletions
diff --git a/docs/emotes/count.md b/docs/emotes/count.md new file mode 100644 index 0000000..bd5f850 --- /dev/null +++ b/docs/emotes/count.md @@ -0,0 +1,33 @@ +# Check the usage of emote + +> The only supported emote provider is **7TV** + + +The `!ecount` command is designed to track the number of times an emote has been used in a chat. +This feature allows users to find out how many times a certain emote has been used in messages. +To use the command, you must specify the name of the emote after the command. + +## Syntax + +`!ecount [name]` + ++ `[name]` - The name of the emote. + +## Usage + ++ `!ecount forsenHoppedIn` + +## Responses + ++ `forsenHoppedIn has been used 1337 times` + +## Important notes + ++ Emote information is stored and retrieved from an external +["ilotterytea/stats"](https://stats.ilotterytea.kz) service. ++ Emotes data may be temporarily unavailable if a bot has just joined a chat. + +## Error handling + ++ [Not enough arguments](/wiki/errors#0) ++ [External API error](/wiki/errors#20) diff --git a/docs/emotes/sim.md b/docs/emotes/sim.md new file mode 100644 index 0000000..1064d4a --- /dev/null +++ b/docs/emotes/sim.md @@ -0,0 +1,30 @@ +# Emote set similarity check + + +> The only supported emote provider is **7TV** + + +The `!esim` command provides the ability to compare two emote sets and determine the similarity between them. +This is a useful tool for analyzing the similarity of emotes in different chat rooms. + +## Syntax + +`!esim [origin channel] [target channel]` + ++ `[target channel]` - parameter representing the target channel to be compared. ++ `[origin channel]` (optional) - parameter representing the origin channel to be compared. +If not specified, the channel from which the command was sent is used. + +## Usage + ++ `!esim forsen` ++ `!esim forsen xqc` + +## Responses ++ `...'s emote set is 95% similar to forsen's emote set (570 of 600).` ++ `forsen's emote set is not similar to xqc's emote set.` + +## Error handling + ++ [Not enough arguments](/wiki/errors#0) ++ [Not found](/wiki/errors#12) diff --git a/docs/emotes/top.md b/docs/emotes/top.md new file mode 100644 index 0000000..d36a0ae --- /dev/null +++ b/docs/emotes/top.md @@ -0,0 +1,44 @@ +# Emote usage leaderboard + +> The only supported emote provider is **7TV** + + +The `!etop` command provides the ability to find out the top emotes by usage in a specified chat room. +This is a useful tool for those who want to keep track of the popularity and frequency of use of specific emotes in the community. + + +## Syntax + +`!etop [desc/asc] [channel name] [amount]` + ++ `[desc/asc]` (optional) - Parameter to control sorting of emotes. +The default setting is **desc** *(descending)*. ++ `[channel name]` (optional) - Parameter to specify a specific channel. +By default, the name of the channel from which the command was sent is used. ++ `[amount]` (optional) - Parameter to set the number of emotes in the result list. +The default setting is 10, the maximum value is 50. + +## Usage + ++ `!etop` - Shows the top 10 emotes in descending order in the current channel. ++ `!etop asc` - Shows the top 10 emotes in ascending order in the current channel. ++ `!etop forsen` - Shows the top 10 emotes in descending order in forsen's channel. ++ `!etop asc forsen 10` - Shows the top 20 emotes in ascending order in forsen's channel. ++ `!etop asc 20` - Shows the top 20 emotes in ascending order in the current channel. + +## Responses + ++ `forsen's top 10 emotes (descending): forsenHoppedIn (750), FailFors (600), forsenGravity (599), ...` ++ `forsen's top 10 emotes (ascending): forsenMushroom (1), forsenDank (5), forsenPirate (60), ...` + +## Important notes + ++ Emote information is stored and retrieved from an external +["ilotterytea/stats"](https://stats.ilotterytea.kz) service. ++ Emotes data may be temporarily unavailable if a bot has just joined a chat. + +## Error handling + ++ [Not found](/wiki/errors#12) ++ [External API error](/wiki/errors#20) ++ [Something went wrong](/wiki/errors#127) |
