Обновление README.md
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
# Бибилотека первоапрельских розыгрышей для форумов MyBB
|
||||
# Библиотека первоапрельских розыгрышей для форумов MyBB
|
||||
|
||||
Базовое использование:
|
||||
|
||||
@@ -26,6 +26,8 @@
|
||||
- `letter_chaos` — **Буквенный хаос**. Все буквы в словах, кроме первой и последней, перемешены.
|
||||
- `cursor` — **Красивые курсоры**. Эффекты, следующие за курсором.
|
||||
- `stupid_title` — **Глупые статусы**. Каждому пользователю даётся новый глупый статус.
|
||||
- `inverted_scroll` — **Обратная гравитация**. Скролл в обратную сторону.
|
||||
- `latinization` — **Латинизация**. Все символы на странице или только в постах или еще где-то местами - латиницей вместо кириллицы и наоборот
|
||||
|
||||
---
|
||||
|
||||
@@ -48,9 +50,9 @@ window.AprilJokes.settings = {
|
||||
## Настройка шуток
|
||||
|
||||
Настройка шуток происходит при присвоении объекта `window.AprilJokes.settings`.
|
||||
Это присвоедние должно произойти **после** загрузки скрипта.
|
||||
Это присвоение должно произойти **после** загрузки скрипта.
|
||||
|
||||
Для всех шуток определны 2 общих поля:
|
||||
Для всех шуток определены 2 общих поля:
|
||||
|
||||
```js
|
||||
window.AprilJokes.settings = {
|
||||
@@ -75,7 +77,7 @@ window.AprilJokes.settings = {
|
||||
};
|
||||
```
|
||||
|
||||
Полный список настроек с объяснениями вы можете посмотреть в файле [`settings.example.js`](./settings.example.js). Также представлен файл [`settings.compact.js`](./settings.compact.js), который также содержит все настройки, но без коментариев.
|
||||
Полный список настроек с объяснениями вы можете посмотреть в файле [`settings.example.js`](./settings.example.js). Также представлен файл [`settings.compact.js`](./settings.compact.js), который также содержит все настройки, но без комментариев.
|
||||
|
||||
При этом, объективно, вставлять весь этот код в HTML-начало может быть "немного" неудобно, поэтому вы можете скачать код (кнопка "Raw" над файлом), изменить его, и загрузить в файлы форума, подключив скрипт таким образом:
|
||||
|
||||
@@ -88,7 +90,7 @@ window.AprilJokes.settings = {
|
||||
|
||||
Заметьте, что во всех примерах приведены значения настроек по умолчанию. Вы _можете_ удалять строки, значения по умолчанию которых вас устраивают.
|
||||
|
||||
Если вас интерсует только несколько шуток, вы можете использовать метод `disableAll()`, что бы выключить выполнение всех шуток, а потом включать отдельные шутки через установку настройки `enabled`:
|
||||
Если вас интересует только несколько шуток, вы можете использовать метод `disableAll()`, что бы выключить выполнение всех шуток, а потом включать отдельные шутки через установку настройки `enabled`:
|
||||
|
||||
```js
|
||||
window.AprilJokes.disableAll();
|
||||
@@ -127,7 +129,7 @@ window.AprilJokes.settings = {
|
||||
window.AprilJokes.start("mirror", true);
|
||||
```
|
||||
|
||||
Так же можете [посмотреть](./src/jokes/mirror.ts#L16) на метод `MirrorJoke.start`, что бы узнать как именно проиходит отражение.
|
||||
Так же можете [посмотреть](./src/jokes/mirror.ts#L16) на метод `MirrorJoke.start`, что бы узнать как именно происходит отражение.
|
||||
|
||||
---
|
||||
|
||||
@@ -147,9 +149,9 @@ window.AprilJokes.jokes.cursor.disableAll();
|
||||
|
||||
### Настройка `stupid_title` (Глупые статусы)
|
||||
|
||||
> **Важно**: этот блок может быть чрезвычайно капризым из-за особенностей хранения данных, особенно блок `variants`. Изменяя его, строго следуйте этой инструкции, иначе скрипт может перестать работать ожидаемым образом.
|
||||
> **Важно**: этот блок может быть чрезвычайно капризным из-за особенностей хранения данных, особенно блок `variants`. Изменяя его, строго следуйте этой инструкции, иначе скрипт может перестать работать ожидаемым образом.
|
||||
|
||||
Данная шутка генерирет статус из случайных слов. За счёт использования псевдослучайного генератора, хеширования и привязки к времени UTC, ожидается что все пользователи одновременно будут видеть один и тот же статус для каждого пользователя, при этом он меняется каждые `change_frequency` минут. Установите это значение равным `0`, что бы статус генерировался при каждом обновлении страницы.
|
||||
Данная шутка генерирует статус из случайных слов. За счёт использования псевдослучайного генератора, хеширования и привязки к времени UTC, ожидается что все пользователи одновременно будут видеть один и тот же статус для каждого пользователя, при этом он меняется каждые `change_frequency` минут. Установите это значение равным `0`, что бы статус генерировался при каждом обновлении страницы.
|
||||
|
||||
Для настройки списка слов используется функция `BuildStupdiTitleVariant`, которая преобразует список слов во внутренний формат скрипта. Настоятельно рекомендуется использовать именно её, а не записывать параметры напрямую:
|
||||
|
||||
@@ -178,12 +180,12 @@ window.AprilJokes.settings = {
|
||||
|
||||
Обратите внимание на конструкции вида `{ ...something }` — эта конструкция позволяет перенести все поля нескольких старых объектов в один новый. При этом, если в двух объединяемых объектах есть совпадающие значения, то будет сохранено последнее.
|
||||
|
||||
Говоря проще: добовляйте ваши настройки _после_ строки вида `...window.AprilJokes.settings.stupid_title.variants.adj`, что бы ваши настройки не были перезаписаны.
|
||||
Говоря проще: добавляйте ваши настройки _после_ строки вида `...window.AprilJokes.settings.stupid_title.variants.adj`, что бы ваши настройки не были перезаписаны.
|
||||
|
||||
Метод `BuildStupdiTitleVariant` принимает 2 аргумента:
|
||||
|
||||
- `gender` — определённый род для генерации. Используйте `true` для мужского рода, `false` для женского и `null`, если добавляемые варианты могут использоваться в обоих случаях.
|
||||
- `words` — строка, со списоком вариантов через запятую. В качестве вариантов могут быть слова из русских или английских букв, пробелов или дефисов, то есть можно использовать `"..., почему-то и зачем-то , ..."` и `почему-то и зачем-то` будет воспринят как один вариант. Также варианты можно модифицировать, добавив один или несколько модификаторов:
|
||||
- `words` — строка, со списком вариантов через запятую. В качестве вариантов могут быть слова из русских или английских букв, пробелов или дефисов, то есть можно использовать `"..., почему-то и зачем-то , ..."` и `почему-то и зачем-то` будет воспринят как один вариант. Также варианты можно модифицировать, добавив один или несколько модификаторов:
|
||||
- `!` отключает использование слова. Этим модификатором можно отключать слова из списка по умолчанию (см `!грубый` в примере выше).
|
||||
- `%` помечает слово как редкое. Шанс его использования понижается в 2 раза.
|
||||
- `^` помечает слово как частое. Шанс его использования повышается в 2 раза.
|
||||
|
||||
Reference in New Issue
Block a user