From f3b52d67de8b61183f48ccadc63fd726ba0c632a Mon Sep 17 00:00:00 2001 From: Softwarenoob Date: Wed, 21 Jul 2021 18:40:34 +0300 Subject: [PATCH] docs: update all generic Discord bot readmes Specifies that these eggs can run any generic application, not only a Discord bot. Include instructions to update the start configuration --- bots/discord/deno/README.md | 17 +++++++++++++++-- bots/discord/discord java/README.md | 19 +++++++++++++++++++ bots/discord/discord.js/README.md | 17 +++++++++++++++-- bots/discord/discord.py/README.md | 17 +++++++++++++++-- bots/discord/discordgo/README.md | 17 +++++++++++++++-- 5 files changed, 79 insertions(+), 8 deletions(-) create mode 100644 bots/discord/discord java/README.md diff --git a/bots/discord/deno/README.md b/bots/discord/deno/README.md index 70905747..bf981cfc 100644 --- a/bots/discord/deno/README.md +++ b/bots/discord/deno/README.md @@ -2,8 +2,21 @@ ### From their [site](https://deno.land/) -This egg was designed to allow a user to pull their own deno repo. +This egg is designed to run any generic Deno application, allowing users to pull their own Deno discord bot from a Github repository. There is an option to allow a user to upload their own files to run a server. -The startup configs and commands may need changing to actually function properly. \ No newline at end of file +The startup configs and commands may need changing to actually function properly. + +## Configuration +The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. +![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) + +You can use arrays to have multiple different values when different bots are being used +``` +{ + "done":[ + "change this text 1", + "change this text 2" + ] +} \ No newline at end of file diff --git a/bots/discord/discord java/README.md b/bots/discord/discord java/README.md new file mode 100644 index 00000000..48a8edca --- /dev/null +++ b/bots/discord/discord java/README.md @@ -0,0 +1,19 @@ +# discord.py generic +This egg is designed to run any generic Java application, allowing users to pull their own Java discord bot from a Github repository. + +There is an option to allow a user to upload their own files to run a bot. + +The startup configs and commands may need changing to actually function properly. + +## Configuration +The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. +![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) + +You can use arrays to have multiple different values when different bots are being used +``` +{ + "done":[ + "change this text 1", + "change this text 2" + ] +} \ No newline at end of file diff --git a/bots/discord/discord.js/README.md b/bots/discord/discord.js/README.md index db4a930f..f5cb85be 100644 --- a/bots/discord/discord.js/README.md +++ b/bots/discord/discord.js/README.md @@ -1,7 +1,20 @@ # discord.js generic -This egg was designed to allow a user to pull their own nodejs discord bot from a repo. +This egg is designed to run any generic Javascript application, allowing users to pull their own python discord bot from a Github repository. There is an option to allow a user to upload their own files to run a bot. -The startup configs and commands may need changing to actually function properly. \ No newline at end of file +The startup configs and commands may need changing to actually function properly. + +## Configuration +The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. +![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) + +You can use arrays to have multiple different values when different bots are being used +``` +{ + "done":[ + "change this text 1", + "change this text 2" + ] +} \ No newline at end of file diff --git a/bots/discord/discord.py/README.md b/bots/discord/discord.py/README.md index c45234d9..80b3ffb5 100644 --- a/bots/discord/discord.py/README.md +++ b/bots/discord/discord.py/README.md @@ -1,6 +1,19 @@ # discord.py generic -This egg was designed to allow a user to pull their own python discord bot from a repo. +This egg is designed to run any generic Python application, allowing users to pull their own Python discord bot from a Github repository. There is an option to allow a user to upload their own files to run a bot. -The startup configs and commands may need changing to actually function properly. \ No newline at end of file +The startup configs and commands may need changing to actually function properly. + +## Configuration +The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. +![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) + +You can use arrays to have multiple different values when different bots are being used +``` +{ + "done":[ + "change this text 1", + "change this text 2" + ] +} \ No newline at end of file diff --git a/bots/discord/discordgo/README.md b/bots/discord/discordgo/README.md index ef9f5fe7..02aaf500 100644 --- a/bots/discord/discordgo/README.md +++ b/bots/discord/discordgo/README.md @@ -1,9 +1,22 @@ # discordgo generic -This egg was designed to allow a user to pull their own go discord bot from a repo. +This egg is designed to run any generic Golang application, allowing users to pull their own Golang discord bot from a Github repository. The startup configs and commands may need changing to actually function properly. Users cannot upload their own code as this is built to build the resulting bot. `GO_PACKAGE` is the variable for the go repo i.e. `github.com/aurieh/ddg-ng` -`EXECUTABLE` is the variable for the executable that is built i.e. `ddg-ng` \ No newline at end of file +`EXECUTABLE` is the variable for the executable that is built i.e. `ddg-ng` + +## Configuration +The server will be stuck as `starting` until the egg Start Configuration is modified. You have to edit the text to match something your bot will print for Pterodactyl panel to detect it as running. +![image](https://user-images.githubusercontent.com/10975908/126516861-c5cb4630-9f25-405c-8199-97bf5ec15a7f.png) + +You can use arrays to have multiple different values when different bots are being used +``` +{ + "done":[ + "change this text 1", + "change this text 2" + ] +} \ No newline at end of file