From 0581c1ee06a0bc48d8e7b3bfa4b02a33775b477a Mon Sep 17 00:00:00 2001 From: 3Mydlo3 Date: Sat, 4 Jan 2020 10:38:06 +0100 Subject: [PATCH 1/5] Update license link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b90d7c2e..91b43293 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Idea based on Arma 2 SerialKillers 2009 gamemode by NeoArmageddon and Mondkalb. -The mod and mission are on the same foundation as the ACE3 mod, using its framework, systems, tools and standards. It is entirely **open-source** and licensed under the GNU General Public License ([GPLv2](https://github.com/ArmaForces/Mods/blob/master/LICENSE)). +The mod and mission are on the same foundation as the ACE3 mod, using its framework, systems, tools and standards. It is entirely **open-source** and licensed under the GNU General Public License ([GPLv2](https://github.com/ArmaForces/SerialKillers/blob/master/LICENSE)). Huge appreciation and thanks to [ACE3 Team](http://ace3mod.com/team.html) for their open-source nature and permission to use their systems. From 8508511107f902a1967d4985d0bb3cc19f3927b9 Mon Sep 17 00:00:00 2001 From: 3Mydlo3 Date: Sat, 4 Jan 2020 11:13:24 +0100 Subject: [PATCH 2/5] Fix empty lines --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 91b43293..5427fd58 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@ The mod and mission are on the same foundation as the ACE3 mod, using its framew Huge appreciation and thanks to [ACE3 Team](http://ace3mod.com/team.html) for their open-source nature and permission to use their systems. - ## Setup ### Requirements @@ -43,11 +42,13 @@ _Replace `hemtt` with `hemtt.exe` on Windows._ - Run `$ hemtt clean` to clean build files **Windows Helpers:** + - Double-click `build.bat` to create a development build ### Recommended tools It's recommended to use [Visual Studio Code](https://) editor with following plugins to ensure equal development environment for all contributors: + - [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - [SQFLint](https://marketplace.visualstudio.com/items?itemName=skacekachna.sqflint) - [SQF Langauge](https://marketplace.visualstudio.com/items?itemName=Armitxes.sqf) From b168eb8e53cde33c63321367737bef29429e4e1d Mon Sep 17 00:00:00 2001 From: 3Mydlo3 Date: Tue, 14 Jan 2020 06:24:10 +0100 Subject: [PATCH 3/5] Add supported mods and maps lists --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5427fd58..28ff2216 100644 --- a/README.md +++ b/README.md @@ -53,3 +53,11 @@ It's recommended to use [Visual Studio Code](https://) editor with following plu - [SQFLint](https://marketplace.visualstudio.com/items?itemName=skacekachna.sqflint) - [SQF Langauge](https://marketplace.visualstudio.com/items?itemName=Armitxes.sqf) - [psioniq File Header](https://marketplace.visualstudio.com/items?itemName=psioniq.psi-header) + +## Supported Mods + +- [ACE](http://steamcommunity.com/sharedfiles/filedetails/?id=463939057) arsenal and interactions supersede vanilla solutions if possible + +## Supported Maps + +Every map with defined locations will work. From 68fdea7f396c6cdaa9d80990a4ff6a1e78464557 Mon Sep 17 00:00:00 2001 From: 3Mydlo3 Date: Tue, 14 Jan 2020 06:24:35 +0100 Subject: [PATCH 4/5] Add basic feature overview --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 28ff2216..195f166e 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,17 @@ It's recommended to use [Visual Studio Code](https://) editor with following plu - [SQF Langauge](https://marketplace.visualstudio.com/items?itemName=Armitxes.sqf) - [psioniq File Header](https://marketplace.visualstudio.com/items?itemName=psioniq.psi-header) +# Overwiew + +Police obtained information that up to 4 well equipped killers want to wreak havoc on Chernarus. Their task is simple - stop the assassins as soon as possible. However no one really cares about their predictions of the attack, so they have very limited equipment at the beginning, which is growing the closer killers are to their goal. + +- Play as a killer or a cop in this asymmetric yet somewhat balanced PvP scenario +- Cops start as ordinary patrol units armed with pistols +- As killer experience increasing difficulty the more civilians you kill +- Automatic civilians/vehicles generation according to settings +- Highly customizable gameplay settings +- Supports own weapons/vehicles configuration + ## Supported Mods - [ACE](http://steamcommunity.com/sharedfiles/filedetails/?id=463939057) arsenal and interactions supersede vanilla solutions if possible From 76ea40b024c99357179234606992450edd1fd13d Mon Sep 17 00:00:00 2001 From: 3Mydlo3 Date: Wed, 6 Mar 2024 10:51:36 +0100 Subject: [PATCH 5/5] Improve README --- README.md | 57 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 195f166e..132e7f41 100644 --- a/README.md +++ b/README.md @@ -14,15 +14,47 @@

Requires the latest version of CBA.

-**ArmaForces SerialKillers** is a gamemode created for the members of ArmaForces, polish Arma 3 community. +**ArmaForces SerialKillers** is a asymetric PvP gamemode created for the members of [ArmaForces](https//armaforces.com), polish Arma 3 community. Idea based on Arma 2 SerialKillers 2009 gamemode by NeoArmageddon and Mondkalb. -The mod and mission are on the same foundation as the ACE3 mod, using its framework, systems, tools and standards. It is entirely **open-source** and licensed under the GNU General Public License ([GPLv2](https://github.com/ArmaForces/SerialKillers/blob/master/LICENSE)). +The mod and the missions are on the same foundation as the ACE3 mod, using its framework, systems, tools and standards. It is entirely **open-source** and licensed under the GNU General Public License ([GPLv2](https://github.com/ArmaForces/SerialKillers/blob/master/LICENSE)). Huge appreciation and thanks to [ACE3 Team](http://ace3mod.com/team.html) for their open-source nature and permission to use their systems. -## Setup +## Overwiew + +> Police obtained information that up to 4 well equipped killers want to wreak havoc on Chernarus. Their task is simple - stop the assassins as soon as possible. However no one really cares about predictions of the attack, so the Police has a very limited equipment. + +**Play as a killer or a cop in this asymetric yet balanced-out scenario designed for fun first and competition second.** + +- As a cop, start as ordinary patrol unit armed with pistols only and obtain new gear the more successful killers are +- As a killer, experience increasing difficulty the more civilians you kill and the closer you are to your goal +- Chase or be chased in epic pursuits through your favourite maps +- Experience every game and every map differently due to civilians and vehicles generation algorithm +- Witness civilians trying to live their lives, travelling and committing roadkill (_albeit that's just Arma AI driving_) while being hunted by the killers +- Customize gameplay settings to your likings +- Create your own custom weapons/vehicles configuration + +## Supported Mods + +- [ACE](http://steamcommunity.com/sharedfiles/filedetails/?id=463939057) arsenal and interactions supersede vanilla solutions if possible + - Use [ACE No Medical](https://steamcommunity.com/sharedfiles/filedetails/?id=3053169823) patch for best experience +- CUP & RHS vehicles and equipment presets +- Any equipment/vehicle mod as long as you create custom equipment preset + +## Supported Maps + +Every map with defined locations will work. You only need to place police stations, jail and units (plus some more minor things). For examples see [Malden mission](https://github.com/ArmaForces/SerialKillers/tree/master/addons/missions/SK_test.Malden). + +Included scenarios: + +- Chernarus (Standard/Summer/Winter) +- Malden +- Tanoa (in progress) +- Werferlingen (in progress) + +## Development Setup ### Requirements @@ -53,22 +85,3 @@ It's recommended to use [Visual Studio Code](https://) editor with following plu - [SQFLint](https://marketplace.visualstudio.com/items?itemName=skacekachna.sqflint) - [SQF Langauge](https://marketplace.visualstudio.com/items?itemName=Armitxes.sqf) - [psioniq File Header](https://marketplace.visualstudio.com/items?itemName=psioniq.psi-header) - -# Overwiew - -Police obtained information that up to 4 well equipped killers want to wreak havoc on Chernarus. Their task is simple - stop the assassins as soon as possible. However no one really cares about their predictions of the attack, so they have very limited equipment at the beginning, which is growing the closer killers are to their goal. - -- Play as a killer or a cop in this asymmetric yet somewhat balanced PvP scenario -- Cops start as ordinary patrol units armed with pistols -- As killer experience increasing difficulty the more civilians you kill -- Automatic civilians/vehicles generation according to settings -- Highly customizable gameplay settings -- Supports own weapons/vehicles configuration - -## Supported Mods - -- [ACE](http://steamcommunity.com/sharedfiles/filedetails/?id=463939057) arsenal and interactions supersede vanilla solutions if possible - -## Supported Maps - -Every map with defined locations will work.