diff --git a/src/routes/BetterConsoleMC/+page.md b/src/routes/BetterConsoleMC/+page.md new file mode 100644 index 0000000..b9781e5 --- /dev/null +++ b/src/routes/BetterConsoleMC/+page.md @@ -0,0 +1,43 @@ +# BetterConsoleMC + +License +Discord +Modrinth + + + + + + +### About the mod +This mod allows for simple ingame command creation to allow for system command execution trough a player on the server. + +This mod can be looked at as version 2.0 of [ConsoleMC](https://github.com/J-onasJones/ConsoleMC) which while being powerful enough, has a big security flaw whe used on big and/or public servers in a way that everyone (that is OP) can run any command on the MC server's host system, giving anyone access to the entire machine and allowing for bad actions to be taken by people who shouldn't have access to it. + +A detailed documentation with examples is available [here](BetterConsoleMC/Mod-Configuration) + +### Fabric/Quilt support goes back to 1.17 Pre-release 1 +Forge support isn't part of any of my plans. + +### Warning +If used wrongly this mod can be a security risk for your server and all devices connected to the network that your server is in. + +Beware that anyone who has write access to the MC server's files is able to edit the config files and therefore the commands at any time. + +**Use at your own risk!** + + + + +### Setup + +1. Download the correct version of the mod **including the fabric api if you're using fabric** into your mods folder. +2. Restart Your Minecraft Server and let the mod create the config file. The webserver will be offline by default. +3. In the config file, enable the webserver and adjust all settings if needed. +4. Edit the command config file and add your desired commands! +5. Restart your Minecraft server and You're good to go! + +# KNOWN ISSUES +- Execution Timeout and Execution block Timeout have no effect on the command at this point +- the console is spamed with debug messages +- threads are not closed after a task exit diff --git a/src/routes/BetterConsoleMC/Mod-Configuration/+page.md b/src/routes/BetterConsoleMC/Mod-Configuration/+page.md new file mode 100644 index 0000000..2502da5 --- /dev/null +++ b/src/routes/BetterConsoleMC/Mod-Configuration/+page.md @@ -0,0 +1,44 @@ +# Mod Configuartion +--- + + +# betterconsolemc-config.properties +This config file features the overall mod configs +### bettercmd.enable +- This setting, which is true by default, enables or disables the mod + +# betterconsolemc-commands_config.properties +This config file features the ingame command configuration +### Syntax +- Command Mode + - `SIMPLE`: the command will just be ran + - `RETURN`: the command will be ran and the input will be returned and sent in chat +- Permission Level + - `1` -`4`, indicates what permission is required to run the command +- Execute Timeout + - `0`: the command can run forever and will not be terminated at any point - stopping the server will terminate the process + - `>0`: the command will be terminated after the given amount of seconds +- Broadcast to OP + - `true`: server operators will be notified that the command was ran by a user and can see who ran it + - `false`: server operators will not be notified; the action will still appear in the server logs +- Ingame command name + - The name of the ingame command +- Command to execute + - (In double quotes) the command that will be ran on the system + +Combined, this will give the following one-liner: + +`[Command Mode] [Permissione Level] [Execution Timeout] [Broadcast to OP] [Ingame Command name] [command to execute]` + +### NOTICE: In version 0.0.1+alpha04 and below, there was an unused ExecutionBlockTimeout property. To update to newer versions, migrate the config file by removing the last number before the `true`/`false`. + +### Examples +1. Update the system packages (linux): + `SIMPLE 4 0 true update "sudo apt update && sudo apt upgrade --force-yes"` + This creates a command `/update` that automatically updates a debian based linux system. The command is only available to operators, will, at no point, be terminated and can therefore finish without any errors. This aproach requires the server to be ran with elevated permissions (sudo) + +2. launch a second minecraft server (linux): + `SIMPLE 1 300 true start-server "sudo systemctl start minecraft-server.service"` + This creates a command `/start-server` that automatically starts a minecraft server using the `systemctl` utility. This requires a setup of the service file in `/etc/systemd/system/` + +There can only be a single command per line.