-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Better Landing Page, Tebex Page and Setup
- Loading branch information
Showing
19 changed files
with
201 additions
and
84 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,28 @@ | ||
| --- | ||
| label: Automod | ||
| Order: 3 | ||
| Order: 98 | ||
| --- | ||
|
|
||
| # Automod | ||
| Automod is a feature that allows you to protect your realm from hackers | ||
|
|
||
| When you have automod turned on the bot kicks anyone who joins the realm that doesn't meet the given criteria or breaks a given automod rule | ||
|
|
||
| !!!primary Premium Only | ||
| This feature only works with **Realm Bot Premium** | ||
| !!! | ||
|
|
||
| Automod is a premium feature and works only when the bot is in the realm | ||
| # Automod | ||
|
|
||
| !!! | ||
| Automod is a feature that allows you to protect your realm from hackers | ||
|
|
||
| When you have automod turned on the bot kicks anyone who joins the realm that doesn't meet the given criteria or breaks a given automod rule | ||
|
|
||
| --- | ||
|
|
||
| ## Details | ||
| To set automod rules, locate your realm from the panel on the left in your guild [Dashboard](https://realmbot.dev/guilds) and from your realm config page under modules, locate `Member Gate` and press settings | ||
|
|
||
|  | ||
|
|
||
| You can enable automod from here and create new automod rules by typing a name in the `Rule Name` box and then pressing `Create Rule` button | ||
| To set automod rules, locate your realm from the panel on the left in your guild [Dashboard](https://realmbot.dev/guilds) and from your realm config page under modules, locate `Member Gate` and press settings | ||
|
|
||
|  | ||
|
|
||
| You can enable automod from here and create new automod rules by typing a name in the `Rule Name` box and then pressing `Create Rule` button | ||
|
|
||
|  | ||
|
|
||
| After pressing `Create Rule` a pop-up will appear and from there You can set the automod criteria/rule from the first box and the condition from the second box |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,45 +1,52 @@ | ||
| --- | ||
| label: Chat relay | ||
| order: 1 | ||
| label: Chat Relay | ||
| order: 100 | ||
| --- | ||
|
|
||
| !!!primary Premium Only | ||
| This feature only works with **Realm Bot Premium** | ||
| !!! | ||
|
|
||
| # Chat Relay | ||
| Chat relay is a feature which allows people in Discord to talk with people in your realm and vice versa | ||
|
|
||
| Chat relay is a feature which allows people in Discord to talk with people in your realm and vice versa | ||
|
|
||
| Chat relay requires you to be a premium user and needs the bot to be in the Realm | ||
|
|
||
| --- | ||
|
|
||
| ## How it Works | ||
| Chat relay works by the Realmbot instantly sending messages sent in the realm to a dedicated channel in your discord and messages sent in that channel are sent to the realm instantly | ||
|
|
||
| The bot does this by joining the realm on the realm owner's account or its own account *if you have alt account joining enabled* | ||
|
|
||
| The bot sends messages from the realm to the discord in two ways. One as a normal message and as an embed (*also called tellraw relay*) | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## How it Works | ||
|
|
||
| Chat relay works by the Realmbot instantly sending messages sent in the realm to a dedicated channel in your discord and messages sent in that channel are sent to the realm instantly | ||
|
|
||
| The bot does this by joining the realm on the realm owner's account or its own account _if you have alt account joining enabled_ | ||
|
|
||
| The bot sends messages from the realm to the discord in two ways. One as a normal message and as an embed (_also called tellraw relay_) | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| --- | ||
|
|
||
| ## Configuring chat relay | ||
| Chat relay can be configured via the [dashboard](https://realmbot.dev/) | ||
|
|
||
| For the commands related to chat relay see [Chat Relay](/Commands/world-commands.md) | ||
|
|
||
| To turn on chat relay go to your guild dashboard and locate your realm name from the tabs on the left of the page | ||
| ## Configuring chat relay | ||
|
|
||
| Chat relay can be configured via the [dashboard](https://realmbot.dev/) | ||
|
|
||
| For the commands related to chat relay see [Chat Relay](/Commands/world-commands.md) | ||
|
|
||
| To turn on chat relay go to your guild dashboard and locate your realm name from the tabs on the left of the page | ||
|
|
||
|  | ||
|
|
||
|  | ||
| Under **Modules** locate Chat Relay and press `settings` in the Chat Relay box, This will take you to the Chat Relay page and in there enable the button next to `Chat Relay` | ||
|
|
||
| Under **Modules** locate Chat Relay and press `settings` in the Chat Relay box, This will take you to the Chat Relay page and in there enable the button next to `Chat Relay` | ||
|
|
||
|  | ||
|  | ||
|
|
||
|  | ||
|  | ||
|
|
||
| From there you can set the channel you want to use for chat relay by selecting the desired channel from the `Relay Channel` box | ||
| From there you can set the channel you want to use for chat relay by selecting the desired channel from the `Relay Channel` box | ||
|
|
||
| You can also select what type of messages the bot Relays by turning on the respective buttons | ||
| You can also select what type of messages the bot Relays by turning on the respective buttons | ||
|
|
||
| If you use Chat Ranks in your realm you can configure the bot to work with the chat rank pack by turning on `Detect & Relay Modified Chat Messages` and selecting the chat rank pack you use in the `Chat Modification Pack` dropdown under `Chat Ranks Detection` | ||
| If you use Chat Ranks in your realm you can configure the bot to work with the chat rank pack by turning on `Detect & Relay Modified Chat Messages` and selecting the chat rank pack you use in the `Chat Modification Pack` dropdown under `Chat Ranks Detection` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,40 @@ | ||
| --- | ||
| label: Console | ||
| order: 2 | ||
| order: 99 | ||
| --- | ||
|
|
||
| # Console | ||
| Console is a feature that allows you to run in-game commands via the Discord server | ||
| !!!primary Premium Only | ||
| This feature only works with **Realm Bot Premium** | ||
| !!! | ||
|
|
||
| Console requires premium and works with chat relay and is based on Realmbot being in the realm | ||
| # Console | ||
|
|
||
| Console is a feature that allows you to run in-game commands via the Discord server | ||
|
|
||
| Console requires premium and works with chat relay and is based on Realmbot being in the realm | ||
|
|
||
| --- | ||
|
|
||
| ## Configuring console | ||
| To turn on console head over to your guild dashboard and locate your realm from the tab on the left | ||
| ## Configuring console | ||
|
|
||
| To turn on console head over to your guild dashboard and locate your realm from the tab on the left | ||
|
|
||
|  | ||
|
|
||
|  | ||
| In your realm config page, under `Modules` find `Realm Console` and press on settings | ||
|
|
||
| In your realm config page, under `Modules` find `Realm Console` and press on settings | ||
|  | ||
|
|
||
|  | ||
| From there select the channel you want to set as the console channel from the provided box | ||
|
|
||
| From there select the channel you want to set as the console channel from the provided box | ||
| !!! | ||
|
|
||
| !!! | ||
| **NOTE** | ||
|
|
||
| **NOTE** | ||
| * Make sure the channel you have selected for console is private | ||
| - Make sure the channel you have selected for console is private | ||
|
|
||
| * Do not type / when typing commands in the console channel | ||
| - Do not type / when typing commands in the console channel | ||
|
|
||
| * For console to work the bot must be in-game. Run `/world join` for the bot to join | ||
| - For console to work the bot must be in-game. Run `/world join` for the bot to join | ||
|
|
||
| !!! | ||
|
|
||
| !!! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| order: 100 | ||
| expanded: true | ||
| icon: | ||
| icon: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| order: 100 | ||
| expanded: true | ||
| icon: link |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| label: Tebex | ||
| order: 97 | ||
| author: | ||
| name: Kaii | ||
| avatar: https://avatars.githubusercontent.com/u/72093371?s=96&v=4 | ||
| --- | ||
|
|
||
| !!!primary Premium Only | ||
| This feature only works with **Realm Bot Premium** | ||
| !!! | ||
|
|
||
| ### What is Tebex | ||
|
|
||
| Tebex, formerly known as Buycraft, is a renowned e-commerce platform designed exclusively for the Minecraft community. It serves as an essential tool for server owners and administrators seeking to monetize their Minecraft game servers effectively. | ||
|
|
||
| Realm Bot has the capability to seamlessly deliver in-game rewards, such as instantly giving a purchased rank from the store upon the user. | ||
|
|
||
| ### How to setup | ||
|
|
||
| 1. Create a tebex account and then create a Game Server on tebex | ||
|  | ||
| 2. Select Minecraft as the platform to create a webstore for | ||
|  | ||
| 3. Choose the Minecraft: Bedrock edition of minecraft | ||
|  | ||
| 4. Copy the Secret Code only. | ||
|  | ||
| 5. Select the Tebex Module inside Realm Bot Dashboard | ||
|  | ||
| 6. Tick Enabled then paste the Tebex secret into the box and then hit save | ||
|  | ||
| 7. Both pages in Realm Bot and inside Tebex should say connected | ||
|  | ||
|  | ||
|
|
||
| ### Creating Products on Tebex | ||
|
|
||
| You have successfully configured Tebex and Realm Bot. To explore the comprehensive capabilities of Tebex, we recommend referring to the official documentation available at https://docs.tebex.io/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,69 @@ | ||
| --- | ||
| label: Landing | ||
| icon: ruby | ||
| icon: home | ||
| authors: | ||
| - name: Kaii | ||
| avatar: https://avatars.githubusercontent.com/u/72093371?s=96&v=4 | ||
| - name: SeaLeopard35302 | ||
| avatar: https://avatars.githubusercontent.com/u/78130400?s=96&v=4 | ||
| --- | ||
| # Realmbot documentation | ||
|
|
||
| Greetings and welcome to the official Realm Bot Documentation Website. | ||
| # Welcome to Realm Bot Documentation | ||
|
|
||
|  | ||
|
|
||
| ## What is Realm Bot? | ||
|
|
||
| Realm Bot is a versatile Discord bot designed to simplify the management of your Minecraft Bedrock Realm directly from Discord. Whether you're an experienced server owner or just starting out, Realm Bot offers a wide range of features to make your server administration a breeze. Here are some of the key features that Realm Bot provides: | ||
|
|
||
| ### Realm Management | ||
|
|
||
| - **Start, Stop, and Restart**: Control the status of your realm with ease, all from the comfort of your Discord server. | ||
| - **Invite and Remove Players**: Easily manage your player roster by inviting or removing members right within Discord. | ||
|
|
||
| ### Moderation | ||
|
|
||
| - **Mute, Kick, and Ban Players**: Maintain a harmonious server environment by taking swift action when necessary. | ||
| - **Whitelist Control**: Manage who can join your realm by setting up a whitelist from Discord. | ||
|
|
||
| ### Chat Relay | ||
|
|
||
| - **Stay Connected**: Relay chat messages between Discord and your realm, ensuring constant communication with your players. | ||
|
|
||
| ### Game Settings | ||
|
|
||
| - **Gamemode and Difficulty**: Adjust game settings like gamemode and difficulty without the need to log into the game. | ||
|
|
||
| ### Broadcasting | ||
|
|
||
| - **Direct Messages**: Send messages directly to your realm players, even if they're not in Discord. | ||
|
|
||
| ### Chat Logs | ||
|
|
||
| - **Review Chat Activity**: Keep an eye on what your players have been saying with the ability to view chat logs. | ||
|
|
||
| ### Bot Control | ||
|
|
||
| - **Block Disruptive Bots**: Prevent other bots from causing disruptions in your realm. | ||
|
|
||
| ### Tebex Integration | ||
|
|
||
| - **Monetization**: Seamlessly integrate with Tebex, a popular Minecraft webstore platform, to sell in-game items and services to your players. | ||
|
|
||
| Realm Bot is the perfect tool to streamline your Minecraft Bedrock Realm management, saving you time and effort. The best part? It's available for free with a premium tier that includes additional features. | ||
|
|
||
| ## Get Started with Realm Bot | ||
|
|
||
| To harness the power of Realm Bot, follow these simple steps: | ||
|
|
||
| 1. **Add Realm Bot to Your Discord Server**: Visit the [Realm Bot website](https://www.realmbot.dev) and click the "Invite to Server" button. | ||
|
|
||
| 2. **Link Your Accounts**: To unlock all features, use the `/connect` command in Discord to link your Xbox and Discord accounts together. | ||
|
|
||
| 3. **Command List**: Discover the full range of Realm Bot commands by simply typing `/` | ||
|
|
||
| Realm Bot is the ultimate companion for anyone managing a Minecraft Bedrock Realm. It not only saves you time but also enhances the overall player experience. Elevate your server management to the next level with Realm Bot today! | ||
|
|
||
| ## Join Our Community | ||
|
|
||
| <iframe src="https://discord.com/widget?id=700274742183329792&theme=dark" width="100%" height="500" allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe> |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,28 @@ | ||
| --- | ||
| label: Setup | ||
| order: 101 | ||
| icon : rocket | ||
| icon: rocket | ||
| authors: | ||
| - name: Kaii | ||
| avatar: https://avatars.githubusercontent.com/u/72093371?s=96&v=4 | ||
| - name: SeaLeopard35302 | ||
| avatar: https://avatars.githubusercontent.com/u/78130400?s=96&v=4 | ||
| --- | ||
|
|
||
| # Realm Bot Setup | ||
| This will explain in detail how to setup Realmbot in your guild | ||
|
|
||
| ## STEP ONE | ||
| First, you have to authorise the Minecraft account that owns the realm to Realmbot. | ||
|
|
||
| You can do so [here](https://realmbot.dev/account). | ||
|
|
||
| `If the wrong account is getting connected to Realmbot go to https://www.xbox.com/live and login with the correct account there` | ||
|
|
||
| ## STEP TWO | ||
| After you have authorised your account to Realmbot the next step is to connect that account to Realmbot on your server | ||
|
|
||
| To connect your account to your guild run the `/connect` command in your guild | ||
|
|
||
|  | ||
|
|
||
| ## STEP THREE | ||
| After you have successfully linked your realm to your guild you can configure the bot like command permissions, ban logs, etc at our [dashboard](https://realmbot.dev) | ||
|
|
||
| To know more on how to set up via the dashboard check `dashboard` for info | ||
|
|
||
| This will explain in detail how to setup Realmbot for your realm! | ||
|
|
||
| ### Step 1 | ||
|
|
||
| - First, you need to authorize the Minecraft account that owns the realm to Realmbot. You can do so [here](https://realmbot.dev/account). | ||
|
|
||
| ### Step 2 | ||
|
|
||
| - Once you've authorized your account with Realmbot, the next step is to connect that account to Realmbot on your server. To do this, run the `/connect` command in your guild. | ||
| <br/> | ||
|
|
||
| ### Step 3 | ||
|
|
||
| - After successfully linking your realm to your guild, you can configure the bot, including command permissions and ban logs, at our [dashboard](https://realmbot.dev). | ||
| - For detailed instructions on setting up configurations via the dashboard, please refer to the 'dashboard' section for more information. |