Skip to content

Commit 2bcbea8

Browse files
readme: update
1 parent a664df9 commit 2bcbea8

1 file changed

Lines changed: 25 additions & 20 deletions

File tree

README.md

Lines changed: 25 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
![Last Commit](https://img.shields.io/github/last-commit/titaniummachine1/Cheater_Detection?style=plastic&logo=github)
66
![Downloads](https://img.shields.io/github/downloads/titaniummachine1/Cheater_Detection/total?style=plastic&logo=github)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
[![Release](https://github.com/titaniummachine1/Cheater_Detection/actions/workflows/release.yml/badge.svg)](https://github.com/titaniummachine1/Cheater_Detection/actions/workflows/release.yml)
89

910
# Cheater_Detection
1011

@@ -18,11 +19,11 @@ Automatic bot and cheater detection with cheater prioritization, visuals based o
1819

1920
Click the badges below to download required dependencies:
2021

21-
[![LuaLib](https://img.shields.io/badge/Download-lnxLib-blue?style=for-the-badge&logo=github)](https://github.com/lnx00/Lmaobox-Library/releases/latest/)
22-
*Copy `lnxLib.lua` to your `%localappdata%/lua` folder.*
22+
[![LuaLib](https://img.shields.io/badge/Download-lnxLib-blue?style=for-the-badge&logo=github)](https://github.com/lnx00/Lmaobox-Library/releases/latest/)
23+
_Copy `lnxLib.lua` to your `%localappdata%/lua` folder._
2324

2425
[![TimMenu](https://img.shields.io/badge/Download-TimMenu-blue?style=for-the-badge&logo=github)](https://github.com/titaniummachine1/TimMenu/releases/download/v1.8.8/TimMenu.lua)
25-
*Copy `TimMenu.lua` to your `%localappdata%/lua` folder.*
26+
_Copy `TimMenu.lua` to your `%localappdata%/lua` folder._
2627

2728
> [!NOTE]
2829
> Python 3 is optional but highly recommended to run the local HTTP bridge middleware for asynchronous background fetches.
@@ -36,7 +37,9 @@ Click the badges below to download required dependencies:
3637
<img width="643" height="744" alt="image" src="https://github.com/user-attachments/assets/41e758f9-a837-4d6e-ab0a-61e9a8f87f46" />
3738

3839
> [!IMPORTANT]
40+
>
3941
> ### ✅ Current Active Detections Status
42+
>
4043
> **Everything except aimbot detections is now live and running.**
4144
>
4245
> - **Database Engine**: Fully functional, stable, and highly optimized.
@@ -53,10 +56,10 @@ Click the badges below to download required dependencies:
5356

5457
We have completely re-engineered the backend storage and in-memory execution pipeline to offer massive performance gains **entirely for free**:
5558

56-
* **Hybrid Lexical Database Compression**: Storing \~31,000+ cheater database records using pre-compiled integer IDs—saving **80-90%** of disk storage and Lua heap space (**reducing script RAM by 5-10 MB**).
57-
* **Lazy Decompression**: Entries stay compressed in memory and are decompressed **only once** on-demand when a player joins the server.
58-
* **Zero-Allocation Gameplay Path**: The high-frequency callback loops (such as `CreateMove` and `Draw`) perform direct lookups against active player cache states, allocating **zero tables** during frame rendering. This completely eliminates game micro-stutters and garbage collection spikes.
59-
* **Instant Disk Saves**: Database flushing is optimized to complete in **\~200 ms** (down from several seconds of gameplay freeze).
59+
- **Hybrid Lexical Database Compression**: Storing \~31,000+ cheater database records using pre-compiled integer IDs—saving **80-90%** of disk storage and Lua heap space (**reducing script RAM by 5-10 MB**).
60+
- **Lazy Decompression**: Entries stay compressed in memory and are decompressed **only once** on-demand when a player joins the server.
61+
- **Zero-Allocation Gameplay Path**: The high-frequency callback loops (such as `CreateMove` and `Draw`) perform direct lookups against active player cache states, allocating **zero tables** during frame rendering. This completely eliminates game micro-stutters and garbage collection spikes.
62+
- **Instant Disk Saves**: Database flushing is optimized to complete in **\~200 ms** (down from several seconds of gameplay freeze).
6063

6164
---
6265

@@ -66,9 +69,9 @@ We have completely re-engineered the backend storage and in-memory execution pip
6669

6770
Every push to `main` triggers [`.github/workflows/release.yml`](.github/workflows/release.yml): embedded DBs are rebuilt, Lua is bundled, the version tag is bumped (`v1.4``v1.5`, etc.), and a GitHub Release is published with:
6871

69-
* `Cheater_Detection.lua` (bundled script)
70-
* `local_http_bridge_server.py` (optional bridge)
71-
* `SHA256SUMS.txt`
72+
- `Cheater_Detection.lua` (bundled script)
73+
- `local_http_bridge_server.py` (optional bridge)
74+
- `SHA256SUMS.txt`
7275

7376
Workflow artifacts are not kept (storage is purged after each run). To skip a release for a commit, include `[skip release]` in the commit message.
7477

@@ -79,13 +82,15 @@ Workflow artifacts are not kept (storage is purged after each run). To skip a re
7982
Cheater Detection ships with an optional localhost HTTP bridge in the `LocalBridge` folder.
8083

8184
When the bridge is running:
82-
* Online requests are processed asynchronously through the localhost promise-style bridge instead of blocking your gameplay.
83-
* The Python bridge handles HTTP fetch streams on a background thread.
84-
* Lua polls for results lazily and maintains connection state.
85+
86+
- Online requests are processed asynchronously through the localhost promise-style bridge instead of blocking your gameplay.
87+
- The Python bridge handles HTTP fetch streams on a background thread.
88+
- Lua polls for results lazily and maintains connection state.
8589

8690
When the bridge is not running:
87-
* The script safely runs in standard offline database fallback mode.
88-
* Probe testing and online lookups are strictly throttled to unobtrusive windows (like when you are dead or on the main menu).
91+
92+
- The script safely runs in standard offline database fallback mode.
93+
- Probe testing and online lookups are strictly throttled to unobtrusive windows (like when you are dead or on the main menu).
8994

9095
### Running The Bridge
9196

@@ -97,13 +102,13 @@ When the bridge is not running:
97102

98103
## Project Layout
99104

100-
* `Cheater_Detection/services/http_queue.lua`: Owns the HTTP transport selection and fallback behavior.
101-
* `LocalBridge/local_http_bridge_server.py`: Asynchronous localhost bridge server middleware.
102-
* `LocalBridge/StartLocalBridge.bat`: Launcher utility for Windows users.
105+
- `Cheater_Detection/services/http_queue.lua`: Owns the HTTP transport selection and fallback behavior.
106+
- `LocalBridge/local_http_bridge_server.py`: Asynchronous localhost bridge server middleware.
107+
- `LocalBridge/StartLocalBridge.bat`: Launcher utility for Windows users.
103108

104109
---
105110

106111
## Contact
107112

108-
* [Contact me on Telegram](https://t.me/TerminatorMachine)
109-
* [Official Telegram Channel](https://t.me/TerminatorMachine)
113+
- [Contact me on Telegram](https://t.me/TerminatorMachine)
114+
- [Official Telegram Channel](https://t.me/TerminatorMachine)

0 commit comments

Comments
 (0)