From 31c53c9ae009f3160801e7665849915700cfb474 Mon Sep 17 00:00:00 2001 From: LauraOrchid Date: Sat, 23 Jul 2022 21:30:05 +0000 Subject: [PATCH] Update 'README.md' <3 --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1c5449b..66cb688 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Discord-Linx Discord.JS v14 Base Template +# LauraXD Base Code Only 3 dependencies required to run this bot! @@ -6,7 +6,7 @@ Message intents are NOT supported in this bot, this is due to the verification t Structure: -**commands** - This folder contains commands +**commands/Info** - This folder contains commands **event** - This folder contains files related to discord.js events. (Like "ready", "interactionCreate") @@ -14,22 +14,26 @@ Structure: **index.js** - This is the main file to run the bot. +# Usage +1) Clone this repo: ```git clone https://git.codingvm.codes/LauraOrchid/LauraXD.git``` -1) Use ```npm i ``` +2) ```cd lauraxd``` -2) Create a .env file ``` touch .env``` +3) Use ```npm init ``` + +4) Install dependencies: ```npm install discord.js dotenv glob format-duration``` + +5) ```nano .env``` and put this: -3) Edit .env ``` -TOKEN = token +TOKEN="your bot token here" ``` -4) Go to Handler -- > index.js and change "GUIDIDHERE" to your Discord Servers Guild ID +4) ```nano lauraxd/handler/index.js``` and change "GUIDIDHERE" to your Discord Server's Guild ID -5) Go into https://discord.com/developers/applications and enable Privlaged Intents. +5) Go into https://discord.com/developers/applications and enable all 3 intents (presence, members, and message content) in your application. -6) Run the bot ```node index.js``` +6) ```cd ../..``` (go back to root path of the bot directory) and run the bot: ```node index.js``` - -Want to make this better? Issue a pull request! +Have fun! -Laura 💖