Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jvnipers committed May 19, 2024
1 parent 4ae7f00 commit 1357817
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,16 @@
# CS2Fixes
# CS2UnlockCvars

CS2Fixes is a Metamod plugin with fixes and features aimed but not limited to zombie escape. This project also serves as a good example and help for source2mod and other developers.
CS2UnlockCvars is a plugin made by stripping [CS2Fixes](https://github.com/Source2ZE/CS2Fixes/) of most of its features and only leaving the cvar unlocking part intact.

## Installation

- Install [Metamod](https://cs2.poggu.me/metamod/installation/)
- Download the [latest release package](https://github.com/Source2ZE/CS2Fixes/releases/latest) for your OS
- Extract the package contents into `game/csgo` on your server
- Configure the plugin cvars as desired in `cfg/cs2fixes/cs2fixes.cfg`, many features are disabled by default
- OPTIONAL: If you want to setup admins, rename `admins.cfg.example` to `admins.cfg` which can be found in `addons/cs2fixes/configs` and follow the instructions within to add admins

## Fixes and Features
You can find the documentation of the fixes and features [here](../../wiki/Home).
All credit goes to CS2Fixes

## Why is this all one plugin? Why "CS2Fixes"?
The plugin unlocks all dev only and hidden convars and commands.

Reimplementing all these features as standalone plugins would duplicate quite a lot of code between each. Metamod is not much more than a loader & hook manager, so many common modding features need a fair bit of boilerplate to work with. And since our primary goal is developing CS2Fixes for all zombie escape servers, there is not necessarily a drawback to distributing our work in this form at the moment.
## Installation

The CS2Fixes name comes from the CSSFixes and CSGOFixes projects, which were primarily aimed at low-level bug fixes and improvements for their respective games. Long term, we see this plugin slimming down and becoming more similar to them. Since as the CS2 modding scene matures, common things like an admin system and RTV become more feasible in source2mod or a similar modding platform.
- Install [Metamod](https://www.sourcemm.net/downloads.php?branch=dev)
- Download the [latest release package](https://github.com/jvnipers/CS2UnlockCvars/releases/latest) for your OS
- Extract the package contents into `game/csgo` on your server

## Compilation

Expand All @@ -28,10 +21,8 @@ The CS2Fixes name comes from the CSSFixes and CSGOFixes projects, which were pri

### Instructions

Follow the instructions below to compile CS2Fixes.

```bash
git clone https://github.com/Source2ZE/CS2Fixes/ && cd CS2Fixes
git clone https://github.com/jvnipers/CS2UnlockCvars/ && cd CS2UnlockCvars
git submodule update --init --recursive

export MMSOURCE112=/path/to/metamod/
Expand Down

0 comments on commit 1357817

Please sign in to comment.