summaryrefslogtreecommitdiff
path: root/docs/emotes/sim.md
diff options
context:
space:
mode:
authorilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
committerilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
commitecca9314a53b961f49ae57528e30a3a17f5300dc (patch)
treef99110ad90b9798b873c1c9ea4fdfba7aa45c34d /docs/emotes/sim.md
parent21991b1da2bfab5aa266e7ba91527a6ee62a6b99 (diff)
feat: docs
Diffstat (limited to 'docs/emotes/sim.md')
-rw-r--r--docs/emotes/sim.md30
1 files changed, 30 insertions, 0 deletions
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)