Skip to content

NoxGamingQC/NoxBOT

Repository files navigation

NoxBOT

A multitasking Discord Bot.

Type State Repo size License Travis build Snyk security Code Climate maintainability

Table of Contents

General Information

  • A list of feature will be added soon on our website.

Setup

Setting up your environement

Technology used

Below is a list of technology that we used. For some package you might need to verify the version you have installed, it might be required.

DiscordJS NPM NodeJS Discord account

Windows 10 environement setup

  • Activate the developper mode on Windows 10
  • Navigate to "Activate or desactivate Windows functionality"
  • Check "Sub-system Windows for Linux (beta)"
  • Open Linux commandline
  • Install git: sudo apt-get install git
  • Install ssh: sudo apt-get install ssh
  • Install npm: sudo apt-get install npm
  • Generate an ssh key: ssh keygen
  • Accept the default location
  • Enter a password
  • Retype your password to confirm it
  • Check if the ssh folder contain the key: ls ~/.ssh
  • Display the ssh key: ~/.ssh/id_rsa.pub

Ubuntu environement setup

  • Open a terminal
  • Install git: sudo apt-get install git
  • Install ssh: sudo apt-get install ssh
  • Install npm: sudo apt-get install npm
  • Generate an ssh key: ssh keygen
  • Accept the default location
  • Enter a password
  • Retype your password to confirm it
  • Check if the ssh folder contain the key: ls ~/.ssh
  • Display the ssh key: ~/.ssh/id_rsa.pub

Step

  • Create a new repository
  • Navigate into the new repository
  • Fork the project
  • Import the git repository into it git remote add origin <repository_git_url>
  • Duplicate config.json.exemple and name it config.json
  • Go to Discord devloppers website and create a new app
  • Make the app a bot user
  • Replace the token line by your discord bot token
  • Install the node_modules npm install
  • The bot should work if there any issue report it on the main repository Link at the bottom of the page

Usage

To start the bot simply run

npm start

Project Status

Project is: in progress

To do

Acknowledgements

GitHub Website

Author

NoxGamingQC

Contributors

Gouliram

License

This project is open source and available under the MIT License.