diff --git a/src/commands/commands.md b/src/commands/commands.md index 4a3bf6b..47e6fb7 100644 --- a/src/commands/commands.md +++ b/src/commands/commands.md @@ -6,7 +6,7 @@ | /about | Information about the bot | | /help | Displays a list of commands | | /invite | Provides an invite link for the bot | -| /vote | Gives a link to vote for free premium beneftis                                         | +| /vote | Gives a link to vote for free premium benefits                                         | | Ticket Commands | Description | | -- | -- | @@ -27,7 +27,7 @@ | Setting Commands | Description | | -- | -- | -| [/addadmin](./add-admin-support.md) (user_or_role) | Grants a user or role admin priveledges of the bot | +| [/addadmin](./add-admin-support.md) (user_or_role) | Grants a user or role admin privileges of the bot | | [/addsupport](./add-admin-support.md) (user_or_role) | Adds a user or role as a support representative | | /autoclose configure | Edit autoclose related settings | | /autoclose exclude | Excludes the current ticket from being automatically closed | @@ -35,8 +35,8 @@ | /language (language) | Changes the language the bot messages are displayed in | | /panel | Provides a link to create a reaction panel for users to open tickets | | /premium | Activates premium benefits after purchasing (choose patreon on select menu) | -| /removeadmin (user_or_role) | Revokes a user's or role's admin priveledges | -| /removesupport (user_or_role) | Revokes a user's or role's support representative priviledges | +| /removeadmin (user_or_role) | Revokes a user's or role's admin privileges | +| /removesupport (user_or_role) | Revokes a user's or role's support representative privileges | | /setup auto | Bot will make a very basic configuration (no reaction panels - you'll still want to customize on dashboard) | | /setup limit | Change the quantity of tickets a single user can have open at the same time | | /setup transcripts | Change the transcripts channel | diff --git a/src/commands/introduction.md b/src/commands/introduction.md index 6e8adda..6e706e0 100644 --- a/src/commands/introduction.md +++ b/src/commands/introduction.md @@ -1,4 +1,10 @@ # Commands This chapter provides some information regarding key commands. -Use the sidebar to navigate this chapter. \ No newline at end of file +Use the sidebar to navigate this chapter, or use the buttons below. + +*** + +- [Command List](../commands/commands.md) +- [Add Admin & Add Support](../commands/add-admin-support.md) +- [Close Requests](../commands/close-requests.md) \ No newline at end of file diff --git a/src/dashboard/introduction.md b/src/dashboard/introduction.md index c3ac70f..7a7191d 100644 --- a/src/dashboard/introduction.md +++ b/src/dashboard/introduction.md @@ -1,4 +1,27 @@ # Dashboard This chapter provides information regarding configuring the bot using the web dashboard. -Use the sidebar to navigate this chapter. \ No newline at end of file +Use the sidebar to navigate this chapter, or use the buttons below. + +*** + +- [Settings](../dashboard/settings/settings.md) + - [User Feedback](../dashboard/settings/feedback.md) + - [Exit Survey](../dashboard/settings/exit-survey.md) + - [Thread Mode](../features/thread-mode.html) + - [Placeholders](../miscellaneous/placeholders.html) + - [Start Ticket from Message](../features/start-ticket-from-message.html) + - [Claiming Tickets](../dashboard/settings/claiming.md) + - [Awaiting User Response](../dashboard/settings/awaiting-response.md) +- [Transcripts](../dashboard/transcripts.md) +- [Panels](../dashboard/reaction-panels.md) + - [Multi-Panels](../dashboard/multipanels.md) +- [Forms](../dashboard/forms.md) +- [Staff Teams](../dashboard/staff-teams.md) +- [Integrations](../integrations/introduction.md) + - [Building Intergrations](../integrations/building-integrations.md) + - [Cloudflare Workers](../integrations/cloudflare-workers.md) + - [FiveM Intergration](../integrations/fivem.md) +- [Tickets](../dashboard/tickets.md) +- [Blacklist](../dashboard/blacklist.md) +- [Tags](../dashboard/tags.md) diff --git a/src/dashboard/reaction-panels.md b/src/dashboard/reaction-panels.md index 92ec18f..f0497e3 100644 --- a/src/dashboard/reaction-panels.md +++ b/src/dashboard/reaction-panels.md @@ -121,7 +121,7 @@ The server's welcome message can be overridden on a per-panel basis using this f - Discord message formatting can also be used to include links to channels, emojis, roles, or usernames in the welcome message. - **First**, discord developer mode must be turned on - in your personal discord account settings > advanced > discord developer mode. - **Second**, right click any channel name, username, message, etc and choose `Copy ID`. - - **Third**, use the `structure` section of [discord's messge formatting chart](https://discord.com/developers/docs/reference#message-formatting) to include it in the welcome message. + - **Third**, use the `structure` section of [discord's message formatting chart](https://discord.com/developers/docs/reference#message-formatting) to include it in the welcome message. ## Access Control *** diff --git a/src/dashboard/settings/settings.md b/src/dashboard/settings/settings.md index 02eb793..d71d4b2 100644 --- a/src/dashboard/settings/settings.md +++ b/src/dashboard/settings/settings.md @@ -103,7 +103,7 @@ The welcome message is the message displayed in the Ticket as soon as the user o - Discord message formatting can also be used to include links to channels, emojis, roles, or usernames in the welcome message. - **First**, discord developer mode must be turned on - in your personal discord account settings > advanced > discord developer mode. - **Second**, right click any channel name, username, message, etc and choose `Copy ID`. - - **Third**, use the `structure` section of [discord's messge formatting chart](https://discord.com/developers/docs/reference#message-formatting) to include it in the welcome message. + - **Third**, use the `structure` section of [discord's message formatting chart](https://discord.com/developers/docs/reference#message-formatting) to include it in the welcome message. The title of the embed will either be based off of the subject provided by the user when using `/open [Subject]`, or the title will show "No subject given" if one wasn't input. diff --git a/src/features/introduction.md b/src/features/introduction.md index ba0fbda..47b2800 100644 --- a/src/features/introduction.md +++ b/src/features/introduction.md @@ -1,4 +1,13 @@ # Features This chapter provides some details about the core features of the bot. -Use the sidebar to navigate this chapter. \ No newline at end of file +Use the sidebar to navigate this chapter, or use the buttons below. + +*** + +- [Thread Mode](../features/thread-mode.md) +- [Forms](../features/forms.md) +- [Multi-Panels](../features/multipanels.md) +- [Start Ticket From Message](../features/start-ticket-from-message.md) +- [Close Requests](../features/close-requests.md) +- [User Feedback](../features/feedback.md) diff --git a/src/img/archive_message.webp b/src/img/archive_message.webp index 249544e..d17c334 100644 Binary files a/src/img/archive_message.webp and b/src/img/archive_message.webp differ diff --git a/src/img/auto_setup.webp b/src/img/auto_setup.webp index 7684902..04cf331 100644 Binary files a/src/img/auto_setup.webp and b/src/img/auto_setup.webp differ diff --git a/src/img/close_request.webp b/src/img/close_request.webp index 71c92cb..b59f1fd 100644 Binary files a/src/img/close_request.webp and b/src/img/close_request.webp differ diff --git a/src/img/close_request_deny.webp b/src/img/close_request_deny.webp index 98d3b9c..117f0db 100644 Binary files a/src/img/close_request_deny.webp and b/src/img/close_request_deny.webp differ diff --git a/src/img/close_request_params.webp b/src/img/close_request_params.webp index 83f1f2b..3cd824f 100644 Binary files a/src/img/close_request_params.webp and b/src/img/close_request_params.webp differ diff --git a/src/img/developer_mode.webp b/src/img/developer_mode.webp index adf4b9b..176c8a2 100644 Binary files a/src/img/developer_mode.webp and b/src/img/developer_mode.webp differ diff --git a/src/img/feedback_example.webp b/src/img/feedback_example.webp index 2bfae3c..0cbf54e 100644 Binary files a/src/img/feedback_example.webp and b/src/img/feedback_example.webp differ diff --git a/src/img/forms/example.webp b/src/img/forms/example.webp index 835a7af..4d5cd14 100644 Binary files a/src/img/forms/example.webp and b/src/img/forms/example.webp differ diff --git a/src/img/forms/output.webp b/src/img/forms/output.webp index d2d2f6f..4654576 100644 Binary files a/src/img/forms/output.webp and b/src/img/forms/output.webp differ diff --git a/src/img/integrations/fivem/add_to_server.webp b/src/img/integrations/fivem/add_to_server.webp index 016d419..6e54c2a 100644 Binary files a/src/img/integrations/fivem/add_to_server.webp and b/src/img/integrations/fivem/add_to_server.webp differ diff --git a/src/img/integrations/fivem/integrations_page.webp b/src/img/integrations/fivem/integrations_page.webp index 31731c7..ff1645c 100644 Binary files a/src/img/integrations/fivem/integrations_page.webp and b/src/img/integrations/fivem/integrations_page.webp differ diff --git a/src/img/integrations/headers.webp b/src/img/integrations/headers.webp index 72b543b..0e3c712 100644 Binary files a/src/img/integrations/headers.webp and b/src/img/integrations/headers.webp differ diff --git a/src/img/integrations/metadata.webp b/src/img/integrations/metadata.webp index 6da298d..9c8e6d7 100644 Binary files a/src/img/integrations/metadata.webp and b/src/img/integrations/metadata.webp differ diff --git a/src/img/integrations/navbar.webp b/src/img/integrations/navbar.webp index 83a0ec5..c717e81 100644 Binary files a/src/img/integrations/navbar.webp and b/src/img/integrations/navbar.webp differ diff --git a/src/img/integrations/placeholder_creation.webp b/src/img/integrations/placeholder_creation.webp index a509cc5..718000f 100644 Binary files a/src/img/integrations/placeholder_creation.webp and b/src/img/integrations/placeholder_creation.webp differ diff --git a/src/img/integrations/request_completed.webp b/src/img/integrations/request_completed.webp index 5eb6015..90f9b02 100644 Binary files a/src/img/integrations/request_completed.webp and b/src/img/integrations/request_completed.webp differ diff --git a/src/img/integrations/request_url.webp b/src/img/integrations/request_url.webp index 4e80cae..39dd8e8 100644 Binary files a/src/img/integrations/request_url.webp and b/src/img/integrations/request_url.webp differ diff --git a/src/img/invite-1.5.webp b/src/img/invite-1.5.webp new file mode 100644 index 0000000..48485a7 Binary files /dev/null and b/src/img/invite-1.5.webp differ diff --git a/src/img/invite-1.webp b/src/img/invite-1.webp index 140b932..495362c 100644 Binary files a/src/img/invite-1.webp and b/src/img/invite-1.webp differ diff --git a/src/img/invite-2.webp b/src/img/invite-2.webp index 8949473..6a03f80 100644 Binary files a/src/img/invite-2.webp and b/src/img/invite-2.webp differ diff --git a/src/img/login.webp b/src/img/login.webp index 06e0b33..89ff24b 100644 Binary files a/src/img/login.webp and b/src/img/login.webp differ diff --git a/src/img/multipanel_example.webp b/src/img/multipanel_example.webp index d930b22..68de662 100644 Binary files a/src/img/multipanel_example.webp and b/src/img/multipanel_example.webp differ diff --git a/src/img/server_language.webp b/src/img/server_language.webp index d4b6e35..a82464c 100644 Binary files a/src/img/server_language.webp and b/src/img/server_language.webp differ diff --git a/src/img/server_list.webp b/src/img/server_list.webp index 91a93bf..c707237 100644 Binary files a/src/img/server_list.webp and b/src/img/server_list.webp differ diff --git a/src/img/settings_card.webp b/src/img/settings_card.webp index 007c67d..06c49ae 100644 Binary files a/src/img/settings_card.webp and b/src/img/settings_card.webp differ diff --git a/src/img/settings_card_click.webp b/src/img/settings_card_click.webp new file mode 100644 index 0000000..572ad47 Binary files /dev/null and b/src/img/settings_card_click.webp differ diff --git a/src/img/slash_commands.webp b/src/img/slash_commands.webp index dfbdad7..51f5593 100644 Binary files a/src/img/slash_commands.webp and b/src/img/slash_commands.webp differ diff --git a/src/img/tags_id_example.webp b/src/img/tags_id_example.webp index 71b1743..d82730e 100644 Binary files a/src/img/tags_id_example.webp and b/src/img/tags_id_example.webp differ diff --git a/src/img/tags_message_example.webp b/src/img/tags_message_example.webp index 24b7339..bdd5a94 100644 Binary files a/src/img/tags_message_example.webp and b/src/img/tags_message_example.webp differ diff --git a/src/img/tags_message_full_example.webp b/src/img/tags_message_full_example.webp index b4b628b..ae514aa 100644 Binary files a/src/img/tags_message_full_example.webp and b/src/img/tags_message_full_example.webp differ diff --git a/src/img/tags_message_inline.webp b/src/img/tags_message_inline.webp index 00398b0..80cc91c 100644 Binary files a/src/img/tags_message_inline.webp and b/src/img/tags_message_inline.webp differ diff --git a/src/img/ticket_close_confirmation.webp b/src/img/ticket_close_confirmation.webp index fb4e0e0..c5ac6ea 100644 Binary files a/src/img/ticket_close_confirmation.webp and b/src/img/ticket_close_confirmation.webp differ diff --git a/src/img/welcome_message.webp b/src/img/welcome_message.webp index ac8b06e..58383ca 100644 Binary files a/src/img/welcome_message.webp and b/src/img/welcome_message.webp differ diff --git a/src/integrations/building-integrations.md b/src/integrations/building-integrations.md index f6f701c..2c8aa3d 100644 --- a/src/integrations/building-integrations.md +++ b/src/integrations/building-integrations.md @@ -11,7 +11,7 @@ A simple example would be a forum! When a user opens a ticket in your Discord se Another example is our built-in Bloxlink integration, which allows you to include the Roblox usernames, profile URLs and more in tickets. The Bloxlink integration is automatically enabled in all servers. You can view the welcome message placeholders available through it [here](https://docs.tickets.bot/setup/placeholders#bloxlink). -Integrations do not necessarily need to fetch information about a user either! In the [next tutorial](), we show you how we built the cryptocurrency price integration. +Integrations do not necessarily need to fetch information about a user either! ## Background Setup Let's say we run a game, where users link their accounts to their Discord accounts. Users have usernames, scores and other metadata which we wish to display in the welcome message when a user opens a ticket. diff --git a/src/integrations/introduction.md b/src/integrations/introduction.md index 0dbc619..a0b143d 100644 --- a/src/integrations/introduction.md +++ b/src/integrations/introduction.md @@ -1,4 +1,10 @@ # Integrations This chapter provides information regarding integrations, and how to build them. -Use the sidebar to navigate this chapter. \ No newline at end of file +Use the sidebar or the buttons below to navigate this chapter + +*** + +- [Building Intergrations](../integrations/building-integrations.md) +- [Cloudflare Workers](../integrations/cloudflare-workers.md) +- [FiveM Intergration](../integrations/fivem.md) \ No newline at end of file diff --git a/src/introduction/introduction.md b/src/introduction/introduction.md index 98aa2a0..04cccbe 100644 --- a/src/introduction/introduction.md +++ b/src/introduction/introduction.md @@ -2,7 +2,7 @@ These Docs will help you with: * Setting up the Bot -* Explain each feature of the Bot +* Explaining each feature of the Bot * Tell you how to set each feature up * How to use the bot correctly * How to fix issues with permissions @@ -12,7 +12,7 @@ Updates to the docs are made frequently.
-**If you find any issues in the Docs like typo's and outdated information then please tell us in our [support server](https://discord.gg/ticketsbot).** +**If you find any issues in the Docs like typos and outdated information then please tell us in our [support server](https://discord.gg/ticketsbot).**
-Get started setting up the bot [here](../setup/introduction.md) +Get started with setting up the bot [here](../setup/introduction.md) diff --git a/src/miscellaneous/introduction.md b/src/miscellaneous/introduction.md index c6a3944..8a582ff 100644 --- a/src/miscellaneous/introduction.md +++ b/src/miscellaneous/introduction.md @@ -1,4 +1,13 @@ # Miscellaneous This chapter contains all other documents which do not suit the other chapters. -Use the sidebar to navigate this chapter. \ No newline at end of file +Use the sidebar to navigate this chapter, or use the buttons below. + +*** + +- [Official Tickets Links](../miscellaneous/official-links.md) +- [Patreon Links/Articles](../miscellaneous/patreon.md) +- [Permissions Explained](../miscellaneous/permissions-explained.md) +- [Placeholders](../miscellaneous/placeholders.md) +- [Translate the Bot](../miscellaneous/translate.md) +- [Dashboard: "No Permission"](../miscellaneous/dashboard-no-permission.md) diff --git a/src/premium/introduction.md b/src/premium/introduction.md index 365de12..3096955 100644 --- a/src/premium/introduction.md +++ b/src/premium/introduction.md @@ -1,4 +1,9 @@ # Premium This chapter provides information regarding the premium tiers offered for the bot. -Use the sidebar to navigate this chapter. +Use the sidebar to navigate this chapter, or use the buttons below. + +*** + +- [Premium & Whitelabel Perks](../premium/perks.md) +- [Whitelabel Setup Guide](../premium/whitelabel-setup-guide.md) diff --git a/src/setup/dashboard.md b/src/setup/dashboard.md index 1838da8..57519ed 100644 --- a/src/setup/dashboard.md +++ b/src/setup/dashboard.md @@ -47,7 +47,7 @@ The welcome message is the message displayed in the Ticket as soon as the user o - You may make use of placeholders in your welcome message. You can view a list of placeholders [here](../miscellaneous/placeholders.md). -- You may also use discord message formatting to include links to channels, emojis, roles, or usernames in your welcome message. **First**, you will need to have discord developer mode turned on - in your personal discord account settings > advanced > discord developer mode. **Second**, you can right click any channel name, username, message, etc and choose `Copy ID`. **Third**, use the `structure` section of [discord's messge formatting chart](https://discord.com/developers/docs/reference#message-formatting) to include it in your welcome message. +- You may also use discord message formatting to include links to channels, emojis, roles, or usernames in your welcome message. **First**, you will need to have discord developer mode turned on - in your personal discord account settings > advanced > discord developer mode. **Second**, you can right click any channel name, username, message, etc and choose `Copy ID`. **Third**, use the `structure` section of [discord's message formatting chart](https://discord.com/developers/docs/reference#message-formatting) to include it in your welcome message. The title of the embed will either be based off of the subject provided by the user when using `/open [Subject]`, or the title of the ticket panel if used. We are unable to get a subject from the user when using ticket panels currently, however, this will be possible in a future update of Discord. @@ -83,7 +83,7 @@ Defines how the ticket channels should be named. Currently, the 2 options are by Once you are satisfied with your settings, press the `Submit` button to save them. An example follows: -![Settings](../img/settings_card.webp) +![Settings](../img/settings_card_click.webp) We now have the basic configuration completed! diff --git a/src/setup/individual.md b/src/setup/individual.md index fb87824..ed4e3fd 100644 --- a/src/setup/individual.md +++ b/src/setup/individual.md @@ -1,4 +1,4 @@ -# Bot Configuration: Indiviual Commands +# Bot Configuration: Individual Commands *** You can also tweak individual settings by using a single command. Note, not all settings are available via command, some are only accessible on the [dashboard](./dashboard.md), such as [ticket panels](./panels.md). diff --git a/src/setup/invite.md b/src/setup/invite.md index 5a7f44e..c6d1ef5 100644 --- a/src/setup/invite.md +++ b/src/setup/invite.md @@ -12,7 +12,8 @@ Upon pressing `Continue`, you'll be presented with a list of permissions Tickets Click `Authorize` to proceed. -![Authorize permissions](../img/invite-2.webp) +![Permissions 1](../img/invite-1.5.webp) +![Authorize permissions 2](../img/invite-2.webp) Discord will then present you with a screen stating that you've authorised the bot: it's now in your server!