From 49edfdca66ee13b41659d23f27958e95c5211731 Mon Sep 17 00:00:00 2001
From: Teswa <kozhilya@gmail.com>
Date: Mon, 27 Mar 2023 23:29:08 +0400
Subject: [PATCH] =?UTF-8?q?=D0=A2=D0=B5=D0=BA=D1=81=D1=82=D1=8B?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 JOKES.md                       | 40 ++++++++++++++++++++++++++++++++++
 README.md                      |  5 ++++-
 src/jokes/carnival.ts          |  4 ++--
 src/jokes/humanitarian_hell.ts |  2 +-
 4 files changed, 47 insertions(+), 4 deletions(-)
 create mode 100644 JOKES.md

diff --git a/JOKES.md b/JOKES.md
new file mode 100644
index 0000000..01ebdbb
--- /dev/null
+++ b/JOKES.md
@@ -0,0 +1,40 @@
+# Список реализованых шуток
+
+## `shake` - Форумо-трясение
+Страница форума начинает трястись
+
+Настройки:
+* `chance` - Вероятность срабатывания в процентах (по умолчанию: `1%`)
+* `directions` - Направление тряски (по умолчанию: `['top', 'left', 'bottom', 'left']`)
+* `selector` - Селектор всех элементов, которые будут трястись (по умолчанию: `[id^=pun]`)
+* `interval` - Частота тряски (по умолчанию: `100`)
+* `force` - Сила тряски (по умолчанию: `0.5`)
+
+## `mirror` - Зеркало
+Элементы форума отражаются (по крайней мере, пытаются)
+
+Настройки: 
+* `chance` - Вероятность срабатывания в процентах (по умолчанию: `30%`)
+
+## `carnival` - Карнавал
+Аватарки приобретают интересные цвета
+
+Настройки: 
+* `chance` - Вероятность срабатывания в процентах (по умолчанию: `30%`)
+* `selector` - Селектор всех элементов, которые будут перекрашены (по умолчанию: `img[src*="/avatars/"]`)
+* `variant_chance` - Вероятность применения некоторого фильтра (по умолчанию: `20%`)
+* `variants` - Список фильтров и диапозона случайных параметров
+
+## `humanitarian_hell` - Ад гуманитария
+Все "тся" заменяются на "ться", а все "ться" на "тся"
+
+Настройки: 
+* `chance` - Вероятность срабатывания в процентах (по умолчанию: `20%`)
+* `selector` - Селектор всех элементов, которые будут затронуты: `.post-content`)
+
+## `crazy_letters` - Мама, Я сОшЛа С уМа!
+иМеНа ЗаБоРчИкОм
+
+Настройки: 
+* `chance` - Вероятность срабатывания в процентах (по умолчанию: `20%`)
+* `selector` - Селектор всех элементов, которые будут затронуты: `.pa-author a`)
\ No newline at end of file
diff --git a/README.md b/README.md
index 1d02edf..53d86e6 100644
--- a/README.md
+++ b/README.md
@@ -44,4 +44,7 @@
 В планах:
 * Отключение отдельных шуток для пользователей.
 
-О том, какие шутки определены по умолчанию, смотрите [тут](src/jokes).
\ No newline at end of file
+О том, какие шутки определены по умолчанию, смотрите [на странице со списком их настроек](JOKES.md).
+
+Если же вам интересна их реализация, то ищите её в папке [с их исходным кодом](src/jokes).
+
diff --git a/src/jokes/carnival.ts b/src/jokes/carnival.ts
index 3ebbf06..fd73c97 100644
--- a/src/jokes/carnival.ts
+++ b/src/jokes/carnival.ts
@@ -37,12 +37,12 @@ export class CarnivalJokeSettings implements JokeSettings {
     chance: number = 30;
 
     /**
-     * Селектор всех элементов, которые будут трястись
+     * Селектор всех элементов, которые будут перекрашены
      */
     selector: string = 'img[src*="/avatars/"]';
 
     /**
-     * Вероятность применения фильтра
+     * Вероятность применения некоторого фильтра
      */
     variant_chance: number = 20;
 
diff --git a/src/jokes/humanitarian_hell.ts b/src/jokes/humanitarian_hell.ts
index 977bd2c..93d8e6b 100644
--- a/src/jokes/humanitarian_hell.ts
+++ b/src/jokes/humanitarian_hell.ts
@@ -4,7 +4,7 @@ import $ from "jquery";
 /**
  * **Ад гуманитария**
  * 
- * Все "тся" заменяются на "ться", а все "ться" на "тся".
+ * Все "тся" заменяются на "ться", а все "ться" на "тся"
  * 
  * @author Kozhilya
  */