From b9c5262789a7fc31ff8b810db1581fd0dd2f7287 Mon Sep 17 00:00:00 2001 From: AEnimka <36441614+AEnimka@users.noreply.github.com> Date: Sat, 10 Mar 2018 20:11:17 +0300 Subject: [PATCH] Updated Readme.MD * Added some info --- README.md | 140 +++++++----------------------------------------------- 1 file changed, 18 insertions(+), 122 deletions(-) diff --git a/README.md b/README.md index ac7b38c..5b11320 100644 --- a/README.md +++ b/README.md @@ -1,125 +1,21 @@ -# metamod-r [![Build Status](http://teamcity.rehlds.org/app/rest/builds/buildType:(id:Metamod_Publish)/statusIcon)](http://teamcity.rehlds.org/viewType.html?buildTypeId=Metamod_Publish&guest=1) [![Download](https://camo.githubusercontent.com/2b15ec2fc402e02b66fde9eab7e896406caeddac/687474703a2f2f7265686c64732e6f72672f76657273696f6e2f6d6574616d6f642d2d722e737667)](http://teamcity.rehlds.org/guestAuth/downloadArtifacts.html?buildTypeId=Metamod_Publish&buildId=lastSuccessful) [![License: GPL v3](https://camo.githubusercontent.com/bf135a9cea09d0ea4bba410582c0e70ec8222736/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c25323076332d626c75652e737667)](https://www.gnu.org/licenses/gpl-3.0) +# metamod-r [![Build Status](http://teamcity.rehlds.org/app/rest/builds/buildType:(id:Metamod_Publish)/statusIcon)](http://teamcity.rehlds.org/viewType.html?buildTypeId=Metamod_Publish&guest=1) [![Download](https://camo.githubusercontent.com/2b15ec2fc402e02b66fde9eab7e896406caeddac/687474703a2f2f7265686c64732e6f72672f76657273696f6e2f6d6574616d6f642d2d722e737667)](http://teamcity.rehlds.org/guestAuth/downloadArtifacts.html?buildTypeId=Metamod_Publish&buildId=lastSuccessful) [![License: GPL v3](https://camo.githubusercontent.com/bf135a9cea09d0ea4bba410582c0e70ec8222736/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d47504c25323076332d626c75652e737667)](https://www.gnu.org/licenses/gpl-3.0) -Metamod-r is based on original Metamod by Will Day for Half-Life 1 with some improvements by Jussi Kivilinna. It contains a huge number of performance optimizations and much cleaner code. The core was written using the JIT compiler. +[![GitHub issues](https://img.shields.io/github/issues/theAsmodai/metamod-r.svg?style=flat-square)](https://github.com/theAsmodai/metamod-r/issues) +[![GitHub forks](https://img.shields.io/github/forks/theAsmodai/metamod-r.svg?style=flat-square)](https://github.com/theAsmodai/metamod-r/network) +[![GitHub stars](https://img.shields.io/github/stars/theAsmodai/metamod-r.svg?style=flat-square)](https://github.com/theAsmodai/metamod-r/stargazers) +[![Experimental](https://img.shields.io/badge/status-experimental-orange.svg?style=flat-square)](https://github.com/theAsmodai/metamod-r/) + +**Metamod-r** 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 kernel was written using JIT compiler. It is better to use with [ReHLDS](https://github.com/dreamstalker/ReHLDS). Distributed under license +[![GitHub license](https://img.shields.io/github/license/theAsmodai/metamod-r.svg?style=flat-square)](https://github.com/theAsmodai/metamod-r/blob/master/LICENSE). + +## Documentation +* All actual documentation in ![en](https://i.imgur.com/rm67tUZ.png) **English** and ![ru](https://i.imgur.com/ItziiKg.png) **Russian** languages is placed at [this link](https://github.com/theAsmodai/metamod-r/wiki). + +### Supported games +* ![en](https://i.imgur.com/rm67tUZ.png) Actual [list of supported games](https://github.com/theAsmodai/metamod-r/wiki/Supported-games). +* ![ru](https://i.imgur.com/ItziiKg.png) Обновляемый [список поддерживаемых игр](https://github.com/theAsmodai/metamod-r/wiki/Поддерживаемые-игры). -## Supported games -:x: - OS is not supported :heavy_check_mark: - OS is supported - -| Game \ Mod | Windows | Linux | Comment -| ------------- | ------| ------|------| -| [Action Half-Life](http://www.moddb.com/mods/action-half-life/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [Adrenaline Gamer](https://github.com/martinwebrant/agmod) | :heavy_check_mark: | :heavy_check_mark: | -| [Azure Sheep](http://www.moddb.com/mods/azure-sheep/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Base Defense](http://www.moddb.com/mods/b-def/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [Brain Bread](http://www.moddb.com/mods/brainbread/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Brutal Half-Life](http://www.moddb.com/mods/brutal-half-life/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Bumper Cars](http://www.moddb.com/mods/bumper-cars/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [BuzzyBots](http://www.moddb.com/mods/buzzybots/downloads) | :heavy_check_mark: | :x: | Have no linux binary. -| [Chicken Fortress 3](http://www.moddb.com/mods/chicken-fortress-3/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Counter-Strike 1.0](http://www.moddb.com/mods/counter-strike/downloads/counter-strike-10-for-steam) | :heavy_check_mark: | :x: | Have no linux binary. -| [Counter-Strike 1.5](http://www.moddb.com/mods/counter-strike/downloads/counter-strike-15-for-steam) | :heavy_check_mark: | :x: | Have no linux binary. -| [Counter-Strike 1.6](http://store.steampowered.com/app/10/CounterStrike/) | :heavy_check_mark: | :heavy_check_mark: | -| [Counter-Strike:Condition Zero](http://store.steampowered.com/app/80/CounterStrike_Condition_Zero/) | :heavy_check_mark: | :heavy_check_mark: -| [Counter-Strike:Condition Zero Deleted Scenes](http://store.steampowered.com/app/80/CounterStrike_Condition_Zero/) | :heavy_check_mark: | :heavy_check_mark: | SinglePlayer mod with MP-base. -| [Day of Defeat](http://store.steampowered.com/app/30/Day_of_Defeat/) | :heavy_check_mark: | :heavy_check_mark: -| [Deathmatch Classic](http://store.steampowered.com/app/40/Deathmatch_Classic/) | :heavy_check_mark: | :heavy_check_mark: -| [Desert Crisis](http://www.moddb.com/mods/desert-crisis/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Digital Paintball](http://www.moddb.com/mods/digital-paintball/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Earth's Special Forces](http://www.moddb.com/mods/earths-special-forces/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [Existence](http://www.moddb.com/mods/existence/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Firearms](http://www.moddb.com/mods/firearms/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Frontline Force](http://www.moddb.com/mods/front-line-force/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Gangsta Wars](http://www.moddb.com/mods/gangsta-wars/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Gangwars](http://www.moddb.com/mods/gangwars/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Global Warfare](http://www.moddb.com/mods/global-warfare/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Goldeneye](http://www.moddb.com/mods/goldeneye-mod/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Gunman Chronicles](http://www.moddb.com/games/gunman-chronicles/downloads/gunman-chronicles-steam-version/) | :heavy_check_mark: | :x: | Have no linux binary. -| [HL-Rally](http://www.moddb.com/mods/hl-rally/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [Half-Life](http://store.steampowered.com/app/70/HalfLife/) | :heavy_check_mark: | :heavy_check_mark: | Also supported [Bugfixed and improved HL release](https://github.com/LevShisterov/BugfixedHL). -| [Half-Life 1.5: Weapon Edition](http://www.moddb.com/mods/half-life-weapon-edition/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Half-Life: Blue Shift](http://store.steampowered.com/app/130/HalfLife_Blue_Shift/) | :heavy_check_mark: | :heavy_check_mark: | SinglePlayer mod with MP-base. -| [Half-Life: Decay](http://www.moddb.com/mods/half-life-decay/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Headcrab Frenzy](http://www.moddb.com/mods/headcrab-frenzy/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [Holy Wars](http://www.moddb.com/mods/holy-wars/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Hostile Intent](http://www.moddb.com/mods/hostile-intent/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [International Online Soccer](http://www.moddb.com/mods/international-online-soccer/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Judgement](http://www.moddb.com/mods/judgement/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Kanonball](http://www.moddb.com/mods/kanonball/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Master Sword](http://www.moddb.com/mods/master-sword/downloads/) [Continued](http://www.moddb.com/mods/master-sword-continued-111/downloads) | :heavy_check_mark: | :x: | Have no linux binary. -| [Monkeystrike](http://www.moddb.com/mods/monkeystrike/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Morbid Inclination](http://www.moddb.com/mods/morbid-inclination/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Move In!](http://www.moddb.com/mods/move-in/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Natural Selection](https://unknownworlds.com/ns/) | :heavy_check_mark: | :heavy_check_mark: | And `Beta` version too. -| [Open-Source Jailbreak](http://www.moddb.com/mods/open-source-jailbreak/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [openAG](https://github.com/YaLTeR/OpenAG) | :heavy_check_mark: | :heavy_check_mark: | Is an open-source client of `Adrenaline Gamer` mod. -| [Operations 1942](http://www.moddb.com/mods/operations-1942/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Opposing Force](http://store.steampowered.com/app/50/HalfLife_Opposing_Force/) | :heavy_check_mark: | :heavy_check_mark: -| [Out Break](http://www.moddb.com/mods/outbreak-half-life/downloads/) | :heavy_check_mark: | :x: | Have no linux binary. -| [Outlawsmod](http://www.moddb.com/mods/outlaws/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Over Ground](http://www.moddb.com/mods/over-ground/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Oz Deathmatch](http://ozdeathmatch.com/) | :heavy_check_mark: | :heavy_check_mark: -| [Paintball](http://www.bloodvayne.com/hlpb/downloads.htm) | :heavy_check_mark: | :heavy_check_mark: -| [Pirates, Vikings and Knights](http://www.moddb.com/mods/pirates-vikings-and-knights/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Point of No Return](http://www.moddb.com/mods/point-of-no-return/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Project Timeless](http://www.moddb.com/mods/project-timeless/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Public Enemy](http://www.moddb.com/mods/public-enemy/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Resident Evil : Cold Blood](http://www.moddb.com/mods/resident-evil-cold-blood/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Ricochet](http://store.steampowered.com/app/60/Ricochet/) | :heavy_check_mark: | :heavy_check_mark: -| [Rival Species](http://www.rivalspecies.com/files.php) | :heavy_check_mark: | :heavy_check_mark: -| [Rocket Crowbar](http://hldm.org/files/mods/287-rocket-crowbar.html) | :heavy_check_mark: | :heavy_check_mark: -| [Rocket Crowbar 2](http://www.moddb.com/mods/rocket-crowbar-2/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Science & Industry](http://www.moddb.com/mods/science-and-industry/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Scientist Hunt](http://www.moddb.com/mods/scientist-hunt/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Snow-War](http://www.moddb.com/mods/snow-war/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [StargateTC](http://www.moddb.com/mods/stargatetc/downloads/) | :heavy_check_mark: | :heavy_check_mark: | All versions: `1.x` and `2.x`. -| [Sven Coop](http://store.steampowered.com/app/225840/Sven_Coop/) | :heavy_check_mark: | :heavy_check_mark: | All versions: `legacy` and `steam`. -| [Swarm](http://www.moddb.com/mods/swarm/downloads) | :heavy_check_mark: | :heavy_check_mark: | -| [Team Fortress Classic](http://store.steampowered.com/app/20/Team_Fortress_Classic/) | :heavy_check_mark: | :heavy_check_mark: -| [The Battle Grounds](http://www.moddb.com/mods/battle-grounds/downloads/) | :heavy_check_mark: | :heavy_check_mark: | -| [The Ship](http://www.moddb.com/mods/the-ship) | :heavy_check_mark: | :heavy_check_mark: | -| [The Specialists](http://www.moddb.com/mods/the-specialists/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [The Trenches](http://www.moddb.com/mods/the-trenches-half-life/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [The Wastes](http://www.moddb.com/mods/the-wastes/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Tour of Duty](http://www.moddb.com/mods/tour-of-duty/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Train Hunters](http://www.moddb.com/games/half-life/addons?filter=t&kw=Train+Hunters&category=&licence=&timeframe=) | :heavy_check_mark: | :heavy_check_mark: -| [Underworld Bloodline](http://www.moddb.com/mods/underworld-bloodline/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [VampireSlayer](http://www.moddb.com/mods/vampire-slayer/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Wanted!](http://www.moddb.com/mods/wanted-the-western-mod-steam/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Wizard Wars](http://www.moddb.com/mods/wizard-wars/downloads/) | :heavy_check_mark: | :heavy_check_mark: | And `Beta` version too. -| [WormsHL](http://www.moddb.com/mods/wormshl/downloads/) | :heavy_check_mark: | :heavy_check_mark: -| [Zombie Panic](http://www.moddb.com/mods/zombie-panic/downloads/) | :heavy_check_mark: | :heavy_check_mark: - -## Build instructions -There are several software requirements for building rehlds: -
    -
  1. Java Development Kit (JDK) 7+ (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
    2. -
  2. For Windows: Visual Studio 2015 and later
    3. -
  3. For Linux: Intel C++ Compiler 13 and later
    4. -
- -### Checking requirements -#### JDK version -Windows
> %JAVA_HOME%\bin\javac -version
-javac 1.8.0_25
-
- -Linux -
$ javac -version
-javac 1.7.0_65
-
- -#### Visual Studio -Help -> About - -#### ICC -
$ icc --version
-icc (ICC) 15.0.1 20141023
-
- -### Building -On Windows: -
gradlew --max-workers=1 clean buildRelease
- -On Linux (ICC): -
./gradlew --max-workers=1 clean buildRelease
+### Build instructions +* ![en](https://i.imgur.com/rm67tUZ.png) [Build instructions](https://github.com/theAsmodai/metamod-r/wiki/Compilling-metamod-r). +* ![ru](https://i.imgur.com/ItziiKg.png) [Инструкция по сборке](https://github.com/theAsmodai/metamod-r/wiki/Компиляция-metamod-r).