Merge remote-tracking branch 'origin/main'

README.md

@@ -1,34 +1,40 @@
-# discord_auto_voice_channel
+# auto-voice-channel
+### A Discord bot that allows users to create voice channels when needed.
 ![](https://img.shields.io/pypi/pyversions/nextcord?style=flat-square)
 ![](https://img.shields.io/github/release-date-pre/HongWonYul/discord_auto_voice_channel?style=flat-square)
 ![](https://img.shields.io/github/downloads/HongWonYul/discord_auto_voice_channel/total?style=flat-square)
 ![](https://img.shields.io/github/license/hongwonyul/discord_auto_voice_channel?style=flat-square)
 
-This project is in development, but it is still usable.
+* Offical Bot(Korean): [Invite](https://discord.com/api/oauth2/authorize?client_id=1024514599216746496&permissions=75792&scope=bot%20applications.commands)
 
-This is a Discord bot that will allow users to create auto voice channels, so when the user joins the auto voice channel, the bot will automatically generate a voice channel for them.
-This project uses Redis to store data, so it is swift and fully scalable using shards in the future.
+This Discord bot will allow users to create auto voice channels without giving them edit channel permission. The bot will automatically generate a voice channel when the user joins the auto voice channel (previously set by the administrator). One of the most significant strengths is that this project uses Redis to store data, meaning swifter than using a traditional database and fully scalable in the future. Also, all of the messages are easily editable in [language.ini](https://github.com/HongWonYul/auto-voice-channel/blob/main/language.ini])
 
 ## Requirments
-Redis server
+* [Python 3.8+](https://www.python.org/downloads/)
+* [Redis server](https://redis.io/docs/getting-started/)
 
-Python packages: Redis, nextcord
+**Python packages**
+
+* [Redis](https://pypi.org/project/redis/) (`pip install redis`)
+* [Nextcord](https://pypi.org/project/nextcord/) (`pip install nextcord`)
 
 ## Setup
-1. Go to https://discord.com/developers/applications and create an application.
-2. Press the bot on the left menu and the "activate bot" button.
-3. Navigate the "Privileged Gateway Intents" section in the bot menu and check all intents.
-4. Press the "reset token" button at the top and save the token for later.
-5. Install the Redis server or get hosting for it. Check https://redis.io/docs/getting-started/ for more info.
-5. Copy this repository.
-6. Open config.ini and replace "YOUR_TOKEN_HERE" with the discord bot token you got in step 4.
-7. Replace "YOUR_ID_HERE" with discord ID (Not tag)
-8. If you just installed the Redis client on your computer and did not make any changes, delete "YOUR_PASSWORD_HERE."
-9. You must edit the host, port, and password accordingly if using an external Redis server.
-10. Change the bot's state message by editing config under SETTINGS.
-11. You can customize all messages and the command's name by editing the language.ino
-12. Run main.py
-13. Invite your bot and enjoy!
+1. Clone the repository. (`git clone https://github.com/HongWonYul/auto-voice-channel.git`)
+2. Go to https://discord.com/developers/applications and create an application.
+3. Press the bot on the left menu and the "activate bot" button.
+4. Navigate the "Privileged Gateway Intents" section in the bot menu and check all intents.
+5. Press the "reset token" button at the top and save the token for later.
+6. Install the Redis server or get hosting for it. Check [here](https://redis.io/docs/getting-started/) for more info.
+7. Open config.ini and replace `YOUR_TOKEN_HERE` with the discord bot token you got in step 4.
+8. Replace `YOUR_ID_HERE` with discord ID (Not tag)
+9. Edit the Redis config.
+* If you just installed the Redis client on your computer and did not make any changes, delete `YOUR_PASSWORD_HERE.` and leave it as a blank.
+* If you are using an external Redis server, you must edit the host, port, and password accordingly.
+  * This is not recommended since this bot takes advantage of the fast speed of the Redis server, and running the database and bot on a separate machine creates network latency.
+12. Change the bot's state message by editing config under SETTINGS.
+13. You can customize all messages and the command's name by editing the language.ino
+14. Run main.py
+15. Invite your bot and enjoy!
 
 ## Commands
 
@@ -39,3 +45,5 @@ Python packages: Redis, nextcord
 /list - View all acvive automatic voice channel.
 
 /clear - Delets all channels created by the bot. (In case of the bot going offline for a bit)
+
+/help - Shows a list of all commands or information about a specific command.