docs: Update custom commands and add version for docs

sogebot · Sep 6, 2018 · 552231c · 552231c
1 parent 728006d
commit 552231c
Show file tree

Hide file tree

Showing 46 changed files with 1,943 additions and 3 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -1,4 +1,6 @@
 {
     "MD041": false,
-    "MD002": false
+    "MD002": false,
+    "MD033": false,
+    "MD024": false
 }
diff --git a/docs/8.1.x/.nojekyll b/docs/8.1.x/.nojekyll
diff --git a/docs/8.1.x/README.md b/docs/8.1.x/README.md
@@ -0,0 +1,94 @@
+# SogeBot
+[![Discord](https://img.shields.io/discord/317348946144002050.svg?style=flat-square)](https://discordapp.com/invite/52KpmuH)
+[![Build Status](https://img.shields.io/travis/sogehige/sogeBot.svg?style=flat-square)](https://travis-ci.org/sogehige/sogeBot)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)
+[![GitHub release](https://img.shields.io/github/release/sogehige/sogebot.svg?style=flat-square)](https://github.com/sogehige/sogeBot/releases)
+[![Downloads](https://img.shields.io/github/downloads/sogehige/sogebot/total.svg?style=flat-square)](https://github.com/sogehige/sogeBot/releases)
+[![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg?style=flat-square)](https://www.paypal.me/sogetwitch/5eur)
+[![Greenkeeper badge](https://badges.greenkeeper.io/sogehige/sogeBot.svg)](https://greenkeeper.io/)
+
+Free Twitch Bot built on Node.js
+
+#### Important links
+
+- **DISCORD**: https://discordapp.com/invite/52KpmuH
+- **GITHUB**: https://github.com/sogehige/sogeBot
+- **DOCS**: http://sogehige.github.io/sogeBot/
+- **ISSUES**: https://github.com/sogehige/sogeBot/issues
+- **RELEASES**: https://github.com/sogehige/sogeBot/releases
+- **IDEAS & SUGGESTIONS**: https://ideas.sogehige.tv/ or http://sogebot.fider.io
+
+#### Screenshots
+<img src="https://drive.google.com/uc?id=1yaD6hiHQ8CuZ1konVSK_Iy_7Dbb3-WQC" width="200"> <img src="https://drive.google.com/uc?id=1j0immtX6yutNcNGErHDSwjtqDz2AGfLS" width="200"> <img src="https://drive.google.com/uc?id=1Nshe2MqYpd3fzNyCXmbWDJmR61_RWpVE" width="200"> <img src="https://drive.google.com/uc?id=1mPg3wkFdP_F3jVV5eYenf1CiCenvuU-P" width="200"> <img src="https://drive.google.com/uc?id=1k7vyakPrKid73rGx7qfJcxzBUGcxl8dS" width="200"> <img src="https://drive.google.com/uc?id=1AAZMLew__TkpiQ_QbRZPxV-r9p_So7vG" width="200"> <img src="https://drive.google.com/uc?id=1jcS7GDld7gaMqDYbdGqM8wOqWEpP7Jfo" width="200">
+
+#### Issues
+If you found an issue with a bot, feel free to create issue at https://github.com/sogehige/SogeBot/issues.
+You can also contact me on my email sogehige@gmail.com or get support on our [discord server](https://discordapp.com/invite/52KpmuH).
+
+| System             | Description                                                                                                                              |
+|--------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| Alias              | Don't like default commands? Make an alias!                                                                                              |
+| Keywords           | Bot will respond on certain keywords                                                                                                     |
+| Points / Loyalty   | Points system for your users                                                                                                             |
+| Price              | Make viewers to spend points on e.g. !songrequest                                                                                        |
+| Ranks              | Create ranks for your viewers                                                                                                            |
+| Custom commands    | Create custom commands, call custom APIs, set custom variables                                                                           |
+| Timers             | Post a response every x seconds, x messages                                                                                              |
+| Queue              | Do you lost track of viewers who wants to play with you? Use !queue and be fair!                                                         |
+| Raffles            | Create raffles for you giveaways!                                                                                                        |
+| Songs              | **Songrequest** and **playlist** support for YouTube with **trimming** of videos and **auto volume normalization**                       |
+| Cooldowns          | Stop spamming of commands with cooldowns!                                                                                                |
+| Permissions        | Set your custom permissions for your commands! (owner, mods, regular, viewer)                                                            |
+| Moderation         | Automoderate links, colors, symbols, blacklist and more!                                                                                 |
+| Twitch             | Be able to change your game and title from webpanel and much more! !uptime, !lastseen, etc.                                              |
+| Webpanel and Stats | Bot is tracking your twitch **stats** and bot **webpanel** is user friendly and full of features!                                        |
+|                    | Many widgets for your dashboard: customizable soundboard (/public/dist/soundboard/), follower list, twitch monitor, bets, songs and more |
+|                    | Be able to set your !title and !game from dashboard and **save** them for further use! Use custom variables in titles                    |
+| Overlay            | Use various overlays in your OBS or XSplit                                                                                               |
+| PhillipsHue        | Blink your lights on follower or any other event                                                                                         |
+| Events             | On numerous events run commands, send messages, do whatever!                                                                             |
+| Chat Games         | bets, heists, duels, wheel of fortune                                                                                                    |
+| Integrations       | **Streamlabs**, DonationAlerts.ru, Twitter                                                                                               |
+
+| Game             | Description                                    |
+|------------------|------------------------------------------------|
+| Bets             |                                                |
+| Gambling         | !seppuku, !roulette commands                   |
+| Duel             | !duel - bet your points, only one can win      |
+| Heists           | !bankheist                                     |
+| Wheel Of Fortune | !wof                                           |
+
+| Overlay          | Description                                                           |
+|------------------|-----------------------------------------------------------------------|
+| Emotes           | Show chat message emotes in your stream!                              |
+| Stats            | Show viewers, follower, uptime                                        |
+| ImageCarousel    | Simple image fadeIn/fadeOut carousel                                  |
+| Alerts           | Show images, play audio/video and **replays** or **clips** in overlay |
+| Credits          | End credits like in a movie                                           |
+| Text             | Show text and variables ($currentSong etc.)                           |
+| Eventlist        | Show last events                                                      |
+| Wheel Of Fortune | Show wheel of fortune spin                                            |
+| Bets             | Show current bet                                                      |
+
+#### Languages
+
+* Cestina
+* English
+
+#### Documentation
+http://sogehige.github.io/sogeBot/#/
+
+#### FAQ
+http://sogehige.github.io/sogeBot/#/faq
+
+#### License
+
+See LICENSE file
+
+#### Special thanks
+
+Special thanks goes to team behing tmi.js (you can check it on https://www.tmijs.org/) and twitch-js (https://github.com/marcandrews/twitch-js). They did really awesome job.
+
+#### Support [![Donate](https://img.shields.io/badge/paypal-donate-yellow.svg?style=flat-square)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9ZTX5DS2XB5EN)
+
+If you want to support me, you can click a PayPal link above or you can contribute and we can create something great!
diff --git a/docs/8.1.x/_sidebar.md b/docs/8.1.x/_sidebar.md
@@ -0,0 +1,46 @@
+* [Home](8.1.x/)
+* [Install and upgrade](8.1.x/install-and-upgrade.md)
+* [FAQ](8.1.x/faq.md)
+* Configuration
+  * [Timezone](8.1.x/configuration/timezone.md)
+  * [CPU](8.1.x/configuration/cpu.md)
+  * [Panel](8.1.x/configuration/panel.md)
+  * [Database](8.1.x/configuration/database.md)
+  * [ClientId](8.1.x/configuration/clientid.md)
+  * [Color](8.1.x/configuration/color.md)
+  * [Metrics](8.1.x/configuration/metrics.md)
+* Systems
+  * [Alias](8.1.x/commands/alias.md)
+  * [Commercial](8.1.x/commands/commercial.md)
+  * [Permissions](8.1.x/commands/permissions.md)
+  * [Custom Commands](8.1.x/commands/custom-commands.md)
+  * [Cooldowns](8.1.x/commands/cooldowns.md)
+  * [Keywords](8.1.x/commands/keywords.md)
+  * [Moderation](8.1.x/commands/moderation.md)
+  * [Timers](8.1.x/commands/timers.md)
+  * [Points](8.1.x/commands/points.md)
+  * [Price](8.1.x/commands/price.md)
+  * [Songs](8.1.x/commands/songs.md)
+  * [Ranks](8.1.x/commands/ranks.md)
+  * [Raffles](8.1.x/commands/raffles.md)
+  * [Queue](8.1.x/commands/queue.md)
+  * [Highlights](8.1.x/commands/highlights.md)
+  * [Gambling](8.1.x/commands/gambling.md)
+  * [Quotes](8.1.x/commands/quotes.md)
+  * [Miscellaneous](8.1.x/commands/miscellaneous.md)
+* Games
+  * [Bets](8.1.x/games/bets.md)
+* [Response Filters](8.1.x/filters/all.md)
+* Overlays
+  * [Themes](8.1.x/overlays/themes.md)
+  * [Eventlist](8.1.x/overlays/eventlist.md)
+* How To
+  * [Phillips Hue](8.1.x/howto/phillipshue.md)
+  * [Eval snippets](8.1.x/howto/eval.md)
+  * [Write own system](8.1.x/howto/write-own-system.md)
+* Integrations
+  * [Twitter](8.1.x/integrations/twitter.md)
+  * [Spotify](8.1.x/integrations/spotify.md)
+* Tools
+  * [Users cleanup](8.1.x/tools/users-cleanup.md)
+  * [Migration NeDB->MongoDB](8.1.x/tools/migration-nedb-mongodb.md)
diff --git a/docs/8.1.x/commands/alias.md b/docs/8.1.x/commands/alias.md
@@ -0,0 +1,126 @@
+##### Changelog
+| Version | Description                           |
+| --------|:--------------------------------------|
+| 8.0.0   | Updated docs                          |
+
+
+## Add a new alias
+`!alias add <permission> <!alias> <!command>`
+
+!> Default permission is **OWNER**
+
+### Parameters
+- `<permission>` -  possible values: owner, mod, regular, viewer
+- `<!alias>` - alias to be added
+- `<!command>` - command to be aliased
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong> !alias add viewer !uec !points <br>
+  <strong>bot:</strong> @testuser, alias !uec for !points was added
+</blockquote>
+
+## Edit an alias
+`!alias edit <permission> <!alias> <!command>`
+
+!> Default permission is **OWNER**
+
+### Parameters
+- `<permission>` -  possible values: owner, mod, regular, viewer
+- `<!alias>` - alias to be edited
+- `<!command>` - command to be aliased
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong> !alias edit viewer !uec !me <br>
+  <strong>bot:</strong> @testuser, alias !uec is changed to !me
+</blockquote>
+
+<blockquote style="border-left-color: #f66">
+  <strong>testuser:</strong> !alias edit viewer !nonexisting !points <br>
+  <strong>bot:</strong> @testuser, alias !nonexisting was not found in database
+</blockquote>
+
+## Remove an alias
+`!alias remove <!alias>`
+
+!> Default permission is **OWNER**
+
+### Parameters
+- `<!alias>` - alias to be removed
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong>!alias remove !uec <br>
+  <strong>bot:</strong> @testuser, alias !uec2 was removed
+</blockquote>
+
+<blockquote style="border-left-color: #f66">
+  <strong>testuser:</strong> !alias remove !ueca <br>
+  <strong>bot:</strong> @testuser, alias !ueca was not found in database
+</blockquote>
+
+## List of aliases
+`!alias list`
+
+!> Default permission is **OWNER**
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong>!alias list <br>
+  <strong>bot:</strong> @testuser, list of aliases: !uec
+</blockquote>
+
+## Enable or disable alias
+`!alias toggle <!alias>`
+
+!> Default permission is **OWNER**
+
+### Parameters
+- `<!alias>` - alias to be enabled or disabled
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong>!alias toggle !uec <br>
+  <strong>bot:</strong> @testuser, alias !uec was disabled
+</blockquote>
+
+<blockquote>
+  <strong>testuser:</strong>!alias toggle !uec <br>
+  <strong>bot:</strong> @testuser, alias !uec was enabled
+</blockquote>
+
+## Toggle visibility of alias in lists
+`!alias toggle-visibility <!alias>`
+
+!> Default permission is **OWNER**
+
+### Parameters
+- `<!alias>` - alias to be exposed or concealed
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong>!alias toggle !uec <br>
+  <strong>bot:</strong> @testuser, alias !uec was concealed
+</blockquote>
+
+<blockquote>
+  <strong>testuser:</strong>!alias toggle !uec <br>
+  <strong>bot:</strong> @testuser, alias !uec was exposed
+</blockquote>
+
+
+
+
+## Other settings
+### Enable or disable alias system
+`!enable system alias` |
+`!disable system alias`
+
+!> Default permission is **OWNER**
diff --git a/docs/8.1.x/commands/commercial.md b/docs/8.1.x/commands/commercial.md
@@ -0,0 +1,32 @@
+##### Changelog
+| Version | Description                           |
+| --------|:--------------------------------------|
+| 8.0.0   | Updated docs                          |
+
+
+## Run a commercial
+`!commercial <seconds>`
+
+!> Default permission is **OWNER**
+
+### Parameters
+- `<seconds>` -  length of commercial break, valid values are 30, 60, 90, 120, 150, 180
+
+### Examples
+
+<blockquote>
+  <strong>testuser:</strong> !commercial 30 <br>
+  <em>... no response on success ...</em>
+</blockquote>
+
+<blockquote style="border-left-color: #f66">
+  <strong>testuser:</strong> !commercial 10 <br>
+  <strong>bot:</strong> @testuser, available commercial duration are: 30, 60, 90, 120, 150 and 180
+</blockquote>
+
+## Other settings
+### Enable or disable commercial system
+`!enable system commercial` |
+`!disable system commercial`
+
+!> Default permission is **OWNER**
diff --git a/docs/8.1.x/commands/cooldowns.md b/docs/8.1.x/commands/cooldowns.md
@@ -0,0 +1,8 @@
+## Cooldowns system
+`!cooldown <!command|keyword> <global|user> <seconds> <true|false>` - **OWNER** - set cooldown for command or keyword (per user or global), true/false sets whisper message, if you want to unset, set 0 seconds
+
+`!cooldown toggle moderators <keyword|!command> <global|user>` - **OWNER** - enable/disable specified keyword or !command cooldown for moderators
+
+`!cooldown toggle owners <keyword|!command> <global|user>` - **OWNER** - enable/disable specified keyword or !command cooldown for owners
+
+`!cooldown toggle enabled <keyword|!command> <global|user>` - **OWNER** - enable/disable specified keyword or !command cooldown