Update README.md

This commit is contained in:
Lion 2020-12-27 22:28:15 +01:00 committed by GitHub
parent 941287d22c
commit 03968f34b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,40 +3,34 @@
The Server is the way we link client to each other and handle authentication, compression, and data management. It also allows lua plugins, that system is always being reviewed and improved with detailed instructions on wiki.beammp.com. The Server is the way we link client to each other and handle authentication, compression, and data management. It also allows lua plugins, that system is always being reviewed and improved with detailed instructions on wiki.beammp.com.
## Unix specific build instructions ## Linux / POSIX specific build instructions
1. You need boost >= 1.70.0 Currently only linux and windows are supported (generally).
Check with your ditro's package manager whether it provides this. If it does, you should use that. ### Prerequisites
All package names are ones found in debian's (debian 10 stable) repositories, but will exist under similar names in other distros. Feel free to PR your own guide for a different distro.
If it doesnt provide it or you want to link it statically (like we do with our releases), then you have to do this: - `git`
- `make`
- `cmake`
- `g++` (must support ISO C++17)
- `liblua5.3`
- `libz-dev`
- `rapidjson-dev`
- `libcurl4-openssl-dev` (or other `libcurl4-*-dev`)
download the latest boost source code. ### How to build
Then, go to the downloaded directory and run
```sh
b2 link=static runtime-link=static threading=multi
```
And then either symlink, edit CMakeLists to find it, or simply run
```sh
b2 link=static runtime-link=static threading=multi install
```
(warning: installs boost into your system, you might not want this).
Then on invocation of cmake, ensure that you define `Boost_USE_STATIC_RUNTIME=ON`. 1. Make sure you have all [prerequisites](#prerequisites) installed
2. Clone the repository in a location of your choice with `git clone --recursive https://github.com/BeamMP/BeamMP-Server`
3. `cd` into it with `cd BeamMP-Server`
4. Run `cmake .` (with `.`)
5. Run `make`
6. You will now have a `BeamMP-Server` file in your directory, which is executable with `./BeamMP-Server`. 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 &`!`.*
2. Building ## Copyright
Run cmake, and then make.
Example:
```bash
~/src/Server $ cmake -S . -B bin -DCMAKE_BUILD_TYPE=Release
...
~/src/Server $ make -C bin -j 5
```
Copyright (c) 2019-present Anonymous275. BeamMP Server code is not in the public domain and is not free software. One must be granted explicit permission by the copyright holder in order to modify or distribute any part of the source or binaries, the only permission that has been granted is to use the software in its compiled form as distributed from the BeamMP.com website. Anything else is prohibited. Modified works may not be published and have be upstreamed to the official repository. Copyright (c) 2019-present Anonymous275. BeamMP Server code is not in the public domain and is not free software. One must be granted explicit permission by the copyright holder in order to modify or distribute any part of the source or binaries, the only permission that has been granted is to use the software in its compiled form as distributed from the BeamMP.com website. Anything else is prohibited. Modified works may not be published and have be upstreamed to the official repository.