xash3d-fwgs/Documentation/bug-compatibility.md

# Bug-compatibility in Xash3D FWGS

Xash3D FWGS has special mode for games that rely on original engine bugs. In this mode, we emulate the behaviour of selected functions that may help running mods relying on engine bugs, but enabling them by default may break majority of other games.

At this time, we only have implemented GoldSrc bug-compatibility. It can be enabled with `-bugcomp` command line switch.

When `-bugcomp` is specified without argument, it enables everything. This behavior might be changed or removed in future versions.

When `-bugcomp` is specified with argument, it interpreted as flags separated with `+`. This way it's possible to combine multiple levels of bug-compatibility.

## GoldSrc bug-compatibility

| Flag    | Description | Games that require this flag |
| ------- | ----------- | ---------------------------- |
| `peoei` | Reverts `pfnPEntityOfEntIndex` behavior to GoldSrc, where it returns NULL for last player due to incorrect player index comparison | * Counter-Strike: Condition Zero - Deleted Scenes |
| `gsmrf` | Rewrites message at the moment when Game DLL attempts to write an internal engine message, usually specific to GoldSrc protocol. Right now only supports `svc_spawnstaticsound`, more messages added by request. | * MetaMod/AMXModX based mods |
| `sp_attn_none` | Makes sounds with attenuation zero spatialized, i.e. have a stereo effect. | Possibly, every game that was made for GoldSrc. |
Documentation: document bug compatibility mode 2022-08-10 06:41:03 +02:00			`# Bug-compatibility in Xash3D FWGS`

engine: turn bugcomp into flags that can be enabled/disabled separately 2024-04-21 15:52:15 +02:00			`Xash3D FWGS has special mode for games that rely on original engine bugs. In this mode, we emulate the behaviour of selected functions that may help running mods relying on engine bugs, but enabling them by default may break majority of other games.`
Documentation: document bug compatibility mode 2022-08-10 06:41:03 +02:00
			At this time, we only have implemented GoldSrc bug-compatibility. It can be enabled with `-bugcomp` command line switch.

engine: turn bugcomp into flags that can be enabled/disabled separately 2024-04-21 15:52:15 +02:00			When `-bugcomp` is specified without argument, it enables everything. This behavior might be changed or removed in future versions.
Documentation: document bug compatibility mode 2022-08-10 06:41:03 +02:00
engine: turn bugcomp into flags that can be enabled/disabled separately 2024-04-21 15:52:15 +02:00			When `-bugcomp` is specified with argument, it interpreted as flags separated with `+`. This way it's possible to combine multiple levels of bug-compatibility.
Documentation: document bug compatibility mode 2022-08-10 06:41:03 +02:00
engine: turn bugcomp into flags that can be enabled/disabled separately 2024-04-21 15:52:15 +02:00			`## GoldSrc bug-compatibility`
Documentation: document bug compatibility mode 2022-08-10 06:41:03 +02:00
engine: turn bugcomp into flags that can be enabled/disabled separately 2024-04-21 15:52:15 +02:00			`\| Flag \| Description \| Games that require this flag \|`
			`\| ------- \| ----------- \| ---------------------------- \|`
			\| `peoei` \| Reverts `pfnPEntityOfEntIndex` behavior to GoldSrc, where it returns NULL for last player due to incorrect player index comparison \| * Counter-Strike: Condition Zero - Deleted Scenes \|
engine: implement small Message Rewrite Facitility that allows to run mods that directly write internal GoldSrc messages 2024-04-21 19:09:58 +02:00			\| `gsmrf` \| Rewrites message at the moment when Game DLL attempts to write an internal engine message, usually specific to GoldSrc protocol. Right now only supports `svc_spawnstaticsound`, more messages added by request. \| * MetaMod/AMXModX based mods \|
engine: move attenuation none sound spatialize fix to bugcomp mode, as Xash native games use this 2024-09-05 12:43:55 +02:00			\| `sp_attn_none` \| Makes sounds with attenuation zero spatialized, i.e. have a stereo effect. \| Possibly, every game that was made for GoldSrc. \|