Initial commit

Author: TimeWaster

.babelrc

@@ -0,0 +1,5 @@
+{   
+  "presets": [
+    "@babel/preset-env"   
+  ] 
+}

.gitignore

@@ -0,0 +1,104 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port

.prettierrc

@@ -0,0 +1,14 @@
+{
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "singleQuote": true,
+    "printWidth": 200,
+    "overrides": [
+        {
+            "files": "*.md",
+            "options": {
+                "tabWidth": 2
+            }
+        }
+    ]
+}

README.md

@@ -0,0 +1,86 @@
+# HomarusBot
+
+A reaction Bot for Discord Servers running on NodeJS that is configured (Programmed) in JavaScript, making it extremely flexible.
+
+## General Info
+
+This Bot is intended to:
+
+- Be used by programmers and therefore has no configuration GUI or Website, all rules are defined in JavaScript code
+- Be run on a Root Server hosted by the user itself
+
+If you don't know what that means then this Bot is not for you.
+
+I will give no support for code that is written by the user itself or concerns the underlying Discord.js project.
+
+This Bot uses the framework Discord.js: [Discord.js](https://discord.js.org/#/)
+
+[Discord.js Documentation](https://discord.js.org/#/docs/main/stable/general/welcome)
+
+Only one Bot can run at a time with the same Bot Token, the start/stop scripts enforce that.
+
+It is best to run the Bot on a Root Server for performance, but it can be run from a private computer.
+
+### Where is what
+
+| Where                                                     | What                                                  |
+| --------------------------------------------------------- | ----------------------------------------------------- |
+| config.js                                                 | The configuration of the Bot                          |
+| [rules/README.md](rules/README.md)                        | Rules documentation, please read                      |
+| start.sh + stop.sh + start-dev.sh | Linux bash scripts to maintain the Server             |
+| src/server.js                                     | The underlying code that instantiates the Bot         |
+| src/utils/                                                | General utils                                         |
+| src/handlers                                              | The handlers for different types of Discord.js events |
+
+See the [List of events](https://discord.js.org/#/docs/main/stable/class/Client?scrollTo=e-channelCreate) for more information.
+
+## Prerequisites
+
+HomarusBot can be run on any OS, but Linux works best and the included shell scripts only work on Linux, with a bit of luck also on OSX.
+
+On Linux or OSX "screen" needs to be installed to be able to use the included start/stop scripts.
+
+NodeJS v14 or higher is needed.
+
+## Installation
+
+```bash
+sudo apt install git screen nodejs npm # For distros that don't use apt see your distros help page.
+
+cd  /home/directory/you/want/
+git clone [email protected]:SebiTimeWaster/HomarusBot.git
+cd HomarusBot
+npm install
+```
+
+It is best to create a seperate user account to run the Bot on.
+
+## Adding the Bot to a Discord Server
+
+- [Setting up a bot application](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot).
+- Open this url in your browser: `https://discordapp.com/oauth2/authorize?client_id=_APPLICATION-ID_&scope=bot&permissions=452672`
+
+  "_APPLICATION-ID_" needs to be replaced with the Application ID that was generated under "Setting up a bot application".
+
+- Configure your Bot in `config.js`, don't forget to add the Bot Token (Which is not the same as the Application ID!).
+
+## Start / Stop
+
+```bash
+cd /home/directory/you/want/HomarusBot
+./start.sh
+./stop.sh
+```
+
+`start-dev.sh` runs the Bot directly in shell with a higher verbosity, only meant for development work.
+
+`log/homarusbot.log` contains the logs from the running Bot or last run of the Bot (not used with `start-dev.sh`).
+
+## Keeping dependencies up-to-date
+
+```bash
+cd /home/directory/you/want/HomarusBot
+./stop.sh
+npm update
+./start.sh
+```

config.js

@@ -0,0 +1,11 @@
+// General configuration
+export default {
+    botToken: '', // the discord bot token
+    commandPrefix: '!', // the prefix used for commands defined in the rule files
+    adminChannelID: '', // the channel where administrative messages (responses.admin) will be sent to
+    rules: {
+        // which rule files should be loaded on startup. order is important and as a rule of thumb it should be: policing, commands, everything else
+        message: ['policing', 'help', 'various'],
+        messageDelete: [],
+    },
+};