Code Monkey home page Code Monkey logo

eros-bot's Introduction

eros banner

Travis (.org) branch GitHub package.json version (branch)

Eros Bot

Features

  • Realtime Character/Weapon information pulls from Kamihime PROJECT EN Fandom
  • Kamihime Database (Harem Scenes)
    • Only Kamihime EN (Nutaku) version is available.
    • Uses REST API (JSON) from Kamihime Database
  • Tweets updates from @Kamihime_EN
    • Customise the Twitter Channel with ?set twitterchannel <channel>
  • Enjoy staying in your server by gaining a grand title and EXPs with Leveling System
    • See level command for more info
  • Customise your server settings
    • See set command for more info
  • Save memos or notes with Tag system
    • See tag command for more info
  • Basic bot commands
    • See help command for more info for each command
    • See guide command for an in-depth guide for each command
  • Server-wide Customisable Prefix
    • Default Prefix: ? or @Eros (Mention)
  • DM the bot directly for commands without the default prefix
    • e.g: info Eros -tw
  • More to come�

Commands

For more information, see Bot Guide or say @Eros guide 5 when using the bot.

  • Server Settings
    • Main: set, settings
  • General
    • Main: help, guide, invite
  • Kamihime
    • Main: nsfw, leaderboard, hareminfo, info, list, search
  • Kamihime - Countdown
    • Main: countdown
  • Tag
    • Main: tag, tags
  • Fun
    • Main: ask, insult, say, mock, owo, quiz
  • Leveling System
    • Main: level
  • Utility
    • Main: memberinfo, serverinfo, ping, stats
    • Bot Owner: eval

Self-Hosting

  • Create a Bot Account
  • Eros requires at least Node 12 for runtime and MariaDB 10.1 for data persistence
    • Clone this repository [via command shell] after installing the requirements above
      • $ git clone https://github.com/gazmull/eros-bot.git
      • $ cd eros-bot
    • Run $ yarn (Before this, make sure Yarn and Build Tools (Windows) | Build Tools (Linux) are installed)
    • src must also be built
      • $ yarn --production=false
      • $ yarn run compile
  • Create an auth.js file and obtain the template from auth.example.js. They are documented by // comments to help set up the file
  • Create a database. If the following defaults from auth.js (database and usename) were not changed, everything below can be copied and pasted without an issue— make sure to replace texts with []
    • Before doing the steps below, please make sure db's properties has been properly configured for security purposes
    • $ mysql -u root, assuming the MariaDB setup has no password on root. If it has password, append -p
    • Execute every line once inside MariaDB CLI:
CREATE DATABASE `eros` CHARACTER SET = 'utf8' COLLATE = 'utf8_unicode_ci';
CREATE USER `eros`@`localhost` IDENTIFIED BY '[password in auth.js]';
GRANT ALL PRIVILEGES ON `eros`.* TO `eros`@`localhost`;
exit;
  • Run the bot!
    • Node: node .
    • Process Managers
      • Nodemon: $ yarn run dev:start
      • PM2: $ yarn run pm2

License

MIT

© 2018-present Euni (gazmull)

eros-bot's People

Contributors

gazmull avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

eros-bot's Issues

New Wiki Fields for Kamihime

Assist 2PU was added on Poseidon AW's release. Doesn't work similarly to Souls'.

Edit: Updated to New Wiki Fields for Kamihime not only due to Assist 2PU, but also due to 2nd Assist.

Maintenance Mode

Due to my declining interest in the game and the promise I broke (a simple bot) by adding complicated features: I'd like to announce that starting today, this bot will be on maintenance mode. This means that Eros will no longer be in development (e.g: new features) and will be updated only for bug fixes and security updates.

All development time for related projects will be allocated to KamihimeDB.

Actual Major Version Bump

2.0.0 was released only to be on compliance for breaking changes and on level with Kamihime Database@2.0.0, however I've been planning to rewrite Eros bot too. For the meantime I have to settle everything with the site repo (2.x) before starting this repo's rewrite.

Plans

  • Semver: 3.0.0
  • Language: Typescript

Status: #8

Revert pako dependency to zlib-sync

I realised that pako is a resource hog after monitoring the bot for a week. It seems that it also prevents the bot from sending messages or slows down the bot. Since zlib-sync wasn't updated to be compatible with Node 12, I had to change to pako, but now it looks like a blunder.

Make Glossary a Built-In Command

💪 More features for Eros and to give some attention on Glossary page.

Usage

?glossary <single character / word>

Single Character: Returns a list of terms with their definition starting with that character.
Word: Returns a definition.

Possible Aliases

dictionary, term, dict

Remove Reliance on SequelizeProvider

SequelizeProvider only takes more duplicate resources and should be removed. Sequelize is already enough with the operations. This will only affect the server settings commands.

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.