From 9b4b3f44007c4aa4f4fc4840d440f0896f234c4b Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:06:41 +0300 Subject: [PATCH 1/8] fix(config.ts): update sidebar structure --- docs/.vitepress/config.ts | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index bebb6b0..6063238 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -150,7 +150,7 @@ export default defineConfig({ // { text: "Getting Started", link: "/getting-started" }, // ], // }, - // Twitch + // Twitch - EN { text: 'Twitch', collapsed: false, @@ -201,7 +201,7 @@ export default defineConfig({ } ] }, - // Discord + // Discord - EN { text: 'Discord', collapsed: false, @@ -211,7 +211,10 @@ export default defineConfig({ link: '/discord-bot/getting-started' }, { text: 'Commands', link: '/discord-bot/commands' }, - // { text: "Custom Commands", link: "/discord-bot/custom-commands" }, + { + text: 'Custom Commands', + link: '/discord-bot/custom-commands' + }, { text: 'Modules', collapsed: true, @@ -223,12 +226,12 @@ export default defineConfig({ { text: 'Live Stream Events', link: '/discord-bot/live-stream-events' + }, + { + text: 'Custom API System', + link: '/discord-bot/custom-api-system' } // { - // text: "Custom API System", - // link: "/discord-bot/custom-api-system", - // }, - // { // text: "Reminder System", // link: "/discord-bot/reminder-system", // }, @@ -332,10 +335,10 @@ export default defineConfig({ link: '/tr/discord-bot/getting-started' }, { text: 'Komutlar', link: '/tr/discord-bot/commands' }, - // { - // text: "Özel Komutlar", - // link: "/tr/discord-bot/custom-commands", - // }, + { + text: 'Özel Komutlar', + link: '/tr/discord-bot/custom-commands' + }, { text: 'Modüller', collapsed: true, @@ -347,12 +350,12 @@ export default defineConfig({ { text: 'Canlı Yayın Etkinlikleri', link: '/tr/discord-bot/live-stream-events' + }, + { + text: 'Custom API Sistemi', + link: '/tr/discord-bot/custom-api-system' } // { - // text: "Custom API Sistemi", - // link: "/tr/discord-bot/custom-api-system", - // }, - // { // text: "Hatırlatıcı Sistemi", // link: "/tr/discord-bot/reminder-system", // }, From 233144be70943e2824d72384fca141f3cac8628e Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:10:28 +0300 Subject: [PATCH 2/8] fix(discord-bot): update custom api system button badge, remove purge, --- docs/discord-bot/commands.md | 8 ++++---- docs/tr/discord-bot/commands.md | 15 ++++++--------- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/discord-bot/commands.md b/docs/discord-bot/commands.md index ce18754..ab6533b 100644 --- a/docs/discord-bot/commands.md +++ b/docs/discord-bot/commands.md @@ -10,7 +10,7 @@ | senchabot | An open-source, multi-platform bot designed for seamless integration with Twitch and Discord • [senchabot.app](https://senchabot.app) • [github.com/senchabot-opensource/monorepo](https://github.com/senchabot-opensource/monorepo) | | kampus | discord.gg/kampus - github.com/kamp-us | | frontendship | discord.gg/frontendship | -| ping | pong! VoHiYo | +| ping | pong! VoHiYo
- + - Custom API System + Custom API System @@ -76,5 +76,5 @@
::: info Cooldown System -Command usage cooldown time is 2 minutes per user. +Command usage cooldown time is 2 seconds per user. ::: diff --git a/docs/tr/discord-bot/commands.md b/docs/tr/discord-bot/commands.md index 7335c51..bab5c7b 100644 --- a/docs/tr/discord-bot/commands.md +++ b/docs/tr/discord-bot/commands.md @@ -11,10 +11,8 @@ | kampus | discord.gg/kampus - github.com/kamp-us | | frontendship | discord.gg/frontendship | | ping | pong! VoHiYo | - - -## Temizleme + -::: +::: ``` /purge last-100-channel-messages message-content-contains: user-name-contains: ``` 14 günden eski olmayan mesajları kullanıcı adı veya mesaj iceriğindeki karakterlere göre siler. - +--> ## Sözlük @@ -89,9 +86,9 @@ Senchabot'un Yanıtı
- + - Custom API Sistemi + Custom API Sistemi @@ -111,5 +108,5 @@ Senchabot'un Yanıtı
::: info Cooldown Sistemi -Komut kullanım bekleme süresi kullanıcı başına 2 dakikadır. +Komut kullanım bekleme süresi kullanıcı başına 2 saniyedir. ::: From 8039513a1a6fdb0231c99c15aff379633946e655 Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:11:40 +0300 Subject: [PATCH 3/8] fix(twitch-bot): remove dublicated line, change badges --- docs/tr/twitch-bot/custom-commands.md | 18 +----------------- docs/twitch-bot/custom-commands.md | 21 ++------------------- 2 files changed, 3 insertions(+), 36 deletions(-) diff --git a/docs/tr/twitch-bot/custom-commands.md b/docs/tr/twitch-bot/custom-commands.md index ae1c8f7..98d1c14 100644 --- a/docs/tr/twitch-bot/custom-commands.md +++ b/docs/tr/twitch-bot/custom-commands.md @@ -34,18 +34,6 @@ outline: [2, 3] ::: -``` -!ucmd [komut_takma_adı] [yeni_komut_içeriği] -``` - -::: details Örnek Kullanım - -``` -!ucmd senchabot-link https://github.com/senchabot-opensource/ -``` - -::: - ### Komut Silme ``` @@ -102,7 +90,7 @@ outline: [2, 3] ::: -#### Çoklu takma ad silme +#### Çoklu takma ad silme ``` !dcmda [komut_takma_adları (boşluk bırakarak)] @@ -129,7 +117,3 @@ Senchabot's Channel Commands: senchabot, senchabot-site. ``` ::: - - diff --git a/docs/twitch-bot/custom-commands.md b/docs/twitch-bot/custom-commands.md index fd883f3..e3fbfb0 100644 --- a/docs/twitch-bot/custom-commands.md +++ b/docs/twitch-bot/custom-commands.md @@ -34,18 +34,6 @@ outline: [2, 3] ::: -``` -!ucmd [command_alias] [new_command_content] -``` - -::: details Example Usage - -``` -!ucmd senchabot-link https://github.com/senchabot-opensource/ -``` - -::: - ### Command Delete ``` @@ -63,7 +51,7 @@ outline: [2, 3] ### Alias Add ``` -acmda [command_name] [command_alias] +!acmda [command_name] [command_alias] ``` ::: details Example Usage @@ -102,7 +90,7 @@ acmda [command_name] [command_alias] ::: -#### Delete multiple aliases +#### Delete multiple aliases ``` !dcmda [command_alias(es) separated by space] @@ -127,9 +115,4 @@ acmda [command_name] [command_alias] ``` Senchabot's Channel Commands: senchabot, senchabot-site. ``` - ::: - - From 1b1c9f3c58f3f578be77461bbdd5bad0fd0942fe Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:12:39 +0300 Subject: [PATCH 4/8] feat(discord-bot): add new page, custom commands and custom api system. --- docs/discord-bot/custom-api-system.md | 97 +++++++++++++- docs/discord-bot/custom-commands.md | 164 +++++++++++++++++++++++ docs/tr/discord-bot/custom-api-system.md | 98 +++++++++++++- docs/tr/discord-bot/custom-commands.md | 155 +++++++++++++++++++++ 4 files changed, 512 insertions(+), 2 deletions(-) diff --git a/docs/discord-bot/custom-api-system.md b/docs/discord-bot/custom-api-system.md index f56b0ba..b098201 100644 --- a/docs/discord-bot/custom-api-system.md +++ b/docs/discord-bot/custom-api-system.md @@ -1 +1,96 @@ -# Custom API System +--- +outline: [2, 3] +--- + +# Custom API System + +This system allows you to send a GET request to a URL through the specified template and receive a response through a custom command you have added to your channel. + +``` +{customapi.https://...} +``` + +#### Adding Commands to Your Server + +``` +!acmd [command_name] [command_content {customapi.https://...}] +``` + +## What You Can Do with Custom API + +### Display the Currently Playing Song on Spotify + + + + + +``` +{customapi.https://spotify.aidenwallis.co.uk/u/...} +``` + +::: info Example Command Add + + + + !acmd song Currently Playing: {customapi.https://spotify.aidenwallis.co.uk/u/...} + + + New Command Added: song + + +::: + +::: details Example Usage + + + + !song + + + Currently Playing: ANGELPLAYA - DANGEROUS + + +::: + +::: info Adding Spotify Widget to Your Stream + +Use the link in the format `https://nowplaying.aidenwallis.co.uk/...` under the title "_Now Playing Widget_" on Aiden Wallis' website as a _browser source_ in your streaming software (OBS Studio, Streamlabs...). + +::: + +### Generate Random Text + +``` +{customapi.https://techy-api.vercel.app/api/text} +``` +::: info Example Command Add + + + + !acmd text {customapi.https://techy-api.vercel.app/api/text} + + + New Command Added: text + + +::: + +::: details Example Usage + + + + !text + + + The hardest part was setting the traffic velocity + + +::: diff --git a/docs/discord-bot/custom-commands.md b/docs/discord-bot/custom-commands.md index 8f230e1..680122e 100644 --- a/docs/discord-bot/custom-commands.md +++ b/docs/discord-bot/custom-commands.md @@ -1 +1,165 @@ +--- +outline: [2, 3] +--- + # Custom Commands + +## Server Commands + +### Command Add + +``` +!acmd [command_name] [command_content] +``` + +::: details Example Usage + + + + + !acmd senchabot https://senchabot.app/ + + + New Command Added: senchabot + + +::: + +::: info Information + +In global commands, the [`!ucmd`](/twitch-bot/custom-commands#command-update) update command does not work. The `!lurk` command is an exception in this regard. +::: + +### Command Update + +``` +!ucmd [command_name] [new_command_content] +``` + +::: details Example Usage + + + + + !ucmd senchabot https://docs.senchabot.app + + + Command Updated: senchabot + + +::: + +### Command Delete + +``` +!dcmd [command_name] +``` + +::: details Example Usage + + + + + !dcmd senchabot + + + Command Deleted: senchabot + + +::: + +### Alias Add + +``` +!acmda [command_name] [command_alias] +``` + +::: details Example Usage + + + + + !acmda senchabot discord-bot + + + New Command Aliases Added: discord-bot + + +::: + +#### Add multiple aliases + +``` +!acmda [command_name] [command_alias(es) separated by space] +``` + +::: details Example Usage + + + + + !acmda senchabot discord-bot twitch-bot + + + New Command Aliases Added: discord-bot, twitch-bot + + +::: + +### Alias Delete + +``` +!dcmda [command_alias] +``` + +::: details Example Usage + + + + + !dcmda discord-bot + + + Command Alias Deleted: discord-bot + + +::: + +#### Delete multiple aliases + +``` +!dcmda [command_alias(es) separated by space] +``` + +::: details Example Usage + + + + + !dcmda discord-bot twitch-bot + + + Command Alias Deleted: discord-bot, twitch-bot + + +::: + +## Access to Server Commands + +``` +!cmds +``` + +::: details Example Usage + + + + + !cmds + + + Commands: senchabot, discord, twitch, streamers + + +::: + diff --git a/docs/tr/discord-bot/custom-api-system.md b/docs/tr/discord-bot/custom-api-system.md index d4cf6b1..d1b2a39 100644 --- a/docs/tr/discord-bot/custom-api-system.md +++ b/docs/tr/discord-bot/custom-api-system.md @@ -1 +1,97 @@ -# Custom API Sistemi +--- +outline: [2, 3] +--- + +# Custom API Sistemi + +Belirtilen şablon aracılığıyla bir URL'ye GET isteği göndermenize ve kanalınıza eklemiş olduğunuz özel komut aracılığıyla yanıt almanıza olanak tanıyan sistemdir. + +``` +{customapi.https://...} +``` + +#### Sunucuna Komut Ekle + +``` +!acmd [komut_adı] [komut_içeriği {customapi.https://...}] +``` + +## Custom API'yle Yapılabilecekler + +### Spotify'da Çalan Şarkıyı Göster + + + + + + +``` +{customapi.https://spotify.aidenwallis.co.uk/u/...} +``` +::: info Örnek Komut Ekleme + + + + !acmd şarkı Şu An Çalan Şarkı: {customapi.https://spotify.aidenwallis.co.uk/u/...} + + + New Command Added: şarkı + + +::: + +::: details Örnek Kullanım + + + + !şarkı + + + Şu An Çalan Şarkı: ANGELPLAYA - DANGEROUS + + +::: + +::: info Yayınınıza Spotify Widgetı Ekleme + +Aiden Wallis'in sitesinde bulunan _Now Playin Widget_ başlığı altındaki `https://nowplaying.aidenwallis.co.uk/...` şeklindeki linki kullanmakta olduğunuz yayın aracına (OBS Studio, Streamlabs...) _tarayıcı kaynağı_ olarak ekleyiniz. + +::: + +### Rastgele Metin Yazdırma + +``` +{customapi.https://techy-api.vercel.app/api/text} +``` +::: info Örnek Komut Ekleme + + + + !acmd metin {customapi.https://techy-api.vercel.app/api/text}. + + + New Command Added: metin + + +::: + +::: details Örnek Kullanım + + + + !metin + + + The hardest part was setting the traffic velocity + + +::: + diff --git a/docs/tr/discord-bot/custom-commands.md b/docs/tr/discord-bot/custom-commands.md index b0e2483..d8b8517 100644 --- a/docs/tr/discord-bot/custom-commands.md +++ b/docs/tr/discord-bot/custom-commands.md @@ -1 +1,156 @@ +--- +outline: [2, 3] +--- + # Özel Komutlar + +## Sunucu Komutları + +### Komut Ekleme + +``` +!acmd [komut_adı] [komut_içeriği] +``` + +::: details Example Usage + + + + + !acmd senchabot https://senchabot.app/ + + + New Command Added: senchabot + + +::: + +### Komut Güncelleme + +``` +!ucmd [komut_adı] [yeni_komut_içeriği] +``` + +::: details Örnek Kullanım + + + + !ucmd senchabot https://docs.senchabot.app + + + Command Updated: senchabot + + +::: + +### Komut Silme + +``` +!dcmd [komut_adı] +``` + +::: details Örnek Kullanım + + + + !dcmd senchabot + + + Command Deleted: senchabot + + +::: + +### Alias Add + +``` +!acmda [komut_adı] [komut_takma_adı] +``` + +::: details Örnek Kullanım + + + + !acmda senchabot discord-bot + + + New Command Aliases Added: discord-bot + + +::: + +#### Çoklu takma ad ekleme + +``` +!acmda [komut_adı] [komut_takma_adları (boşluk bırakarak)] +``` + +::: details Örnek Kullanım + + + + + !acmda senchabot discord-bot twitch-bot + + + New Command Aliases Added: discord-bot, twitch-bot + + +::: + +### Takma Ad Silme + +``` +!dcmda [komut_takma_adı] +``` + +::: details Örnek Kullanım + + + + + !dcmda discord-bot + + + Command Alias Deleted: discord-bot + + +::: + +#### Çoklu takma ad silme + +``` +!dcmda [komut_takma_adları (boşluk bırakarak)] +``` + +::: details Örnek Kullanım + + + + + !dcmda discord-bot twitch-bot + + + Command Alias Deleted: discord-bot, twitch-bot + + +::: + +## Kanal Komutlarına Erişim + +``` +!cmds +``` + +::: details Örnek Yanıt + + + + + !cmds + + + Commands: senchabot, discord, twitch, streamers + + +::: From 8d9571dde225eaade96a2ed4fac9f90cfb17e7b5 Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:13:18 +0300 Subject: [PATCH 5/8] fix(twitch-bot): change cooldown system information messages --- docs/tr/twitch-bot/commands.md | 2 +- docs/twitch-bot/commands.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tr/twitch-bot/commands.md b/docs/tr/twitch-bot/commands.md index 507c499..496c2a0 100644 --- a/docs/tr/twitch-bot/commands.md +++ b/docs/tr/twitch-bot/commands.md @@ -110,5 +110,5 @@ Follow @senchabot over at twitch.tv/senchabot <3
::: info Cooldown Sistemi -Komut kullanım bekleme süresi kullanıcı başına 2 dakikadır. +Komut kullanım bekleme süresi kullanıcı başına 2 saniyedir. ::: diff --git a/docs/twitch-bot/commands.md b/docs/twitch-bot/commands.md index 17b6a36..4dd63c9 100644 --- a/docs/twitch-bot/commands.md +++ b/docs/twitch-bot/commands.md @@ -86,5 +86,5 @@ Follow @senchabot over at twitch.tv/senchabot <3
::: info Cooldown System -Command usage cooldown time is 2 minutes per user. +Command usage cooldown time is 2 seconds per user. ::: From a771b41d3a92a2e93f69b0350260af9de00793f8 Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 15:14:09 +0300 Subject: [PATCH 6/8] feat(markdown-extensions): add discord/custom-command-messages --- docs/MARKDOWN-EXTENSIONS.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/MARKDOWN-EXTENSIONS.md b/docs/MARKDOWN-EXTENSIONS.md index bc99184..258bac8 100644 --- a/docs/MARKDOWN-EXTENSIONS.md +++ b/docs/MARKDOWN-EXTENSIONS.md @@ -279,6 +279,7 @@ We have custom button style
+## Discord ### Discord Application Commands Style We use a special component for Discord application commands. @@ -333,7 +334,7 @@ You can also use it with two options: > -## Displaying Discord messages +### Displaying Discord messages We use [@discord-message-components/vue](https://github.com/Danktuary/discord-message-components/blob/main/packages/vue/README.md) to display "fake" Discord messages on pages. The reason for this is to make it easy for you to create, easy for anyone in the future to edit, and avoid having to take screenshots and using too many images on a page at once. Here's a preview of the components: @@ -358,8 +359,30 @@ The syntax to make this display is quite simple as well: ``` +#### Custom Command Messages -### Slash Command messages +**Input** +```js + + + !ping + + + pong! Took 50ms + + +``` +**Output** + + + !ping + + + pong! Took 50ms + + + +#### Slash Command messages **`ephemeral` Version** From 332bee90d643a56fcbcfdadb743694fa1dd6f8a7 Mon Sep 17 00:00:00 2001 From: igdiAysu / AysArt <87132161+igdiaysu@users.noreply.github.com> Date: Sun, 18 Feb 2024 17:00:05 +0300 Subject: [PATCH 7/8] fix(discord-bot): change discord application commands to new component --- docs/discord-bot/live-stream-announcements.md | 254 ++++++++++------- docs/discord-bot/live-stream-events.md | 53 ++-- .../discord-bot/live-stream-announcements.md | 260 ++++++++++-------- docs/tr/discord-bot/live-stream-events.md | 52 ++-- 4 files changed, 354 insertions(+), 265 deletions(-) diff --git a/docs/discord-bot/live-stream-announcements.md b/docs/discord-bot/live-stream-announcements.md index 29d05e1..4d06b07 100644 --- a/docs/discord-bot/live-stream-announcements.md +++ b/docs/discord-bot/live-stream-announcements.md @@ -7,21 +7,25 @@ outline: [2, 4] ## Live Stream and Broadcaster Custom Settings ### Adding a Streamer - -``` -/set-twitch streamer url-or-username: -``` +
+ + ::: details Example Usage - - + + +
- - - - /set-twitch streamer url-or-username: senchabot - -