Coder Social home page Coder Social logo

nepnep21 / corby Goto Github PK

View Code? Open in Web Editor NEW
1.0 0.0 0.0 366 KB

Discord bot that aims to log any events that occur in your discord server and to moderate it. Right now in active development.

Home Page: https://d1snin.xyz/corby

License: GNU General Public License v3.0

Java 100.00%

corby's Introduction

CodeFactor Build Status <ORG_NAME> License: GPL v3

corby pic

Corby:

Made in 🇷🇺 with ❤️.

Corby is a bot that aims to log any events that occur in your discord server and to moderate it, I am open to any of your pool requests

Right now in active development!

Instructions:

Here you can find instructions for use

Commands:

You can find the commands my bot supports on this web page.

Self hosting:

You can install and run my bot on your machine and use it for your own purposes, for this you need to create a configuration file named config.json. Then fill it in according to the following template:

{
  "token": "",
  "botPrefixDefault": "",
  "ownerId": "",
  "defaultCooldownSeconds": "",
  "emoteTrash": "",
  "emoteStar": "",
  "emoteWhiteCheckMark": "",
  "defaultStarboardStars": "",
  "defaultStarboardIsEnabled": "",
  "helpPageUrl": ""
}

Descriptions:

token - your bot token
bot_prefx_default - bot prefix
ownerId - your discord id
default_cooldowm_seconds - User cannot use more than one command at this time
emoteTrash - emote of waste bascket (unicode)
emoteStar - emote of star (unicode)
emoteWhiteCheckMark - emote of white check mark (unicode)
defaultStarboardStars - the number of stars required for a message to appear on the starboard
defaultStarboardIsEnabled - (boolean) default toggle for the starboard on the server
helpPageUrl - link to the page with information about commands

An example of writing config.json

{
  "token": "aaaaaaaaaaaaabbbbbbbbbccccccccccccccccdddddd",
  "botPrefixDefault": "!",
  "ownerId": "111111111111111111",
  "defaultCooldownSeconds": "2",
  "emoteTrash": "\uD83D\uDDD1",
  "emoteStar": "",
  "emoteWhiteCheckMark": "",
  "defaultStarboardStars": "3",
  "defaultStarboardIsEnabled": "false",
  "helpPageUrl": "https://d1snin.xyz/corby/"
}

The next step you need to create a database and execute a script for this database to make it work for the bot and add the database file with the extension .db along the path corby/src/main/resources/corby.db.

It must have a name corby.db as shown above.

You can create an empty database via Intellij IDEA. Click on this tab

dbguide1

Now click on "+" to create a new database, then hover mouse over Data Source and select SQLite database.

dbguide2

Now fill in the required fields as shown below.

dbguide3

Follow this path scripts/setupdb.sql and copy the content of the script and paste it into the field to execute the request and click Execute. Move the database file along the path corby/src/main/resources.

dbguide4

dbguide5

Then you can start the bot with the command ./gradlew run.

Contributing:

I am open to any pull requests, just clone the repository and import gradle project. Please observe Google Java Style Guide. Also make sure you test your changes to work.

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.