README

README.md

@@ -0,0 +1,28 @@
+# Cruelty Squad `mapbase` Mod
+Additional/extended entities for base game elements in Cruelty Squad maps.
+
+## Usage
+
+Install latest version from repository releases
+
+## Entities
+
+**`Elevator_Ext`** Extended version of base elevator with programmable start direction, speed, and sound pitch
+
+**`Water_Custom`** Programmable custom shader color when submerged
+
+**`light_dyn`** Extended version of `light` point entity with programmable Quake/Source style light animation, see property descriptions in TrenchBroom for a basic explanation
+
+![light_dyn](media/light_dyn-01.gif?raw=true)
+
+**`E_Pig`**
+
+**`E_Pig2`**
+
+**`Obj_Cult_Leader`**
+
+**`car_forklift`**
+
+**`o_pizzafull`**
+
+**`prop_copcar`**