Create README.md

This commit is contained in:
Lorenc 2019-04-03 23:54:56 +11:00 committed by GitHub
parent b1ae5966b8
commit 333a7ebab5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

127
README.md Normal file
View File

@ -0,0 +1,127 @@
<!-- PROJECT LOGO -->
<br />
<p align="center">
<a href="https://sfcnr.com">
<img src="https://i.imgur.com/Yzq9JiT.png" alt="Logo" width="128" height="128">
</a>
<h3 align="center">San Fierro Cops And Robbers</h3>
<p align="center">
A fun and old cops and robbers gamemode for the SA-MP multiplayer modification
<br /><br />
<a href="https://sfcnr.com"><strong>Play the live server svr.sfcnr.com:7777 »</strong></a>
</p>
</p>
<!-- TABLE OF CONTENTS -->
## Table of Contents
* [About the Project](#about-the-project)
* [Credits](#credits)
* [Getting Started](#getting-started)
* [Features](#features)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
<!-- ABOUT THE PROJECT -->
## About The Project
[![SF-CNR][sf-cnr]](https://sfcnr.com)
San Fierro Cops And Robbers begun in late 2012 of December as a basic incomplete cops and robbers server that took
the SA-MP community by being unique - for example, being the first Cops And Robber server to allow Deathmatch.
For over half a decade, San Fierro Cops And Robbers has been supported by thousands of players and has established
a childhood memory for many.
### Credits
* Lorenc ([@zeelorenc](https://twitter.com/zeelorenc))
* Stev
* Damen
* ThreeKingZ
#### And another big thanks to the crowdfund patreons that made this possible!
* Stev
* Nibble
* Banging7Grams
* Kova
* Queen
* Panther
Credits are generally added to the top of source files, if you are missing, message me!
<!-- GETTING STARTED -->
## Getting Started
For instructions on how to set up the server, please visit our [wiki](https://github.com/zeelorenc/sf-cnr).
<!-- USAGE EXAMPLES -->
## Features
### Trailer
[![trailer][trailer]](https://www.youtube.com/watch?v=ezZHpT4vgYY)
### List
There are dozens of features made available to users by the server
* Arresting as a COP (MMB to taze, cuff, arrest)
* Robbing stores and players
* Killing players
* Competitive experience/leveling algorithm
* Action packed gang wars - the most innovative
* Fight the house fire epidemic as a fireman (/fires)
* Chop wood as a lumberjack
* Kidnap players and hold them for ransom
* Blowing up the jail cells to break out criminals from prisons
* Constant hit contracts placed on players anonymously
* Steal furniture and cash them at the Pawn Shop.
* Mine ores and export them
* Create methamphetamine in RVs and export to Cluckin' Bell
* Bank, drug house and ship hiests
* Rob NPC security trucks (just like GTA 5).
* Blowing up Alcatraz to release the high-risk criminals
* Jacking cars and exporting them in Shipyard containers.
* Rob atms around the server
* Gamble the finest and most addicting casinos in SA-MP
* Buy and sell /stocks ... we have a P2P tradable market with stocks that can be manipulated
* Race players using our fun outrun race feature (/race)
* Buy fireworks at a local 24/7 or Supa Save to celebrate an occasion
* Play 8-Ball Pool at any bar in San Andreas
* Play Poker (up to 6 players) at any casino in Las Venturas
* House, vehicle, garage, gate, gang facility, business systems available
* Boost The Trucking Company's stock price by Trucking
* Toy/clothes system (/toys)
* Paintball system to have endless training on DM
* Passive mode system to have an uninterrupted roleplay experience (auto enabled)
* Battle Royale Minigame
Mostly all of these features have been converted into modules that can be easily utilized not only by SF-CNR developers.
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE` for more information.
<!-- CONTACT -->
## Contact
Lorenc - [@zeelorenc](https://twitter.com/zeelorenc) - zeelorenc@hotmail.com
Project Link: [https://github.com/zeelorenc/sf-cnr](https://github.com/zeelorenc/sf-cnr)
[sf-cnr]: https://i.imgur.com/IuzVeBc.png
[trailer]: http://i3.ytimg.com/vi/ezZHpT4vgYY/hqdefault.jpg