From 2d4d40c24c40ba9f9f62b522109369658ab418aa Mon Sep 17 00:00:00 2001 From: SantaSpeen Date: Tue, 27 Sep 2022 03:25:15 +0300 Subject: [PATCH] Change URL and set clone from branch with Python support. --- README.md | 32 +++++++------------------------- 1 file changed, 7 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index ab685da..aeba3fe 100644 --- a/README.md +++ b/README.md @@ -63,12 +63,7 @@ Please use the prepackaged binaries in [Releases](https://github.com/BeamMP/Beam Dependencies for **windows** can be installed with `vcpkg`. These are: ``` -lua -zlib -rapidjson -openssl -websocketpp -curl +> vcpkg install lua zlib rapidjson openssl websocketpp curl ``` #### Linux @@ -76,22 +71,10 @@ curl These package names are in the debian / ubuntu style. Feel free to PR your own guide for a different distro. Runtime dependencies for **linux** are (debian/ubuntu): -``` -libz-dev -rapidjson-dev -liblua5.3 -libssl-dev -libwebsocketpp-dev -libcurl4-openssl-dev +```shell +$ sudo apt install libz-dev rapidjson-dev liblua5.3 libssl-dev libwebsocketpp-dev libcurl4-openssl-dev git make cmake g++ ``` -Build-time dependencies for **linux** are: -``` -git -make -cmake -g++ -``` For other distributions (e.g. Arch) you want to find packages for: - libz @@ -107,12 +90,11 @@ For other distributions (e.g. Arch) you want to find packages for: On windows, use git-bash for these commands. On Linux, these should work in your shell. 1. Make sure you have all [prerequisites](#prerequisites) installed -2. Clone the repository in a location of your choice with `git clone --recurse-submodules https://github.com/BeamMP/BeamMP-Server`. +2. Clone the repository in a location of your choice with `git clone -b v3.0.2-WithPython --recurse-submodules https://github.com/SantaSpeen/BeamMP-Server`. 3. Ensure that all submodules are initialized by running `git submodule update --init --recursive`. Then change into the cloned directory by running `cd BeamMP-Server`. -4. Checkout the branch of the release you want to compile (`master` is often unstable), for example `git checkout tags/v2.3.3` for version 2.3.3. You can find the latest version [here](https://github.com/BeamMP/BeamMP-Server/tags). -5. Run `cmake . -DCMAKE_BUILD_TYPE=Release` (with `.`) -6. Run `make` -7. You will now have a `BeamMP-Server` file in your directory, which is executable with `./BeamMP-Server` (`.\BeamMP-Server.exe` for windows). Follow the (windows or linux, doesnt matter) instructions on the [wiki](https://wiki.beammp.com/en/home/Server_Mod) for further setup after installation (which we just did), such as port-forwarding and getting a key to actually run the server. +4. Run `cmake . -DCMAKE_BUILD_TYPE=Release` (with `.`) +5. Run `make` +6. You will now have a `BeamMP-Server` file in your directory, which is executable with `./BeamMP-Server` (`.\BeamMP-Server.exe` for windows). Follow the (windows or linux, doesnt matter) instructions on the [wiki](https://wiki.beammp.com/en/home/Server_Mod) for further setup after installation (which we just did), such as port-forwarding and getting a key to actually run the server. *tip: to run the server in the background, simply (in bash, zsh, etc) run:* `nohup ./BeamMP-Server &`*.*