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", // }, 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** 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/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 + + + +
+ + + AIDEN WALLIS + Connect Your 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/discord-bot/live-stream-announcements.md b/docs/discord-bot/live-stream-announcements.md index 29d05e1..c9498e4 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 - -