|
1 |
| -# metamod-r |
2 |
| - |
3 |
| - |
4 |
| -**Metamod-r** is based on the original version of [Metamod](http://metamod.org/) written by _Will Day_ for Half-Life 1 with some improvements from [Jussi Kivilinna](https://github.com/jkivilin) ([Metamod-p](https://github.com/jkivilin/metamod-p)). This product contains a large number of performance optimizations and more pure code. The core was written using JIT compiler. |
| 1 | +# Metamod-r [](https://github.com/theAsmodai/metamod-r/releases/latest) []() [](http://isitmaintained.com/project/theAsmodai/metamod-r "Percentage of issues still open") [](https://www.gnu.org/licenses/gpl-3.0) |
5 | 2 |
|
| 3 | +**Metamod-r** is based on the original version of [Metamod](http://metamod.org/) written by _Will Day_ for Half-Life 1 with some improvements from [Jussi Kivilinna](https://github.com/jkivilin) ([Metamod-p](https://github.com/jkivilin/metamod-p)). This product contains a large number of performance optimizations and more pure code. The core was written using JIT compiler. |
6 | 4 |
|
7 | 5 | **Metamod-r is incompatible with original `HLDS`. It's necessary to have installed [ReHLDS](https://github.com/dreamstalker/ReHLDS) (`API 3.1+`). There is no guarantee that the product will work in a different environment.**
|
8 | 6 |
|
9 |
| -|HLDS | [ReHLDS](https://github.com/dreamstalker/ReHLDS) | OS | Download | |
10 |
| -|---------| -------| --- | --- | |
11 |
| -| :x: | `API 3.1+` |  | [](http://teamcity.rehlds.org/guestAuth/downloadArtifacts.html?buildTypeId=Metamod_Publish&buildId=lastSuccessful) |
| 7 | +|HLDS | [ReHLDS](https://github.com/dreamstalker/ReHLDS) | OS | Download | |
| 8 | +|---------| -------| --- | --- | |
| 9 | +| :x: | `API 3.1+` |  | [](https://github.com/theAsmodai/metamod-r/releases/latest) |
12 | 10 |
|
13 | 11 | [](https://metamod-r.org/)
|
14 | 12 | [](https://github.com/theAsmodai/metamod-r/)
|
15 |
| -[](http://teamcity.rehlds.org/viewType.html?buildTypeId=Metamod_Publish&guest=1) |
16 |
| -[](https://github.com/theAsmodai/metamod-r/issues) |
17 |
| -[](https://github.com/theAsmodai/metamod-r/network) |
18 |
| -[](https://github.com/theAsmodai/metamod-r/stargazers) |
| 13 | +[](https://github.com/theAsmodai/metamod-r/issues) |
| 14 | +[](https://github.com/theAsmodai/metamod-r/network) |
| 15 | +[](https://github.com/theAsmodai/metamod-r/stargazers) |
19 | 16 |
|
20 | 17 |
|
21 |
| -Distributed under |
| 18 | +Distributed under |
22 | 19 | [](https://github.com/theAsmodai/metamod-r/blob/master/LICENSE).
|
23 | 20 |
|
24 | 21 | ## Documentation
|
25 |
| -* All actual documentation in  **English** and  **Russian** languages is placed at [this link](https://github.com/theAsmodai/metamod-r/wiki). |
| 22 | +* All actual documentation in  **English** and  **Russian** languages is placed at [this link](https://github.com/theAsmodai/metamod-r/wiki). |
26 | 23 |
|
27 | 24 | ### Supported games
|
28 | 25 | *  Actual [list of supported games](https://github.com/theAsmodai/metamod-r/wiki/Supported-games).
|
29 | 26 | *  Актуальный [список поддерживаемых игр](https://github.com/theAsmodai/metamod-r/wiki/Поддерживаемые-игры).
|
30 | 27 |
|
| 28 | +## Build instructions |
| 29 | +### Checking requirements |
| 30 | +There are several software requirements for building Metamod-r: |
| 31 | + |
| 32 | +#### Windows |
| 33 | +<pre> |
| 34 | +Visual Studio 2015 (C++14 standard) and later |
| 35 | +</pre> |
| 36 | + |
| 37 | +#### Linux |
| 38 | +<pre> |
| 39 | +git >= 1.8.5 |
| 40 | +cmake >= 3.10 |
| 41 | +GCC >= 4.9.2 (Optional) |
| 42 | +ICC >= 15.0.1 20141023 (Optional) |
| 43 | +LLVM (Clang) >= 6.0 (Optional) |
| 44 | +</pre> |
| 45 | + |
| 46 | +### Building |
| 47 | + |
| 48 | +#### Windows |
| 49 | +Use `Visual Studio` to build, open `msvc/metamod.sln` and just select from the solution configurations list `Release` or `Debug` |
| 50 | + |
| 51 | +#### Linux |
| 52 | + |
| 53 | +* Optional options using `build.sh --compiler=[gcc] --jobs=[N] -D[option]=[ON or OFF]` (without square brackets) |
| 54 | + |
| 55 | +<pre> |
| 56 | +-c=|--compiler=[icc|gcc|clang] - Select preferred C/C++ compiler to build |
| 57 | +-j=|--jobs=[N] - Specifies the number of jobs (commands) to run simultaneously (For faster building) |
| 58 | + |
| 59 | +<sub>Definitions (-D)</sub> |
| 60 | +DEBUG - Enables debugging mode |
| 61 | +USE_STATIC_LIBSTDC - Enables static linking library libstdc++ |
| 62 | +</pre> |
| 63 | + |
| 64 | +* ICC <pre>./build.sh --compiler=intel</pre> |
| 65 | +* LLVM (Clang) <pre>./build.sh --compiler=clang</pre> |
| 66 | +* GCC <pre>./build.sh --compiler=gcc</pre> |
| 67 | + |
| 68 | +##### Checking build environment (Debian / Ubuntu) |
| 69 | + |
| 70 | +<details> |
| 71 | +<summary>Click to expand</summary> |
| 72 | + |
| 73 | +<ul> |
| 74 | +<li> |
| 75 | +Installing required packages |
| 76 | +<pre> |
| 77 | +sudo dpkg --add-architecture i386 |
| 78 | +sudo apt-get update |
| 79 | +sudo apt-get install -y gcc-multilib g++-multilib |
| 80 | +sudo apt-get install -y build-essential |
| 81 | +sudo apt-get install -y libc6-dev libc6-dev-i386 |
| 82 | +</pre> |
| 83 | +</li> |
| 84 | + |
| 85 | +<li> |
| 86 | +Select the preferred C/C++ Compiler installation |
| 87 | +<pre> |
| 88 | +1) sudo apt-get install -y gcc g++ |
| 89 | +2) sudo apt-get install -y clang |
| 90 | +</pre> |
| 91 | +</li> |
| 92 | +</ul> |
31 | 93 |
|
32 |
| -### Build instructions |
33 |
| -*  [Build instructions](https://github.com/theAsmodai/metamod-r/wiki/Compilling-metamod-r). |
34 |
| -*  [Инструкция по сборке](https://github.com/theAsmodai/metamod-r/wiki/Компиляция-metamod-r). |
| 94 | +</details> |
0 commit comments