diff --git a/README.md b/README.md index d75dff3c..d0ee0651 100644 --- a/README.md +++ b/README.md @@ -22,9 +22,11 @@ If you would like to use the SDK for a commercial purpose, please contact Valve Half-Life 1 ====================== -This is the README for the Half-Life 1 engine and its associated games. +This is the GitHub Repository for the Half-Life 1 engine and its associated games. -Please use this repository to report bugs and feature requests for Half-Life 1 related products. +Here, you can find the SDK code of the client & server DLLs for Half-Life, Deathmatch Classic and Ricochet. The three DLLs are at their latest versions as published on Steam with the Half-Life 25th Anniversary Update. If you wish to use the older SDK from 2013, it can be found in the `steam_legacy` branch. + +Additionally you can use this repository to report bugs and feature requests for Half-Life 1 related products. Reporting Issues ---------------- diff --git a/devtools/readme.txt b/devtools/readme.txt new file mode 100644 index 00000000..bf72870f --- /dev/null +++ b/devtools/readme.txt @@ -0,0 +1,21 @@ +DEVTOOLS +======== +This folder contains two Python scripts to create resources for the Half-Life 1 engine. +Both may be run in a command-line. Both scripts require the pillow & image modules +which can be installed by running: + pip install pillow + pip install image + +IMAGE TO BACKGROUND +------------------- +Takes a source image (PSD/PNG/TGA), and partitions & converts the image to Targa (TGA) +format. The end result creates an 800x600 menu background for Half-Life 1 engine-based +games, which is to be placed in resource/background. + Usage: python image_to_background.py path_to_image (psd/png/tga) + + +IMAGE TO SPRITE +--------------- +Takes a source image (PSD/PNG/) and converts it to the Half-Life 1 engine's sprite (SPR) +format. + Usage: python image_to_spr.py path_to_image (psd/png) \ No newline at end of file