Merge pull request #58 from FezVrasta/dev#1.1

Dev#1.1 shipped

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contribute to ARK Server Tools
+
+This is an open source project, so feel free to fork it, improve it and send pull requests!
+
+## Keep your fork updated
+
+When you fork our repository and your version gets outdated, please, update it using `git pull --rebase`, in this way you will not create any additional useless commit.
+
+## Got an idea?
+
+If you have a nice idea you'd like to add to this project, please, first open a new issue describing your idea, so everybody can contribute to it and you'll be sure that nobody is working on the same thing.

README.md

@@ -9,14 +9,8 @@ https://developer.valvesoftware.com/wiki/SteamCMD#Linux
 We assume you have created the `steam` user to store steamcmd and your ARK server.
 
 ## Requirements
-Use this command to install soft requirement on your system
-```
-# Debian based/ Ubuntu
-apt-get install screen
 
-# RHEL / CentOS / Fedora
-yum install screen
-```
+### Increase max open files
 
 Edit /etc/sysctl.conf and set:
 ```
@@ -34,21 +28,47 @@ session required pam_limits.so
 
 After these edits, you'll need to restart your bash session or reconnect to your SSH shell to make the changes effective.
 
+### Open firewall ports
+
+```sh
+iptables -I INPUT -p udp --dport 27016 -j ACCEPT
+iptables -I INPUT -p tcp --dport 27016 -j ACCEPT
+iptables -I INPUT -p udp --dport 7778 -j ACCEPT
+iptables -I INPUT -p tcp --dport 7778 -j ACCEPT
+```
+
+NB: Change the ports according to the ones set in your `arkmanager.cfg` file.
+
 ## Install ARK Server Tools
 
 To install ARK Server Tools run this command:
 
 ```sh
-curl -s https://raw.githubusercontent.com/FezVrasta/ark-server-tools/master/netinstall.sh | sudo bash -s steam
+curl -s http://git.io/vtf5N | sudo bash -s steam
 ```
 
 NB: You may want to change the `bash -s` parameter to fit your steam user if different from `steam`.
 
-This will copy the `arkmanager` and the `arkdaemon` to the proper directories and will create an empty log directory in `/var/log` for ARK Server Tools.  
+This will copy the `arkmanager` script and its daemon to the proper directories and will create an empty log directory in `/var/log` for ARK Server Tools.
+
+## Configuration
 
-## Configure ARK Server
+Stored in `/etc/arkmanager/arkmanager.cfg` you can find the variables needed to start the server, like the port numbers, the system environment variables and so on.
 
-All the needed variables are stored in the /etc/arkmanager/arkmanager.cfg configuration file change them following the comments.
+Also, in this file, you can specify any parameter you want to add to the startup command of ARK server.  
+These parameters must be prefixed by the `ark_` string, some example could be:
+
+```sh
+ark_SessionName="My ARK server"
+ark_MaxPlayers=50
+ark_ServerPVE=False
+ark_DifficultyOffset=1
+```
+
+Your session name may contain special characters (eg. `!![EU]!! Aw&some ARK`) which could break the startup command.  
+In this case you may want to comment out the `ark_SessionName` variable and define it inside your **GameUserSettings.ini** file.
+
+You can override or add variables for a specific system user creating a file called `.arkmanager.cfg` in the home directory of the system user.
 
 ## Install ARK Server
 
@@ -59,6 +79,8 @@ arkmanager install
 ```
 ## Commands
 
+To get a complete list of the script commands you can run `arkmanager --help` or `arkmanager -h`.
+
 #### arkmanager install
 installs arkmanager to the directory specified in `.arkmanager.cfg`
 
@@ -72,21 +94,17 @@ stops ARK server
 restarts ARK server
 
 #### arkmanager update
-manually updates ARK server
+manually updates ARK server if a new version is available
+
+#### arkmanager forceupdate
+Apply update without check the current version
 
 #### arkmanager status
 Get the status of the server. Show if the process is running, if the server is up and the current version number
 
 #### arkmanager checkupdate
 Check if a new version of the server is available but not apply it
 
-#### arkmanager broadcast [message]
-broadcast a message to ARK server chat
-
-```sh
-arkmanager broadcast "your message here"
-```
-
 ## Credits
 
 Original author of arkmanager: LeXaT