TeamAcediaBackend-scripts/cloakcatcher/README.md
2026-06-03 01:25:28 -03:00

51 lines
2.4 KiB
Markdown
Executable file

# CloakCatcher
## version 1.4.1
CloakCatcher is a small program written in Python 3 to identify users of the **CloakV4 cheat client**:
[Website](https://cloak-v4.web.app/)
[GitHub](https://github.com/TeamAcedia/CloakV4/)
**Do not share this script with anyone.** If a CloakV4 developer gets their hands on this script, it's useless. (lol nvm)
## Usage:
### Windows:
Install [Python 3](https://python.org/downloads/windows/)
**Make sure to select the option to install pip**
Then open Command Prompt and run:
`pip3 install requests`
To run the script, open the folder that contains the script in Command Prompt and run:
`python cloakcatcher.py`
To compile it to a Windows Executable (.exe):
Open Command Prompt in the folder CloakCatcher is in, and run:
`pip3 install pyinstaller`
followed by:
`python -m PyInstaller -Fn"CloakCatcher" cloakcatcher.py`
The executable is located in `dist\`. You can copy this file anywhere you like and remove the remaining files.
### Linux (Debian and Ubuntu, maybe Mint):
Install **Python 3**:
Run `sudo apt install python3` in Terminal
Run `sudo apt install python3-requests` in Terminal
or
`pip3 install requests --break-system-packages` in Terminal
To run the script:
Open Terminal in the folder CloakCatcher is in, and run:
`python3 cloakcatcher.py`
To compile it to an executable file:
Run `make`.
The executable is located in `bin/`. You can copy this file anywhere you like and remove the remaining files.
To remove files created during build time that are not needed:
Run `make clean`
To restore CloakCatcher's source code to the original state:
Run `make clean && make reset`
This will remove build files and executables, and clear the configuration file.
### MacOS/iOS/Android:
go get a real pc and chuck your current device out the window
## Config file:
The config file (`bin/cloakcatcher.conf`) stores configuration for CloakCatcher.
Here is the proper syntax of it:
{"cloakv4_username": "<Your CloakV4 username>", "cloakv4_password": "<Your CloakV4 password>", "server_ip": "<Server IP to scan>", "server_port": "<Server port to scan>", "serverlist_url": "<Serverlist URL>"}
serverlist_url should be set to "http://servers.luanti.org/list" unless you are targeting a specific list, **don't edit this unless you know what you are doing.**
**If you are using a compiled version, edit `bin/cloakcatcher.conf` (created at buildtime). If you are directly running the script without compiling, edit `cloakcatcher.conf`**