Merge branch 'main' of https://github.com/realbadidas/Arma-Remote-Code-Executor into main

Author: realbadidas

README.md

@@ -1,13 +1,28 @@
 # Arma-Remote-Code-Executor
-With this servermod you can easily send script commands via a POST request with HTTP or HTTPS to your ArmA server! (Maybe even your DayZ server i have no clue lol test it yourself)
+With this servermod you can easily send script commands or SQF code via a POST request with HTTP or HTTPS to your ArmA server! (Maybe even your DayZ server i have no clue lol test it yourself)
 
 
 # Hello there!
-This is an robust and fast ArmA 3 Servermod that runs on 32 bit and 64 bit Windows (Sooner or later also Linux but i have no machine to test or compile)! It listens on a specified port for incoming requests. The servermod consists of a pbo and 6 DLLs (2 ArmA extension DLLs and 4 library DLLs for OpenSSL).
+This is an robust and fast ArmA 3 Servermod that runs on 32 bit and 64 bit Windows (Sooner or later also Linux but i have no machine to test or compile)! It listens on a specified port for incoming requests and returns a JSON-Array with a response code and the return of the executed script. The servermod consists of a pbo and 6 DLLs (2 ArmA extension DLLs and 4 library DLLs for OpenSSL).
+
+This is still under development, so you may encounter bugs, please create an issue on the github page explaining your bug and it will get fixed ASAP!)
+Inspired by <a href=https://github.com/dylanplecki/sqf-rcon>this</a>
+
+
+# For Developers
+This is built in VS2019 (vc-142) using the <a href=https://github.com/ipkn/crow>crow webserver</a>, the boost library from nuget (vc141, version 1.69 (all above 1.69 will cause compiler issues)) It also uses the openssl-vc142 package from nuget for https support for crow.
+
+If you have knowledge in linux development, please help me :3
 
 
 # How to install
-Download the .ZIP file in the <a href=https://github.com/realbadidas/Arma-Remote-Code-Executor/releases>releases</a> tab. Now its just drag and drop: Drag the contents of the folder "A3" into your ArmA 3 Dedicated Server folder, start your server with the mod loaded and it should work right out of the box! But please, for christs sake, change the default username and password:p
+Download the .ZIP file in the <a href=https://github.com/realbadidas/Arma-Remote-Code-Executor/releases>releases</a> tab. Now its just drag and drop: Drag the contents of the folder "A3" into your ArmA 3 Dedicated Server folder, start your server with the mod loaded and it should work right out of the box! But please, for christs sake, change the default username and password :p
+
+I would also recommend to use "-autoInit" as a startparameter so you can use it even if there are no players on your server
+
+
+# How to use
+Send a POST request to "{IP}:{PORT}/send" with the parameters "user", "pass" and "execute", where "user" represents the username, "pass" the password and "execute" the SQF Code you want to execute
 
 
 # Config File
@@ -23,7 +38,7 @@ https (boolean, default: true): If you want to use HTTPS or not <br /><br />
 SSL_Key (string, default: "@sqfremoteexecute\ssl.key"): Path to your ssl.key file (only needed if using https) <br />
 SSL_Cert (string, default: "@sqfremoteexecute\ssl.cert"): Path to your ssl.cert file (only needed if using https) <br /><br />
 
-users (array that contains an array of credentials, default user is "foo" with pass of "bar", <b>1337 is the maximum number of user accounts!</b> <br /><br />
+users (array that contains an array of credentials, default user is "foo" with pass of "bar" (you need to hash the password with the SHA256 algorithm), <b>1337 is the maximum number of user accounts!</b> <br /><br />
 
 
 # Safety Reminder