From 1179796da921515352f7d871bacad169502f7beb Mon Sep 17 00:00:00 2001 From: Osiris-Team <59899645+Osiris-Team@users.noreply.github.com> Date: Wed, 10 May 2023 12:49:13 +0200 Subject: [PATCH 1/6] Update FAQ.md --- docs/FAQ.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index f5d14e52..8bfcb288 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -5,10 +5,20 @@ --- ### **What is AutoPlug Client?** -AutoPlug Client is a standalone, executable java program that runs in place of your Minecraft server. +AutoPlug Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. +The main purpose is to automate updating of any sofware related to servers and simplify their maintenance in general. -### **What does AutoPlug Client do?** -The main purpose of AutoPlug Client is to automatically identify and update any plugins or mods you use with your Minecraft server. +### **How does AutoPlug work? Server-Wrapper? CLI-Tool? Background-Service?** +AutoPlug performs all its tasks when your server is offline, thus its recommended +to run AutoPlug as a Server-Wrapper so that it can start/stop/restart your server. +In this case AutoPlug will start your server automatically when it launches and show its console output. + +To achieve full automation the daily server restarter is used (enabled by default), +which restarts your server at specific times in the day. AutoPlug runs its tasks when your server restarts. + +If you don't want AutoPlug to have access to your servers' console, you can install AutoPlug as CLI-Tool or Background-Service: +- CLI-Tool (command-line interface tool): Manually run the AutoPlug commands/tasks once in a while (remember that your server must be offline). +- Background-Service: Runs the tasks periodically but does not know if the server is offline, thus you would have to take care of that. ### **Is AutoPlug Client a plugin or mod?** No! AutoPlug Client is neither a plugin nor mod and should not be treated as such. From a5719b1800eaadad01d3fd754b7bf6d386e0503a Mon Sep 17 00:00:00 2001 From: Osiris-Team <59899645+Osiris-Team@users.noreply.github.com> Date: Wed, 10 May 2023 12:50:06 +0200 Subject: [PATCH 2/6] Update FAQ.md --- docs/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 8bfcb288..f196497c 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,7 +6,7 @@ ### **What is AutoPlug Client?** AutoPlug Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. -The main purpose is to automate updating of any sofware related to servers and simplify their maintenance in general. +The main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. ### **How does AutoPlug work? Server-Wrapper? CLI-Tool? Background-Service?** AutoPlug performs all its tasks when your server is offline, thus its recommended From a3e72e7d71ea4a271127e6d2e96de280e82e68be Mon Sep 17 00:00:00 2001 From: Osiris-Team <59899645+Osiris-Team@users.noreply.github.com> Date: Wed, 10 May 2023 12:52:58 +0200 Subject: [PATCH 3/6] Update FAQ.md --- docs/FAQ.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/FAQ.md b/docs/FAQ.md index f196497c..bdc69a18 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -20,6 +20,8 @@ If you don't want AutoPlug to have access to your servers' console, you can inst - CLI-Tool (command-line interface tool): Manually run the AutoPlug commands/tasks once in a while (remember that your server must be offline). - Background-Service: Runs the tasks periodically but does not know if the server is offline, thus you would have to take care of that. +Note that these "execution modes" are nothing more that simple configuration presets. + ### **Is AutoPlug Client a plugin or mod?** No! AutoPlug Client is neither a plugin nor mod and should not be treated as such. It runs entirely independently of your Minecraft server. From 66256e38dfaa0f28a7a1a2f34a18fadb34be7535 Mon Sep 17 00:00:00 2001 From: Osiris-Team <59899645+Osiris-Team@users.noreply.github.com> Date: Wed, 10 May 2023 13:32:33 +0200 Subject: [PATCH 4/6] Update FAQ.md --- docs/FAQ.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index bdc69a18..796f1ac0 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -4,11 +4,11 @@ --- -### **What is AutoPlug Client?** +### **What is it? Purpose?** AutoPlug Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. The main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. -### **How does AutoPlug work? Server-Wrapper? CLI-Tool? Background-Service?** +### **How does it work? Server-Wrapper? CLI-Tool? Background-Service?** AutoPlug performs all its tasks when your server is offline, thus its recommended to run AutoPlug as a Server-Wrapper so that it can start/stop/restart your server. In this case AutoPlug will start your server automatically when it launches and show its console output. @@ -22,11 +22,11 @@ If you don't want AutoPlug to have access to your servers' console, you can inst Note that these "execution modes" are nothing more that simple configuration presets. -### **Is AutoPlug Client a plugin or mod?** +### **Is it a plugin or mod?** No! AutoPlug Client is neither a plugin nor mod and should not be treated as such. It runs entirely independently of your Minecraft server. -### **What features does AutoPlug Client have?** +### **What are the features?** AutoPlug Client currently has the following features: - AutoPlug Client self-updating - Standalone Java installation and updating @@ -38,20 +38,22 @@ AutoPlug Client currently has the following features: For a full list of features, please visit -### **Can AutoPlug Client update my paid/premium plugins?** +### **Can it update my paid/premium plugins?** No. Due to the nature of how the paid plugins are hosted, as well as the hosts' API limitations and Terms of Service, AutoPlug Client will never contain functionality for downloading paid/premium plugins. As an alternative, SPPU [[Link](https://github.com/Osiris-Team/SPPU)] may be better suited. *It is highly advised to read the entire readme before using this tool.* -### **How do I install AutoPlug Client?** +### **How do I install it?** Go to the AutoPlug Client [installer page](https://autoplug.one/installer) and follow the steps carefully. -### **Can I install AutoPlug Client on a server host?** +### **Can I install it on a server host?** Yes! For instructions on how to do so, please read [How To - Install AutoPlug Client on a Server Host](How%20To%20-%20Install%20AP%20Client%20on%20a%20Server.md). -### **How do I change the settings?** +### **How do I change the settings? Live-Settings?** All settings are kept in their own respective `.yml` config files that can be found in the `autoplug` folder in your Minecraft server directory. +Almost all settings can be changed without needing to restart AutoPlug to have effect (Live-Settings), since +related settings are freshly loaded before executing a task. ### **How do I know what some settings do?** Every `.yml` config file has explanations with examples written both at the very top of the file and next to each setting. @@ -65,14 +67,17 @@ Please make either a Github Issue or a post in the Discord's #help channel. --- -### **I just installed AutoPlug Client and it's taking forever to start!** -This is normal for first-time installations and can take up to 3 - 5 minutes depending on system resources, network availability, and number of plugins/mods. +### **Just installed and it's taking forever to start!** +By default backup creation is enabled, so before executing its tasks a backup will be created that +can take up to 3 - 5 minutes depending on system resources and size of the directory. +Besides that there may be many updates/files that have to be downloaded, so do not abort +this process to ensure a correct installation. ### **I get the message `Starting server: xxx.jar` but nothing happens!** This usually means that something is wrong with your Java installation. By default, AutoPlug Client installs its own standalone Java runtime in `./autoplug/system`. -To make AutoPlug Client reinstall Java: +To make AutoPlug-Client reinstall Java: 1. Delete the `system` directory in `./autoplug`. 2. In the Updater config (default: `./autoplug/updater.yml`), set `updater: java-updater: build-id:` to `0` and save the file. 3. Restart AutoPlug Client. From 6bb00aa6ad6aec61d168d9a74a66aa192d510f77 Mon Sep 17 00:00:00 2001 From: Osiris-Team <59899645+Osiris-Team@users.noreply.github.com> Date: Wed, 10 May 2023 13:53:32 +0200 Subject: [PATCH 5/6] Update FAQ.md --- docs/FAQ.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 796f1ac0..3999b270 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,7 +6,9 @@ ### **What is it? Purpose?** AutoPlug Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. -The main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. +Its main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. +While all server types are compatible, the majority of its features cater specifically to Minecraft plugins/mods, +which is renowned as the world's top-selling game and boasts an exceptionally extensive modding community. ### **How does it work? Server-Wrapper? CLI-Tool? Background-Service?** AutoPlug performs all its tasks when your server is offline, thus its recommended From ba48e5e16f2628f64eed878e4111fa3e1c114138 Mon Sep 17 00:00:00 2001 From: Osiris-Team <59899645+Osiris-Team@users.noreply.github.com> Date: Wed, 10 May 2023 13:54:23 +0200 Subject: [PATCH 6/6] Update FAQ.md --- docs/FAQ.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 3999b270..e0f4dc03 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -7,7 +7,7 @@ ### **What is it? Purpose?** AutoPlug Client is a standalone, executable Java program that has multiple execution modes: Server-Wrapper, CLI-Tool, Background-Service. Its main purpose is to automate updating of any sofware related to servers and simplify server maintenance in general. -While all server types are compatible, the majority of its features cater specifically to Minecraft plugins/mods, +While all server types are compatible, the majority of its features cater specifically to Minecraft, which is renowned as the world's top-selling game and boasts an exceptionally extensive modding community. ### **How does it work? Server-Wrapper? CLI-Tool? Background-Service?**