Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Latest commit

 

History

History
43 lines (33 loc) · 1.42 KB

README.md

File metadata and controls

43 lines (33 loc) · 1.42 KB
Raw

oRO-Bot

A simple Discord-Bot to handle information received from originsro.org API and other stuff.

Purpose

oRO-Bot is designed as a discord bot providing commands helping to organize guild stuff and get info from originsRO-Database/API.

oRO-Bot's current feature set includes:

  • !help command - show available commands
  • !build command (WIP) - shows available character builds

Architecture

oRO-Bot is a modular discord bot.

Entrypoint: /src/index.js Modules: /src/modules/ Library: /src/lib/ Modules: see Modules

Building

Prerequisits:

  • NodeJS
  • NPM (mostly bundled with NodeJS)
  • Docker
  • docker-compose

Get Started:

  • Copy docker-compose.yml.example and save the copy as docker-compose.yml
  • Adjust the config fields to your needs
  • Copy /src/config.json.example and save the copy as config.json
  • Adjust the values to your needs

Run:

  • npm run bot - shorthand for npm install && docker-compose up -d && node /src/index.js

Changelog

[0.0.1]

  • Added base architecture
  • Added module help
  • Added module build (WIP)

License

oRO-Bot is licensed under MIT so that the core functionality of the bot remains open source and free for everyone but any code you write (including server and room IDs for example) for your own Discord servers doesn't have to be.