init

README.md

@@ -0,0 +1,34 @@
+# Spire nix packages
+
+A set of tf2 related nix packages
+
+## Packages
+
+The following is currently packaged:
+
+- `ambuild`
+- `sourcepawn`
+- `metamod-source`
+- `sourcemod`
+
+
+### Sourcemod SDKs
+
+For the `sourcemod` package, you need to enable one or more SDKs at build time.
+The SDKs are packaged under the `hl2sdk` package and can be enabled like in the following example.
+
+```nix
+pkgs.sourcemod.override {sdks = {inherit (pkgs.hl2sdk) tf2;};};
+```
+
+## Building sourcepawn script
+
+```nix
+buildSourcePawnScript {
+  name = "test";
+  src = ./test.sp;
+};
+```
+
+By default the sourcemod includes are available.
+Additional includes can be added by setting the `includes` argument to an array of packages containing an `include` folder containing the `.inc` files.