From b407f66c88ba1d1ec94af0f7a08b5c7e9c246200 Mon Sep 17 00:00:00 2001 From: benji7425 Date: Tue, 23 Jan 2018 00:52:11 +0000 Subject: [PATCH] git subrepo pull (merge) discord-bot-core subrepo: subdir: "discord-bot-core" merged: "71586d6" upstream: origin: "git@github.com:benji7425/discord-bot-core.git" branch: "master" commit: "a0387b3" git-subrepo: version: "0.3.1" origin: "???" commit: "???" --- discord-bot-core/.gitrepo | 2 +- discord-bot-core/LICENSE | 21 +++++++++++++++++++++ discord-bot-core/README.md | 27 +++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 discord-bot-core/LICENSE create mode 100644 discord-bot-core/README.md diff --git a/discord-bot-core/.gitrepo b/discord-bot-core/.gitrepo index 2423cdf..ca1d246 100644 --- a/discord-bot-core/.gitrepo +++ b/discord-bot-core/.gitrepo @@ -6,7 +6,7 @@ [subrepo] remote = git@github.com:benji7425/discord-bot-core.git branch = master - commit = 429a85ccea92be3ea53ad3ce9b58a86990a8a484 + commit = a0387b3cd16daa46ab9b34662ae2785b5d808bfb parent = 81b78e2bd223b79219a4a0b3e79cc3cdc1b9f503 method = merge cmdver = 0.3.1 diff --git a/discord-bot-core/LICENSE b/discord-bot-core/LICENSE new file mode 100644 index 0000000..f495dae --- /dev/null +++ b/discord-bot-core/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Benjamin Higgins + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/discord-bot-core/README.md b/discord-bot-core/README.md new file mode 100644 index 0000000..bc9d11c --- /dev/null +++ b/discord-bot-core/README.md @@ -0,0 +1,27 @@ +# Discord bot core + +Core code for connection and command handling for my Discord bots. +This is not actually a Discord bot. To learn about some of my available Discord bots please visit [my website](https://benji7425.github.io/) +This code is included in the repo for each bot using [git subrepo](https://github.com/ingydotnet/git-subrepo), which I prefer over submodules and subtrees. + +This code does not function on it's own, it simply provides common functionality my Discord bots can make use of. +To test/modify this code, it needs to be run in the context of an actual bot. +A good candidate is my [template project](https://github.com/benji7425/discord-bot-template), which should run and connect just fine, just won't do much. + +## Built with +- [discord.js](https://discord.js.org/#/) +- [NeDB](https://github.com/louischatriot/nedb) +- [camo](https://github.com/scottwrobinson/camo) + +## Contributing + +The easiest way to get setup would be a fork of this repo, and the fork of a bot to use as a development context. +I suggest using my [template project](https://github.com/benji7425/discord-bot-template) as a development context, along with [git subrepo](https://github.com/ingydotnet/git-subrepo) to push back to your discord-bot-core fork. +If you are uncomfortable using git subrepo, you could just as easily copy/paste your child `discord-bot-core` directory back into your fork. + +My [template project](https://github.com/benji7425/discord-bot-template) has more in-depth details about how to setup and test. + +If you have a completed change, please submit a pull request from your `discord-bot-core` fork back to this repo. + +Whilst this is very easy to use once you know how, I appreciate this might be a little tricky if you aren't familiar with developing in this way. +Feel free to contact me if you would like assistance. Find contact details [here](https://benji7425.github.io/contact).