GithubHelp home page GithubHelp logo

ethiabot's Introduction

Ethiabot

This is a discord bot who's main purpose is to send different kinds of gifs. It is customisable and has a shared gif library to use at json.ethiabot.ovh. Run it whenever you want or forever on a server, with your own profile pic !

This bot is mostly in french, I haven't translated it yet, but if you want to contribute, feel free to do so !

Getting Started

These instructions will make you able to run a wonderful instance of this bot on your local machine or on a remote server ! I assume you know how to administrate your machine and are able to make your own decisions if you have a doubt, otherwise, message me if you are not sure about anything !

Prerequisites

First thing you need is a working node.js server. Download links and install instructions are available on Node's official website.

Once it is installed, you should also have NPM installed as well. Please check both node and npm are in your system's Path, it will simplify a lot of things.

Then, you will need build tools for C++ and Python. On Windows, you can install them all by opening a Command Prompt as administrator and running :

npm install windows-build-tools --global --add-python-to-path

You may need to reboot your computer once it is done.

Then, go to discord's developer page. Login if you aren't logged yet.

Click on New App and name your beautiful bot. You also can set it's profile pic right now, or you can do it later, as you wish. Just click on Create App once first parameters are okay.

You are now ready to create the bot as a Discord Entity.

Click on Create a Bot user and FOR GOD'S SAKE YES DO IT STOP SAYING HOW DANGEROUS IT IS. Ahem.

Note that a Click to reveal Link now has appeared next to a Token label. You will need this token later so when you read "your Bot User's token", this is what it is about.

Then, you can add your to-be-born bot to your server using the link given by Discord's documentation. Just remember to change change the client id in the url by your bot's Client ID in the App Details block. Client ID is NOT the same as Token !

Follow the instructions and voila ! You are finally able to install this bot !

Installing

Clone or download this repo into wherever is most convenient for you.

Using a Command Prompt or Terminal instance, go to this bot's folder, where the package.json and bot.js files are.

Run :

npm install

NPM will download and install every dependencies it needs to run our magnificent bot.

Then, create a copy of settings-dist.json and rename it settings.json and open it with your favourite text editor.

Just like any json file, it uses JSON's synthax to set you bot's settings.

prefix is what the bot will detect to know you're typing a command and not a regular message. Default is ;.

adminusers is an object which contains every administrator's user ids as "000000000000000000": 000000000000000000. There can be as many admin users as you want. To know a user's id, simply turn your discord's Developer Mode on, right click on the user and click on Copy ID.

token is your Bot User's token. It is absolutely required !

welcomechan is the chan where you'd like the bot to welcome and say goodbye to new or leaving users. Disable by leaving blank.

helpintro is the begining of the help message. Leave blank if you don't want any.

helpoutro is the same but at the end.

jsonaddress is the address you want the bot to go and find the JSON files. Default is json.ethiabot.ovh.

welcomemessage is the message you want the bot to send when a new user comes to your Discord. User {{memberid}} to display user's id. It is useful to mark the user by writing <@{{memberid}}>.

goodbyemessage is the same but when user leaves.

Built With

Contributing

Well, you're free to fork and have fun with this bot ! If you want me to pull your fork, just message me and we'll talk about it !

Authors

  • Baka Killer : The best developper on this project so far (which isn't hard, I admit)

License

This project is licensed under the Beerware License - see the LICENSE.md file for details

ethiabot's People

Contributors

bakakiller avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.