Updating documents.

release-1.1.0 v1.1.0
Icedream 2015-01-16 12:11:32 +01:00
parent 294d39edb7
commit 05cf09c8ef
3 changed files with 13 additions and 16 deletions

View File

@ -8,30 +8,27 @@ Updates, compiles and sets up your CitizenMP server automagically!
Features
--------
- Compatible with both Microsoft .NET Framework and Mono (Mac OS X support planned)
- Compatible with both Microsoft .NET Framework 4.5+ and Mono 3.0+ (Mac OS X support planned)
- Creates ready-to-use start scripts for your platform
- No extra setup besides usual requirements needed
- No extra setup besides requirements listed below needed
Requirements
------------
First of all, you'll need Windows or Linux to run this tool. Currently, since no libgit2 binaries can be provided for Mac OS X, this tool won't work there. Here's the guaranteed compatible list of OS this tool can be run on:
- Ubuntu 12.04 (old LTS) or higher, including 14.xx
- Ubuntu 12.04 LTS or higher, including 14.xx
- Debian 7.x (Wheezy) or higher, including testing and sid installations
- Every other currently stable Linux distribution should work just fine as well
- Any Windows operating system with .NET Framework 4 Full on it
- Every other currently stable Linux distribution with up-to-date Mono
- Any Windows operating system with .NET Framework 4.5 Full on it
To run this program and the resulting server, you need the following components:
- _On Windows:_ .NET Framework 4 or newer
- _On Linux:_ Mono 2.10.x/3.x or newer
- _On Windows:_ .NET Framework 4.5 or newer ([Download](http://microsoft.com/download/details.aspx?id=30653))
- _On Linux:_ Mono 3.x or newer, runtime + xbuild files ([Installation instructions](http://www.mono-project.com/docs/getting-started/install/linux/))
On Ubuntu and Debian you can just install all requirements with this command:
```
sudo apt-get install mono-runtime libmono-system-core4.0-cil
```
*Note that Mono 2.10.x/.NET 4 are not supported!*
If you use a Debian-based distribution that still only offers Mono binaries older than 3.x, you must [switch to Xamarin's Debian repository](http://www.mono-project.com/docs/getting-started/install/linux/).
Guides
------
@ -45,7 +42,7 @@ Usage
This tool ships with a usage screen that will be printed if this tool is run without arguments. It looks similar to the following:
```
CitizenMP Server Updater 1.0.1+Branch.master.Sha.4475e9becd5fa22563a92fe202f8df21329969fc
CitizenMP Server Updater 1.0.3
© 2014-2015 Carl Kittelberger
This is free software. You may redistribute copies of it under the terms of the MIT License <http://www.opensource.org/licenses/mit-license.php>.

View File

@ -3,7 +3,7 @@ Easy server installation on Windows
On Windows, you can mostly avoid using the command line for easy usage. Instead, just drag and drop an empty folder onto it. Below is a detailed explanation:
1. Make sure at least .NET Framework 4 is installed on your server computer. If not, you can download it [here](http://microsoft.com/download/details.aspx?id=17718).
1. Make sure at least .NET Framework 4.5 is installed on your server computer. If not, [you can download it from Microsoft's website](http://microsoft.com/download/details.aspx?id=30653).
2. Download citimp_upd.exe from [here](https://github.com/icedream/citizenmp-server-updater/releases). The newest version is always at the top. Alternatively, you can also [get the latest build from the build server](http://builds.icedream.kthx.at/citiserver-updater-master/lastSuccessfulBuild/citimp_upd.exe), which is a little bit slower.
3. Create a new dedicated folder for citimp_upd.exe. It will later contain both your new server and the source code the tool downloads. Name it something like "CitizenMP" or similar. Move the file into the folder.
4. Inside the folder, create a new folder which will contain your server build. Name it something like "Server" or similar.

View File

@ -3,8 +3,8 @@ Server installation on Linux
On Linux, you should use a terminal (SSH connection/XTerm/...) to set up your server.
1. Make sure at least Mono 2.10.x is installed on your server computer. If not, you can install it using your distribution's package manager. For Debian/Ubuntu the command would normally be ```sudo apt-get install mono-runtime libmono-system-core4.0-cil```.
2. Download the latest citimp_upd.exe from [here](https://github.com/icedream/citizenmp-server-updater/releases/latest). You automate this using this command: ```wget https://github.com/icedream/citizenmp-server-updater/releases/download/v1.0.3/citimp_upd.exe```
1. Make sure you have the newest Mono 3.x installed on your server computer (you can check the version using ```mono -V```). If not, [you should follow the official installation instructions](http://www.mono-project.com/docs/getting-started/install/linux/).
2. Download the latest citimp_upd.exe from [here](https://github.com/icedream/citizenmp-server-updater/releases/latest). If you are using SSH and want the file downloaded quickly or just generally want a direct download onto your server, this command should do: ```wget https://github.com/icedream/citizenmp-server-updater/releases/download/v1.1.0/citimp_upd.exe```
3. Create a new dedicated folder for citimp_upd.exe. It will later contain both your new server and the source code the tool downloads. Name it something like "CitizenMP" or similar. Move the file into the folder. Command for that would be ```mkdir CitizenMP```
4. Inside the folder, create a new folder which will contain your server build. Name it something like "Server" or similar. Command for this would be ```cd CitizenMP && mkdir Server```
5. Run the tool and tell it to install files into your newly created folder. Command: ```mono citimp_upd.exe Server```