cstrike/README.md

# FreeCS
[As seen on phoronix.com](https://phoronix.com/scan.php?page=news_item&px=FreeCS-Open-Counter-Strike)

Clean-room reimplementation of Counter-Strike 1.5 (mod-version).

Aiming for a stable reimagining of the original mod in QuakeC.
Not aiming for accuracy, but for a smooth, exploit and bug-free
experience over the Internet.

Done in my freetime for countless reasons, but most important to me: to learn everything there is to know about one of my favorite games.

This is all 100% new, original code written by good old trial and error.
**Differences exist** and features are slowly being implemented one by one.
This allows the code to be fully free and unencumbered, unlike similar projects.

Featuring proper weapon prediction to enable stress-free netplay.

The engine you want to use to run this is FTEQW (https://www.fteqw.org), which is a project unrelated to this. It just happens to support the file-formats FreeHL needs.

![Preview 1](img/preview1.jpg)
![Preview 2](img/preview2.jpg)
![Preview 3](img/preview3.jpg)
![Preview 4](img/preview4.jpg)

## Features and Improvements
* Native support for Windows/Mac/Linux/BSD and wherever else FTEQW runs on
* Better support for higher display modes and aspect ratios
* Much easier modding by having the entire logic be in modern QuakeC
* Netcode that's always improving and more advanced prediction
* Open-source code for transparent modding
* Very permissive license (ISC/BSD)
* The code doesn't rely on others work, so nobody can shut it down :-)

## Installation
Grab the latest binary release, extract and put an FTEQW engine binary (for your platform) into the same folder as the default.fmf and readme file.
Get FTEQW here: https://www.fteqw.org/

Run the engine and when in-game download the needed content, or optionally merge your own HL + CS 1.5 installation.

### Notes

*You'd think this disclaimer may be unnecessary but here we go:*

**This project is designed for the CS 1.5 data files.**

You will have a bad time if you use it with later or earlier versions.

You won't be able to connect to most people their servers. Content may be missing.

This is designed for CS 1.5 and the Half-Life CD data files **ONLY**.
**If you want to play and later version of CS, please do it on Steam.**

## Building
Make sure you've cloned the FreeHL repo (external) into the Nuclide-SDK.

Clone the repository into the Nuclide-SDK:

> git clone REPOURL cstrike

then either run Nuclide's `./build_game.sh cstrike` shell script, or issue `make` inside
./cstrike/src!

Obviously make sure that Nuclide has fteqw and fteqcc set-up for building.
But if you want to go about building this yourself, bring some experience with
the build environment with you.

## Community
Join us on #freecs via irc.libera.chat and talk/lurk or discuss bugs, issues
and other such things.
We've had people ask in the oddest of places for help, please don't do that.

## License
ISC License

Copyright (c) 2016-2021 Marco Hladik <marco@icculus.org>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.