From b9396c615350ca6c555cb9e758955c3209b8fc0b Mon Sep 17 00:00:00 2001 From: "Michael (Parker) Parker" Date: Mon, 1 Apr 2019 09:45:21 -0400 Subject: [PATCH] add discord.js generic egg Add a generic discord,js egg. add README to all the bot eggs. --- README.md | 4 +- bots/discord/README.md | 4 ++ bots/discord/atlbot/README.md | 6 +++ .../atlbot/{bot => }/egg-a-t-l-bot.json | 0 bots/discord/bastion/README.md | 9 ++++ bots/discord/discord.js/README.md | 5 ++ .../discord.js/egg-discord-js-generic.json | 54 +++++++++++++++++++ bots/discord/parkertron/README.md | 8 +++ bots/discord/pixelbot/README.md | 9 ++++ bots/discord/sinusbot/README.md | 15 ++++++ 10 files changed, 113 insertions(+), 1 deletion(-) create mode 100644 bots/discord/atlbot/README.md rename bots/discord/atlbot/{bot => }/egg-a-t-l-bot.json (100%) create mode 100644 bots/discord/bastion/README.md create mode 100644 bots/discord/discord.js/README.md create mode 100644 bots/discord/discord.js/egg-discord-js-generic.json create mode 100644 bots/discord/parkertron/README.md create mode 100644 bots/discord/pixelbot/README.md create mode 100644 bots/discord/sinusbot/README.md diff --git a/README.md b/README.md index 0841502c..82b31b09 100644 --- a/README.md +++ b/README.md @@ -29,10 +29,12 @@ If you submit a PR without filling out the template I will deny it. This is for ## Bot Eggs [Discord](/bots/discord/) -* [ATL Bot](/bots/discord/atlbot) Node JS +* [ATL Bot](/bots/discord/atlbot/) Node JS * [parkertron](/bots/discord/parkertron/) Golang * [pixel-bot](/bots/discord/pixelbot/) Python +* [discord.js](bots/discord/discord.js/) * [Sinusbot](/bots/discord/sinusbot/) +* [Bastion](/bots/discord/bastion/) ## Game Eggs diff --git a/bots/discord/README.md b/bots/discord/README.md index 06cfbb6e..8615f33f 100644 --- a/bots/discord/README.md +++ b/bots/discord/README.md @@ -2,6 +2,10 @@ ### Some of these bots support other services but are primarily Discord bots +#### Generic Discord.js bot egg +discord.js +A generic discord.js bot egg. Meant to pull from a repo can also be used where a user can upload the files on their own. + #### ATLauncher Discord Bot [ATLauncher/discord-bot](https://github.com/ATLauncher/discord-bot) Their github has all the info you need diff --git a/bots/discord/atlbot/README.md b/bots/discord/atlbot/README.md new file mode 100644 index 00000000..008d3906 --- /dev/null +++ b/bots/discord/atlbot/README.md @@ -0,0 +1,6 @@ +# ATLBot +### Their [Github](https://github.com/ATLauncher/discord-bot) +This is the code for our Discord bot which runs on the official ATLauncher Discord server + +### Server Ports +There are no ports required for the atl bot \ No newline at end of file diff --git a/bots/discord/atlbot/bot/egg-a-t-l-bot.json b/bots/discord/atlbot/egg-a-t-l-bot.json similarity index 100% rename from bots/discord/atlbot/bot/egg-a-t-l-bot.json rename to bots/discord/atlbot/egg-a-t-l-bot.json diff --git a/bots/discord/bastion/README.md b/bots/discord/bastion/README.md new file mode 100644 index 00000000..c57d5814 --- /dev/null +++ b/bots/discord/bastion/README.md @@ -0,0 +1,9 @@ +# Bastion +### From their [Github](https://github.com/TheBastionBot/Bastion) +Give awesome perks to your Discord server! + +### Install notes +Due to rate limiting the console on the panel cannot keep up with the game console and the build will complete before the panel console may show it. Reloading the console will load it to the latest part of the log. + +### Server Ports +No Ports are required for the bastion bot. \ No newline at end of file diff --git a/bots/discord/discord.js/README.md b/bots/discord/discord.js/README.md new file mode 100644 index 00000000..7a241119 --- /dev/null +++ b/bots/discord/discord.js/README.md @@ -0,0 +1,5 @@ +# discord.js generic + +This egg was designed to allow a user to pull their own nodejs discord bot from a repo. + +There is an option to allow a user to upload their own files to run a bot. \ No newline at end of file diff --git a/bots/discord/discord.js/egg-discord-js-generic.json b/bots/discord/discord.js/egg-discord-js-generic.json new file mode 100644 index 00000000..4286b00a --- /dev/null +++ b/bots/discord/discord.js/egg-discord-js-generic.json @@ -0,0 +1,54 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v1" + }, + "exported_at": "2019-04-01T09:21:41-04:00", + "name": "discord.js generic", + "author": "parker@parkervcp.com", + "description": "a generic discord js bot egg\r\n\r\nThis will clone a git repo for a bot. it defaults to master if no branch is specified.\r\n\r\nInstalls the node_modules on install. If you set user_upload then I assume you know what you are doing.", + "image": "quay.io\/parkervcp\/pterodactyl-images:bot_discordjs", + "startup": "\/usr\/local\/bin\/node \/home\/container\/index.js", + "config": { + "files": "{}", + "startup": "{}", + "logs": "{}", + "stop": "^c" + }, + "scripts": { + "installation": { + "script": "#\/bin\/ash\r\n\r\napk add --no-cache git\r\n\r\ncd \/mnt\/server\r\n\r\necho -e \"working on installing a discord.js bot from ${INSTALL_REPO}\"\r\n\r\nif [ \"${USER_UPLOAD}\" == \"true\" ] || [ \"${USER_UPLOAD}\" == \"1\" ]; then\r\n\techo -e \"assuming user knows what they are doing have a good day.\"\r\n\texit 0\r\nelse\r\n\tif [ \"$(ls -A \/mnt\/server)\" ]; then\r\n\t\techo -e \"\/mnt\/server directory is not empty.\"\r\n\t if [ -d .git ]; then\r\n\t\t\techo -e \".git directory exists\" \r\n\t\t\tif [ -f .git\/config ]; then\r\n\t\t\t\techo -e \"loading info from git config\"\r\n\t\t\t\tORIGIN=$(git config --get remote.origin.url)\r\n\t\t\telse\r\n\t\t\t\techo -e \"files found with no git config\"\r\n\t\t\t\techo -e \"closing out without touching things to not break anything\"\r\n\t\t\t\texit 10\r\n\t\t\tfi\r\n\t\tfi\r\n\t\tif [ \"${ORIGIN}\" == \"${INSTALL_REPO}\" ]; then\r\n\t\t\techo \"pulling latest from github\"\r\n\t\t\tgit pull \r\n\t\t\techo -e \"updating local npm modules\"\r\n\t\t\t\/usr\/local\/bin\/npm install --production\r\n\t\tfi\r\n\telse\r\n \techo -e \"\/mnt\/server is empty.\\ncloning files into repo\"\r\n\t\tif [ -z ${INSTALL_BRANCH} ]; then\r\n\t\t\techo -e \"assuming master branch\"\r\n\t\t\tINSTALL_BRANCH=master\r\n\t\tfi\r\n \r\n\t\techo -e \"running 'git clone --single-branch --branch ${INSTALL_BRANCH} ${INSTALL_REPO} .'\"\r\n\t\tgit clone --single-branch --branch ${INSTALL_BRANCH} ${INSTALL_REPO} .\r\n\t\techo -e \"install npm modules locally\"\r\n\t\t\/usr\/local\/bin\/npm install --production\r\n\tfi\r\nfi \r\n\r\necho -e \"install complete\"\r\nexit 0", + "container": "node:10-alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "Install Repo", + "description": "The git repo to clone and install the discord js bot from", + "env_variable": "INSTALL_REPO", + "default_value": "", + "user_viewable": 1, + "user_editable": 0, + "rules": "required|string|max:128" + }, + { + "name": "Install Branch", + "description": "The branch of the bot to install", + "env_variable": "INSTALL_BRANCH", + "default_value": "", + "user_viewable": 1, + "user_editable": 0, + "rules": "nullable|string|max:32" + }, + { + "name": "User Uploaded Files", + "description": "Skip all the install cruft is you are just letting a user upload files.\r\n\r\n0 = false (default)\r\n1 = true", + "env_variable": "USER_UPLOAD", + "default_value": "0", + "user_viewable": 1, + "user_editable": 0, + "rules": "required|bool" + } + ] +} \ No newline at end of file diff --git a/bots/discord/parkertron/README.md b/bots/discord/parkertron/README.md new file mode 100644 index 00000000..99f14234 --- /dev/null +++ b/bots/discord/parkertron/README.md @@ -0,0 +1,8 @@ +# ATLBot +### Their [Github](https://github.com/parkervcp/parkertron) +Purely a chatbot. Not even a smart one. + +Runs the Pterodactyl `@support bot` + +### Server Ports +There are no ports required for parkertron \ No newline at end of file diff --git a/bots/discord/pixelbot/README.md b/bots/discord/pixelbot/README.md new file mode 100644 index 00000000..4726344e --- /dev/null +++ b/bots/discord/pixelbot/README.md @@ -0,0 +1,9 @@ +# pixelbot +### Their [Github](https://github.com/possatti/pixelbot) +Bot for pixelcanvas.io + +### Server Ports +There are no ports required for pixelbot + +### Side notes +This was to make sure the parkervcp/images:python 3 image worked. \ No newline at end of file diff --git a/bots/discord/sinusbot/README.md b/bots/discord/sinusbot/README.md new file mode 100644 index 00000000..9fe05294 --- /dev/null +++ b/bots/discord/sinusbot/README.md @@ -0,0 +1,15 @@ +# SinusBot +### Their [Site](https://www.sinusbot.com/) +Listen to your favorite music together with all of your friends + +Welcome the Simple, Elegant & great sounding TS3- and Discord-Bot! + +### Server Ports +1 port is required to run SinusBot. + +| Port | default | +|---------|---------| +| Game | 8087 | + +### Side notes +This uses a custom image. \ No newline at end of file