JamesBie/wall_e

★ 0Forks 0PythonGitHub ↗Compare

README

Wall-E

The One and Only, Lovable Wall-E

This repo will hold all the scripts for the upcoming bot that will operate on the CSSS discord, located here. This bot is owned by the CSSS and will be maintained for the most part by the current CSSS appointed Discord representative and the current bot development team.

It is a namesake of the lovable Wall-E.

Table of Contents

Current Commands

  • .ping - returns pong!
  • .echo <arg> - returns <arg>
  • .newrole <arg> - creates role <arg>
  • .iam <arg> - adds you to role <arg>
  • .iamn <arg> - removes you from role <arg>
  • .whois <arg> - returns everyone who has role <arg>
  • .poll <arg> - starts a yes/no poll where <arg> is the question
  • .poll <arg0> <arg1> <arg2> (up to 12 arguments) - starts a poll where <arg0> is the question and the remaining arguments are the options

Local Setup

Current-Setup Info

Server IP: 178.128.184.141
For access to the jenkins, notify someone on the following list:

Follow steps outlined in the README for machine setup steps to prepare the machine to support CI/CD

Follow these steps to run the bot and do development on your local machine.

Part 1: Authentication

Pre-requisites: A Discord account.

  1. Create your own Discord server for testing
  2. Navigate to https://discordapp.com/developers/applications/me and login
  3. Click New App
  4. Name your app to whatever you wish then click Create App
  5. Save the Client ID under the App Details
  6. Scroll down, click Create a Bot User and confirm
  7. Within the new Bot section of the dashboard, click click to reveal, and save the token
  8. Naviate to https://discordapp.com/oauth2/authorize?&client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=0 and replace YOUR_CLIENT_ID_HERE with the client ID of your bot
  9. Select the server you created and click Authorize

Part 2: Running the Bot

Pre-requisites: git, python3, and pip3.

  1. Run git clone https://github.com/CSSS/wall_e.git && cd wall_e
  2. Run pip3 install -r requirements.txt
  3. Run TOKEN= the token you previously obtained
  4. Run python3 main.py

Contributors

wnfldchenmodernNeopjalali

Issues