README update

This commit is contained in:
markmental 2025-12-27 20:53:30 -05:00
commit 302926cfe2

118
README.md
View file

@ -1,12 +1,112 @@
## YaPB # YaPB Noob Edition
[![Latest YaPB](https://img.shields.io/github/v/release/yapb/yapb)](https://github.com/yapb/yapb/releases/latest) [![Latest YaPB](https://github.com/yapb/yapb/workflows/build/badge.svg)](https://github.com/yapb/yapb/actions) [![YaPB License](https://img.shields.io/github/license/yapb/yapb)](https://github.com/yapb/yapb/blob/master/LICENSE) [![Downloads](https://img.shields.io/github/downloads/yapb/yapb/total)](https://github.com/yapb/yapb/releases/latest)
## ☉ About This is a fork of **YaPB (Yet Another POD-Bot)** focused on improving the *Noob / Newbie* difficulty experience.
It's a computer controlled players (bots) for the Counter-Strike b6.5 - 1.6 and Counter-Strike: Condition Zero. Bots allows you to play that games without connecting any game server or even without internet.
## ☉ Documentation The goal of **noob-edition** is not to make bots “dumber”, but to make them behave more like real beginner Counter-Strike players:
* English: https://yapb.readthedocs.io/en/latest/ - slower and less confident aim resolution
* Russian: https://yapb.readthedocs.io/ru/latest/ - heavy body-driven aiming (center-mass, leg hits)
- delayed lock-on and poor vertical correction
- messy, inaccurate firefights
- fewer headshots without artificial restrictions
Higher difficulties (Normal and above) are **unchanged** and retain the original YaPB behavior.
This fork is intended for:
- casual offline play
- learning maps and mechanics
- relaxed bot matches without instant headshot punishment
All credit for the original bot architecture, navigation, and AI systems goes to the YaPB project and its contributors. This fork builds on that work by tuning aim dynamics and behavior for beginner-friendly gameplay.
---
## ☉ Whats Different in Noob Edition
**Noob / Newbie difficulty only:**
- Reduced aim stiffness and increased damping
- Slower vertical correction → natural center-mass bias
- Delayed and imperfect target lock-on
- Fewer snap headshots, more prolonged firefights
- Bots panic, spray, reposition, and overcommit like real beginners
**Normal / Hard / Expert:**
- No changes
- Original YaPB behavior preserved
This approach avoids artificial randomness or hardcoded misses. The bots still *try* to aim correctly — they just struggle to execute cleanly.
---
## ☉ Building YaPB Noob Edition (Linux)
You can build YaPB Noob Edition locally using Meson and Ninja. A Python virtual environment is recommended.
### 1. Create and activate a virtual environment
```bash
python3 -m venv venv
source venv/bin/activate
````
### 2. Install build tools
```bash
pip install meson ninja
```
### 3. Configure and build
```bash
meson setup build
meson compile -C build
```
After a successful build, you will have:
```
build/yapb.so
```
This is the **YaPB Noob Edition** binary containing the modified Noob / Newbie difficulty behavior.
---
## ☉ Installation
Copy `yapb.so` to your Counter-Strike installation:
```
cstrike/addons/yapb/dlls/
```
YaPB Noob Edition runs **without MetaMod or AMX** and works in:
* offline games
* local listen servers
* bot-only matches
---
## ☉ Documentation & Waypoints
General YaPB documentation still applies:
* English: [https://yapb.readthedocs.io/en/latest/](https://yapb.readthedocs.io/en/latest/)
* Russian: [https://yapb.readthedocs.io/ru/latest/](https://yapb.readthedocs.io/ru/latest/)
Waypoint issues and requests should be filed in the official graph repository:
[https://github.com/yapb/graph](https://github.com/yapb/graph)
---
## ☉ Philosophy
Traditional “easy” bots often reduce accuracy while keeping perfect decision-making.
Noob Edition instead focuses on **human-like mistakes**:
> confident but wrong decisions
> slow correction instead of hesitation
> panic over precision
The result is a more believable and enjoyable beginner experience.
## ☉ Waypoints
All requests/bugs regarding bots navigation graph (waypoints) are located in this [repository](https://github.com/yapb/graph). if you have waypoint request, please post an issue there.