Skip to content

Commit

Permalink
Massive documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
parker02311 committed May 26, 2024
1 parent f548e8c commit 610a35b
Show file tree
Hide file tree
Showing 17 changed files with 173 additions and 23 deletions.
Binary file added docs/assets/create_pterodactyl_config.mp4
Binary file not shown.
Binary file added docs/assets/create_pterodactyl_env.mp4
Binary file not shown.
8 changes: 4 additions & 4 deletions docs/guide/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ We have a couple pre-made themes that you can use. You can also make your own th

??? tip "Default"
<figure markdown>
![Default Theme](/assets/themes/default.png)
![Default Theme](../assets/themes/default.png)
<figcaption>parker02311 (Inspired by Bootswatch)</figcaption>
</figure>

??? tip "Cyborg"
<figure markdown>
![Cyborg Theme](/assets/themes/cyborg.png)
![Cyborg Theme](../assets/themes/cyborg.png)
<figcaption>[Bootswatch](https://bootswatch.com/cyborg)</figcaption>
</figure>

??? tip "Catppuccin Latte"
<figure markdown>
![Catppuccin Latte Theme](/assets/themes/catppuccin_latte.png)
![Catppuccin Latte Theme](../assets/themes/catppuccin_latte.png)
<figcaption>[Catppuccin](https://catppuccin.com)</figcaption>
</figure>

??? tip "Catppuccin Mocha"
<figure markdown>
![Catppuccin Mocha Theme](/assets/themes/catppuccin_mocha.png)
![Catppuccin Mocha Theme](../assets/themes/catppuccin_mocha.png)
<figcaption>[Catppuccin](https://catppuccin.com)</figcaption>
</figure>
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ This system is still in development and is not ready for use. Use at your own ri

# Installation

Read the [Setup Guide](/setup/overview/) for more information.
Read the [Setup Guide](setup/overview.md) for more information.
3 changes: 2 additions & 1 deletion docs/setup/bot/hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ Obviously we recommend using our hosting service, but if you are unable to use i
## Pterodactyl Panel Hosting
If you host a pterodactyl panel you can download our egg for easy installation. You can find the egg [here](https://github.com/Redon-Tech/Redon-Hub/blob/main/pterodactyl-egg.json).

**This is the easiest other then Redon Hosting**
**This is the easiest other then Redon Hosting and Embotic**

## Recommended Hosting Providers
- [Redon Hosting](https://billing.redon.tech/) (Free[^1], Paid Plans Available)
- [Embotic](https://embotic.xyz/) (Provides preinstall for Redon Hub)
- [PebbleHost](https://pebblehost.com/bot-hosting) (Cheap, but does not provide preinstall for Redon Hub)

(I will add more as I find them, if you know of any please let me know in our Discord server)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors:
- parker02311
---

This guide is the next part after [setting up the database](/setup/bot/database). If you have not setup the database yet please do so before continuing.
This guide is the next part after [setting up the database](database.md). If you have not setup the database yet please do so before continuing.

## Creating the JSON File
The bot uses a mix of both a `config.json` and a `.env` file for configuration. The `config.json` file is used for configuration that is not sensitive and can be shared publicly. The `.env` file is used for sensitive information such as tokens and database connection strings. To create the `config.json` file we will copy the `example.config.json` file and rename it to `config.json`. We can do this with the following.
Expand Down Expand Up @@ -79,6 +79,6 @@ Now that we have our `config.json` file we can finish our `.env` file. To do thi
token=this_is_your_bot_token
```

[Next: Starting the Bot](/setup/bot/running){ .md-button .md-button--primary }
[Next: Starting the Bot](running.md){ .md-button .md-button--primary }

[^1]: The first guild in this list will also be the guild the bot will use for customer roles and the purchase channel.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors:
- parker02311
---

This guide is the next part after [installing the system](/setup/bot/setup). If you have not installed the system yet please do so before continuing.
This guide is the next part after [installing the system](setup.md). If you have not installed the system yet please do so before continuing.

!!! warning

Expand Down Expand Up @@ -84,4 +84,4 @@ We use [Prisma](https://www.prisma.io/) to manage our database. To setup Prisma
# Using db push is not always the best way to do this, however it is the easiest.
python3 -m prisma db push --schema mongodb-schema.prisma
```
[Next: Configuration](/setup/bot/configuration){ .md-button .md-button--primary }
[Next: Configuration](configuration.md){ .md-button .md-button--primary }
4 changes: 2 additions & 2 deletions docs/setup/bot/running.md → docs/setup/bot/local/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors:
- parker02311
---

This guide is the next part after [configuration](/setup/bot/configuration). If you have not configured the bot yet please do so before continuing.
This guide is the next part after [configuration](configuration.md). If you have not configured the bot yet please do so before continuing.

## Running the Bot
The easiest part of this entire guide, running the bot. To run the bot we will use the following command.
Expand All @@ -26,4 +26,4 @@ The easiest part of this entire guide, running the bot. To run the bot we will u
I will not be providing any support with port forwarding, I recommend you use a hosting service. If you are unable to figure out how to use a hosting service [we provide one](https://billing.redon.tech).

## Next Steps
Now that you have the bot running you can start using it. If you need help with commands see [commands guide](/guides/commands) to get a list of commands. If you need help with anything else you can ask in our [Discord](https://discord.gg/Eb384Xw) server.
Now that you have the bot running you can start using it. If you need help with commands see [commands guide](../../../guide/commands.md) to get a list of commands. If you need help with anything else you can ask in our [Discord](https://discord.gg/Eb384Xw) server.
2 changes: 1 addition & 1 deletion docs/setup/bot/setup.md → docs/setup/bot/local/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Before we get to setting up our database and configuring the bot we must first i
pip install -U -r requirements.txt
```

[Next: Database Setup](/setup/bot/database){ .md-button .md-button--primary }
[Next: Database Setup](database.md){ .md-button .md-button--primary }
78 changes: 78 additions & 0 deletions docs/setup/bot/pterodactyl/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
authors:
- parker02311
---

This guide is the next part after [setting up the database](database.md). If you have not setup the database yet please do so before continuing.

## Creating the JSON File
The bot uses a mix of both a `config.json` and a `.env` file for configuration. The `config.json` file is used for configuration that is not sensitive and can be shared publicly. The `.env` file is used for sensitive information such as tokens and database connection strings. To create the `config.json` file we will copy the `example.config.json` file and rename it to `config.json`. We can do this with the following.
<video width="1920" height="1080" controls>
<source src="/assets/create_pterodactyl_config.mp4" type="video/mp4">
</video>

## Configuration Explained
Now that we have our `config.json` file we can start configuring it. Below is a list of all the options and what they do.
```json
{
"Bot": {
"Prefix": ".",
"Guilds": [
1234567890
],
"Owners": [
1234567890
],
"Activity": {
"Presence": "watching {users:,} costumers • Version {version}",
"Status": "online"
}
},
"Logging": {
"PurchasesChannel": 1234567890,
"GlobalCustomerRole": 1234567890
},
"Data": {
"Database": "mysql|postgresql|mongodb|"
},
"API": {
"IP": "0.0.0.0",
"Port": 5000,
"Key": "CHANGEME"
}
}
```

- Bot:
- Prefix: ~~The prefix the bot will use for commands.~~ **(Unused)**
- Guilds: A list of guilds the slash commands will be in.[^1]
- Owners: A list of user IDs that will be able to use owner commands.
- Activity:
- Presence: The presence the bot will use. Supports the following variables:
- `{users:,}`: The number of users in the database.
- `{guilds:,}`: The number of guilds the bot is in.
- `{version}`: The version of the bot.
- `{prefix}`: ~~The prefix of the bot.~~ **(Unused)**
- Status: The status the bot will use. [Learn More](https://discordpy.readthedocs.io/en/stable/api.html#discord.Status "discord.Status")
- Logging:
- PurchasesChannel: The channel ID of the channel the bot will log purchases in.
- GlobalCustomerRole: The role ID of the role the bot will give to customers of all products.
- Data:
- Database: The type of database being used. If you are using MariaDB make sure to use `mysql`.
- API:
- IP: The IP the API will listen on. (Best left as `"0.0.0.0"`)
- Port: The port the API will listen on. (This port must be open to the internet)
- Key: The key the API will use for authentication. (This key must be kept secret)


## Finishing the .env file

Now that we have our `config.json` file we can finish our `.env` file. To do this we will add the following to the `.env` file. Replace the values with your own.

```bash
token=this_is_your_bot_token
```

[Next: Starting the Bot](running.md){ .md-button .md-button--primary }

[^1]: The first guild in this list will also be the guild the bot will use for customer roles and the purchase channel.
35 changes: 35 additions & 0 deletions docs/setup/bot/pterodactyl/database.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
authors:
- parker02311
---

This guide is the next part after [installing the system](setup.md). If you have not installed the system yet please do so before continuing.

!!! warning

The Pterodactyl egg is designed for MySQL (MariaDB) only. If you are using a different database the hosting provider will need to modify your egg.

### Connection String
After you have choosen the database type you are going to use, make the connector string and save it for later. You will need it in the next step. [Get help with connection strings](https://www.prisma.io/docs/reference/database-reference/connection-urls)

??? example

```
mysql://USER:PASSWORD@HOST:PORT/DATABASE
```

## Setting Up ENV Variables
Now that we have our database setup we need to configure the bot to use it. To do this we will use a .env file. This file will contain all of our environment variables that the bot will use. To create the .env file we can do the following.
<video width="1920" height="1080" controls>
<source src="/assets/create_pterodactyl_env.mp4" type="video/mp4">
</video>

Replace the values with your own.

## Using Prisma
We use [Prisma](https://www.prisma.io/) to manage our database. To setup Prisma we will do the following.

1. Click the "Startup" tab.
2. Enable "DB Push".

[Next: Configuration](configuration.md){ .md-button .md-button--primary }
17 changes: 17 additions & 0 deletions docs/setup/bot/pterodactyl/running.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
authors:
- parker02311
---

This guide is the next part after [configuration](configuration.md). If you have not configured the bot yet please do so before continuing.

## Running the Bot
The easiest part of this entire guide, running the bot. To run the bot we will do the following:

1. Click the "Console" tab.
2. Click "Start" to start the bot.
3. After the bot has started go back to the "Startup" tab.
4. Disable "DB Push".

## Next Steps
Now that you have the bot running you can start using it. If you need help with commands see [commands guide](../../../guide/commands.md) to get a list of commands. If you need help with anything else you can ask in our [Discord](https://discord.gg/Eb384Xw) server.
12 changes: 12 additions & 0 deletions docs/setup/bot/pterodactyl/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
authors:
- parker02311
---

Before we get to setting up our database and configuring the bot we must first install the system. This is different depending on each hosting provider but the process will generally be the same.

1. You need to purchase a Redon Hub server from your hosting provider, every provider does this in a different way.
2. Once you have purchased a Redon Hub server you need to login and familiarize yourself with the panel.
3. Next you will need to setup a database, this is also dependent on your provider, consult their documentation.

[Next: Database Setup](database.md){ .md-button .md-button--primary }
5 changes: 3 additions & 2 deletions docs/setup/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ Redon Hub is designed to be as easy as possible to use. However, it is still a c

I will not be providing any support with port forwarding, I recommend you use a hosting service. If you are unable to figure out how to use a hosting service [we provide one](https://billing.redon.tech).

[Roblox Setup](/setup/roblox/setup){ .md-button .md-button--primary }
[Setup Bot](/setup/bot/setup){ .md-button .md-button--primary }
[Roblox Setup](roblox/setup.md){ .md-button .md-button--primary }
[Setup Bot](bot/local/setup.md){ .md-button .md-button--primary }
[Setup Bot on Pterodactyl](bot/pterodactyl/setup.md){ .md-button .md-button--primary }
2 changes: 1 addition & 1 deletion docs/setup/roblox/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors:
- parker02311
---

This guide is the next part after [setting up the place](/setup/roblox/setup). If you have not setup a place yet please do so before continuing.
This guide is the next part after [setting up the place](setup.md). If you have not setup a place yet please do so before continuing.

## Finding the Configuration module
The configuration file is located in ServerScriptService under the name `Configuration`. You can find it by searching for it in the explorer.
Expand Down
6 changes: 3 additions & 3 deletions docs/setup/roblox/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ authors:
- parker02311
---

Setting up the Roblox place is much easier than setting up the bot. Before you can start setting up your Roblox place you must make sure that your API can be accessed by the entire internet and not just your local network. If you can not figure out how to you will need to use [a hosting provider](/setup/bot/hosting).
Setting up the Roblox place is much easier than setting up the bot. Before you can start setting up your Roblox place you must make sure that your API can be accessed by the entire internet and not just your local network. If you can not figure out how to you will need to use [a hosting provider](../bot/hosting.md).

1. [Select a theme](/guide/themes)
1. [Select a theme](../../guide/themes.md)
2. [Download latest release of theme](https://github.com/Redon-Tech/Redon-Hub/releases/latest)
3. Publish the place to Roblox

[Next: Configuration](/setup/roblox/configuration){ .md-button .md-button--primary }
[Next: Configuration](configuration.md){ .md-button .md-button--primary }
14 changes: 10 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,17 @@ nav:
- Setup:
- setup/overview.md
- Bot:
- setup/bot/setup.md
- Database Setup: setup/bot/database.md
- Configuration: setup/bot/configuration.md
- Starting the Bot: setup/bot/running.md
- Hosting: setup/bot/hosting.md
- Self Hosted:
- setup/bot/local/setup.md
- Database Setup: setup/bot/local/database.md
- Configuration: setup/bot/local/configuration.md
- Starting the Bot: setup/bot/local/running.md
- Pterodactyl:
- setup/bot/pterodactyl/setup.md
- Database Setup: setup/bot/pterodactyl/database.md
- Configuration: setup/bot/pterodactyl/configuration.md
- Starting the Bot: setup/bot/pterodactyl/running.md
- Roblox:
- setup/roblox/setup.md
- Configuration: setup/roblox/configuration.md
Expand Down

0 comments on commit 610a35b

Please sign in to comment.