Skip to content

Commit

Permalink
fix readme?
Browse files Browse the repository at this point in the history
  • Loading branch information
Two-Play committed Nov 27, 2024
1 parent b4e6223 commit 6b6d645
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@

## Introduction

> [!WARNING] This project is still in development and is not yet ready for production use. Please use it at your own risk.
> [!WARNING]
> This project is still in development and is not yet ready for production use. Please use it at your own risk.
This is a Discord bot that is designed to control the Crafty-Controller-4 server. This is useful if friends want to start a server and you want to control it from Discord.
The bot is written in Python and uses the Discord.py library to interact with the
Expand Down Expand Up @@ -71,8 +72,6 @@ server and obtain the user token. You can do this by following these steps:
- COMMANDS
- TERMINAL
- PLAYERS
> [!IMPORTANT] I don't know if the permissions are correct, but you can try it out. If it doesn't work, please let me know.
You can also use the "ALL" permission, but this is not recommended for security reasons.
7. Enter a name for your user token (for example, "Crafty Bot Token")
8. Click on "Create" to generate the user token
9. Save your user token in a safe place (you will need it later)
Expand All @@ -81,6 +80,10 @@ server and obtain the user token. You can do this by following these steps:

You will need to create a new Discord bot and obtain a bot token. You can do this by following these steps:

> [!IMPORTANT]
> I don't know if the permissions are correct, but you can try it out. If it doesn't work, please let me know.
You can also use the "ALL" permission, but this is not recommended for security reasons.

1. Go to the [Discord Developer Portal](https://discord.com/developers/applications)
2. Click on "New Application"
3. Enter a name for your bot (for example, "Crafty Bot")
Expand All @@ -101,8 +104,6 @@ You will need to create a new Discord bot and obtain a bot token. You can do thi
- Use slash commands
- Read Message History
- Mention Everyone
> [!IMPORTANT] I don't know if the permissions are correct, but you can try it out. If it doesn't work, please let me know.
You can also use the "ALL / Administration" permission, but this is not recommended for security reasons.
15. Click on "Copy" under "OAuth2 URL" to copy the invite URL
16. Paste the invite URL into your web browser
17. Select the server you want to invite the bot to
Expand All @@ -115,7 +116,8 @@ Congratulations! Your bot has been invited to your server
Installing the bot using Docker is the easiest way to get started. To do this, you will need to have Docker installed on your system. If you do not have Docker installed, you can download it from the [official Docker website](https://www.docker.com/get-started).


> [!CAUTION] Replace `YOUR_DISCORD_TOKEN` with your Discord bot token, `YOUR_CRAFTY_TOKEN` with your Crafty Controller API token and `YOUR_CRAFTY_SERVER_URL` with the URL of your Crafty Controller server in
> [!CAUTION]
> Replace `YOUR_DISCORD_TOKEN` with your Discord bot token, `YOUR_CRAFTY_TOKEN` with your Crafty Controller API token and `YOUR_CRAFTY_SERVER_URL` with the URL of your Crafty Controller server in
the following format: `https://your-crafty-server-IP:PORT`.

To install the bot using Docker, you will need to run the following command in your terminal:
Expand Down

0 comments on commit 6b6d645

Please sign in to comment.