valve/README.md

# FreeHL
Clean-room reimplementation of Half-Life: Deathmatch and Half-Life (Experimental, this means Singleplayer is NOT complete).

Similar to FreeCS, this aims to recreate the feeling of the original game.
It's designed to work with the content from the CD version of the game.
Currently I do not aim to support the Steam version.

Netplay improvements, such as prediction of both player physics and weapon-logic
are present.

This is 100% original code, feel free to audit however you wish.
No proprietary SDKs have been looked at or taken apart, unlike similar projects.

![Preview 1](img/preview1.jpg)
![Preview 2](img/preview2.jpg)
![Preview 3](img/preview3.jpg)
![Preview 4](img/preview4.jpg)

## Installing 
To run it, all you need is [FTEQW](https://www.fteqw.org) and [the latest release .pk3 file](https://www.frag-net.com/pkgs/package_valve.pk3), which you save into `Half-Life/valve/`. That's about it. You can install updates through the **Configuration > Updates** menu.

## Building
Clone the repository into the Nuclide-SDK and build it:

```
$ git clone https://code.idtech.space/fn/valve valve
$ SKIP_UPDATE=1 SKIP_RADIANT=1 ./build_game.sh valve
```

You can also issue `make` inside `valve/src/`, but it won't build an `entities.def` file for use in Radiant (level editor family).

## Notes
The engine should automatically detect Half-Life when placed within the game directory, however you may need to pass `-halflife` just in case you have one massive directory with multiple FTE-supported games in it for example.

You can also launch mods like this: `fteqw -halflife -game cstrike`
Useful for development, so you don't always have to use the **Custom Game** menu.

## Community

### Matrix
If you're a fellow Matrix user, join the Nuclide Space to see live-updates and more!
https://matrix.to/#/#nuclide:matrix.org

### IRC
Join us on #freecs via irc.libera.chat and talk/lurk or discuss bugs, issues
and other such things. It's bridged with the Matrix room of the same name!

### Others
We've had people ask in the oddest of places for help, please don't do that.

## Special Thanks

- Spike for FTEQW and for being the most helpful person all around!
- Xylemon for the hundreds of test maps, verifying entity and game-logic behaviour
- Theuaredead`, preston22, dqus for various patches
- To my supporters on Patreon, who are always eager to follow what I do.
- Any and all people trying it, tinkering with it etc. :)

## License
ISC License

Copyright (c) 2016-2024 Marco Hladik <marco@icculus.org>

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00			`# FreeHL`
README: Put emphasis on the fact that Singleplayer is in fact, NOT playable just yet 2021-06-09 06:50:15 -07:00			`Clean-room reimplementation of Half-Life: Deathmatch and Half-Life (Experimental, this means Singleplayer is NOT complete).`
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
			`Similar to FreeCS, this aims to recreate the feeling of the original game.`
			`It's designed to work with the content from the CD version of the game.`
Update README.md 2021-03-19 05:05:40 -07:00			`Currently I do not aim to support the Steam version.`
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
			`Netplay improvements, such as prediction of both player physics and weapon-logic`
			`are present.`

			`This is 100% original code, feel free to audit however you wish.`
			`No proprietary SDKs have been looked at or taken apart, unlike similar projects.`

			`![Preview 1](img/preview1.jpg)`
			`![Preview 2](img/preview2.jpg)`
			`![Preview 3](img/preview3.jpg)`
			`![Preview 4](img/preview4.jpg)`

Update README.md 2024-03-02 09:33:58 -08:00			`## Installing`
			To run it, all you need is [FTEQW](https://www.fteqw.org) and [the latest release .pk3 file](https://www.frag-net.com/pkgs/package_valve.pk3), which you save into `Half-Life/valve/`. That's about it. You can install updates through the Configuration > Updates menu.
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
Update README.md 2024-03-02 09:33:58 -08:00			`## Building`
			`Clone the repository into the Nuclide-SDK and build it:`
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
Update README.md 2024-03-02 09:33:58 -08:00			```
			`$ git clone https://code.idtech.space/fn/valve valve`
			`$ SKIP_UPDATE=1 SKIP_RADIANT=1 ./build_game.sh valve`
			```
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
Update README.md 2024-03-02 09:33:58 -08:00			You can also issue `make` inside `valve/src/`, but it won't build an `entities.def` file for use in Radiant (level editor family).
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
Add note regarding custom games 2021-08-01 03:12:26 -07:00			`## Notes`
Update README.md 2024-03-02 09:33:58 -08:00			The engine should automatically detect Half-Life when placed within the game directory, however you may need to pass `-halflife` just in case you have one massive directory with multiple FTE-supported games in it for example.

			You can also launch mods like this: `fteqw -halflife -game cstrike`
			`Useful for development, so you don't always have to use the Custom Game menu.`
Add note regarding custom games 2021-08-01 03:12:26 -07:00
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00			`## Community`
Move the damage indicator drawing/caching code into the client module here from Nuclide-SDK. 2021-10-21 14:32:01 -07:00
			`### Matrix`
			`If you're a fellow Matrix user, join the Nuclide Space to see live-updates and more!`
			`https://matrix.to/#/#nuclide:matrix.org`

			`### IRC`
			`Join us on #freecs via irc.libera.chat and talk/lurk or discuss bugs, issues`
			`and other such things. It's bridged with the Matrix room of the same name!`

			`### Others`
			`We've had people ask in the oddest of places for help, please don't do that.`
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
Update README.md 2024-03-02 09:33:58 -08:00			`## Special Thanks`

			`- Spike for FTEQW and for being the most helpful person all around!`
			`- Xylemon for the hundreds of test maps, verifying entity and game-logic behaviour`
monster_alien_grunt: Fix health value. 2024-03-04 18:40:57 -08:00			- Theuaredead`, preston22, dqus for various patches
Update README.md 2024-03-02 09:33:58 -08:00			`- To my supporters on Patreon, who are always eager to follow what I do.`
			`- Any and all people trying it, tinkering with it etc. :)`

Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00			`## License`
			`ISC License`

Update README.md 2024-03-02 09:33:58 -08:00			`Copyright (c) 2016-2024 Marco Hladik <marco@icculus.org>`
Initial commit, carried over from Nuclide's Git on March 8th 2021 2021-03-08 01:53:48 -08:00
			`Permission to use, copy, modify, and distribute this software for any`
			`purpose with or without fee is hereby granted, provided that the above`
			`copyright notice and this permission notice appear in all copies.`

			`THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES`
			`WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF`
			`MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR`
			`ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES`
			`WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER`
			`IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING`
			`OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.`