Skip to content
Permalink
Browse files

Refactor readme

  • Loading branch information
TotallyNotElite committed Feb 14, 2020
1 parent 1efa3b1 commit 3e2e68e3543ac1feea2a196a3c3e96908d8ae7d7
Showing with 14 additions and 60 deletions.
  1. +14 −60 README.md
@@ -6,24 +6,14 @@

The software could be detected by VAC in the future. Only use it on accounts you won't regret getting VAC banned.

## Community
You can chat with other cathook users in [our official telegram group](https://t.me/nullworks) and the [cathook announcements channel](https://t.me/cathook_cheat).

## Reporting Issues

If some things doesn't work as expected, please open issues on GitHub using [this page](https://github.com/nullworks/cathook/issues).

## Contributing

Do you want to submit code to cathook? Please read `CONTRIBUTING.md` for a short introduction.

## Overview

Cathook is a training software designed for Team Fortress 2 for Linux. Cathook includes some joke features like

* Ignore Hoovy
* Encrypted chat
* IRC Support (Find other Cathook users in-game automatically)
* Sandvich aimbot
* Chance to get manually VAC banned by Valve

and a lot of useful features, including
@@ -32,60 +22,24 @@ and a lot of useful features, including
* Extremely customizable spam (you can make spam lines that'll include name of random dead enemy pyro or sniper)
* Follow Bots
* Navparser Bots (Walkbots than can walk on any map without manual configuration)
* Working crit hack (does not work right now (works right now))
* Working crit hack (Editors note: Not fully working on all weapons)
* Backtrack
* Automatic matchmaking
* And many more features!

[FULL LIST OF FEATURES HERE](https://github.com/nullworks/cathook/wiki/Feature-List-and-explanations) (list might be outdated)
[FULL LIST OF FEATURES HERE](https://github.com/nullworks/cathook/wiki/Feature-List-and-explanations) (Editors note: outdated)

# INSTALLATION
# Installing, updating, attaching (injecting)

## Automatic: (Ubuntu 18.04+/Fedora/Arch based only)
Run in terminal:
[View our short guide to installing and using cathook](https://github.com/nullworks/cathook/wiki/Installing,-Attaching-And-General-Infos)

* `bash <(wget -qO- https://raw.githubusercontent.com/nullworks/One-in-all-cathook-install/master/install-all)`

## Manual:

### Clone Cathook:
#### User mode:
```git clone --depth 1 https://github.com/nullworks/cathook```
#### Developer mode:
```git clone --recursive https://github.com/nullworks/cathook```
### Install dependencies:
#### Arch/Manjaro:
```
git boost cmake make gcc gdb lib32-sdl2 lib32-glew lib32-freetype2 rsync lib32-libglvnd dialog
```
#### Ubuntu
```
software-properties-common build-essential git g++ g++-multilib libboost-all-dev gdb libsdl2-dev:i386 libglew-dev:i386 libfreetype6-dev:i386 cmake dialog rsync
```
#### Fedora
```
cmake dialog make gcc-c++ glibc-devel.i686 freetype-devel.i686 SDL2-devel.i686 glew-devel.i686 boost-devel.i686 rsync gdb git
```
#### Other distros
You will have to find matching packages yourself.
### Compile Cathook:
Go into the cathook directory and run
```./update```
## Updating Cathook
Run the `update` script in Cathook folder.
Cathook requires a special data folder (contains shaders, font files, walkbot paths, etc). This folder is located at `/opt/cathook/data` and is generated automatically when you compile Cathook.
## Community
You can chat with other cathook users in [our official telegram group](https://t.me/nullworks) and the [cathook announcements channel](https://t.me/cathook_cheat).

## Injection
`sudo ./attach` to attach Cathook into TF2. Optionally, you can provide a PID (for bots or other linux users).
## Reporting Issues

`sudo ./attach-gdb` to attach and print backtrace in case TF2 crashes. Requires a debug Cathook build (run `./config` to configure the build mode). Some users report that this causes FPS drop in-game. This is recommended if you want to grab a log of what went wrong if Cathook is crashing on you ([report it!](https://github.com/nullworks/cathook/issues))
If some things doesn't work as expected, please open issues on GitHub using [this page](https://github.com/nullworks/cathook/issues).

## Followbots (outdated)
`cathook-ipc-server` allows you to run and control Followbots to do your evil bidding in-game. The installation for Followbots is quite complex, and will not be covered on this page. Obviously, you must have several user accounts ready to run TF2.
A guide for Followbots can be found here: [How to setup and use followbots.](https://www.youtube.com/watch?v=kns5-nw7xUg)
## Contributing

The installation script is as followed:
```bash
git clone --recursive https://github.com/nullworks/cathook-ipc-server && cd cathook-ipc-server && make -j4
```
To run the Followbot server, run `./bin/cathook-ipc-server`. You can also use `./bin/cathook-ipc-server &>/dev/null &` to run it in background.
Do you want to submit code to cathook? Please read `CONTRIBUTING.md` for a short introduction.

0 comments on commit 3e2e68e

Please sign in to comment.
You can’t perform that action at this time.