diff --git a/readme.md b/readme.md index f1ec7a4..8d6becb 100644 --- a/readme.md +++ b/readme.md @@ -1,46 +1,81 @@ +# Chappie Server BOT ---------------------------------------------------------------------------------------- -Clone this repository Need help cloning? Visit Help. +- Python and the library resources [Here](https://pythondiscord.com/pages/resources) +- Clone/Download the repository - ``git clone`` -https://git.codingvm.codes/dieantwoord/Discord-Bot-Python.git +```shell +$ git clone https://github.com/Die-Antwoord/lazybot.git +$ cd ./lazybot +``` ---------------------------------------------------------------------------------------- -Creating a new repository on the command line +## Create Bot + +- Create a Discord Bot: [HERE](https://discord.com/developers/applications) +- Permission Generator: [HERE](https://discordapi.com/permissions.html) +- Invite Your Bot: + +## Create config.json & .env + +- Create [config.json](config.json) & [.env](.env)file in the root directory. +- Here is an explanation of what everything is: [demo.config.json](demo.config.json) & [demo.env](demo.env) +- Example: + +[demo.config.json](demo.config.json) +```json +{ + "prefix": "YOUR_BOT_PREFIX_HERE", // '.' or '!' Whatever you specify + "token": "YOUR_BOT_TOKEN_HERE", // Bot Token here + "permissions": "YOUR_BOT_PERMISSIONS_HERE", // Example '8' or '1024' https://discordapi.com/permissions.html + "application_id": "YOUR_APPLICATION_ID_HERE ", // Bot ID + "sync_commands_globally": true, + "owners": [ + YOUR_OWNERS_ID_HERE, + YOUR_OWNERS_ID_HERE + ], // Owners ID here 'can be more than one separated with ',' + "TOMORROWIO_TOKEN": "WEATHER_API_TOKEN", //http://api.timezonedb.com/v2.1/get-time-zone + "allowguilds": [GUILD_ID_ALLOWED], //GUILD Allowed to use the bot + "guildmsgdisable": [GUILD_ID_DISALLOW_MESSAGES], //GUILDS to where the bot should not respond to + "roles": [JOIN_ROLE_ID], //ROLES that member gain at GUILD_JOIN + "welcome_mention": [ROLE_ID_ON_USER_JOIN] // ROLE_ID that will be mentioned as a member join the server +} ``` -touch README.md + +[demo.env](demo.env) +```env +TOKEN=YOUR_BOT_TOKEN_HERE +Webhook=YOUR_WEBHOOK_HERE ``` +## Dependences + +- [PYTHON](https://www.python.org/downloads/) + +## Install BOT Requirements + +- RUN in Command-Promt + +```shell +$ pip install -r requirements.txt ``` -git init + +## Run BOT + +- If you have just installed python today, then you just need to use the following command: + +```shell +$ python bot.py ``` + +- If you have multiple versions of python installed (2.x and 3.x) then you will need to use the following command: + +```shell +$ python3 bot.py ``` -git checkout -b main + +- or eventually + +```shell +$ python3.x bot.py ``` -``` -git add README.md -``` -``` -git commit -a -m "first commit" -``` -``` -git remote add origin https://git.codingvm.codes/dieantwoord/Discord-Bot-Python.git -``` -``` -git push -u origin main -``` ---------------------------------------------------------------------------------------- -Pushing an existing repository from the command line -``` -git remote add origin https://git.codingvm.codes/dieantwoord/Discord-Bot-Python.git -``` -``` -git push -u origin main -``` ---------------------------------------------------------------------------------------- -Update changes -``` -git commit -a -m "Update to main" -``` -``` -git push -u origin main -``` ---------------------------------------------------------------------------------------- + +- Replace `x` with the version of Python you have installed. +