Merge pull request #1 from HDest-Community/refactor-build-scripts

Refactor build scripts

.github/workflows/build-pk3/action.yml

@@ -4,6 +4,19 @@ runs:
   using: "composite"
   steps:
   - uses: actions/checkout@v4
+
   - uses: montudor/action-zip@v1
     with:
-      args: zip -r "HDest-Voxels-${{ env.SUFFIX }}.pk3" . -i filter/* models/* CHANGELOG.md LICENSE LICENSE.VoxelDoom MODELDEF.* README.md
+      args: zip -r "HDest-Voxels-Vanilla-${{ env.SUFFIX }}.pk3" . -i filter/* CHANGELOG.md LICENSE LICENSE.VoxelDoom README.md
+
+  - uses: montudor/action-zip@v1
+    with:
+      args: zip -r "HDest-Voxels-Peppergrinder-${{ env.SUFFIX }}.pk3" . -i models/Peppergrinder/* CHANGELOG.md LICENSE LICENSE.VoxelDoom MODELDEF.peppergrinder README.md
+
+  - uses: montudor/action-zip@v1
+    with:
+      args: zip -r "HDest-Voxels-Radtech-${{ env.SUFFIX }}.pk3" . -i voxels/Radtech/* CHANGELOG.md LICENSE LICENSE.VoxelDoom VOXELDEF.radtech README.md
+
+  - uses: montudor/action-zip@v1
+    with:
+      args: zip -r "HDest-Voxels-Full-${{ env.SUFFIX }}.pk3" . -i filter/* models/* voxels/* CHANGELOG.md LICENSE LICENSE.VoxelDoom MODELDEF.* README.md VOXELDEF.*

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+### Added
+
+-   Initial Release.
+-   Added Cheello's Voxel Doom & Doom II Assets
+-   Added Mickromash's HDest Voxels
+-   Added Peppergrinder Voxels
+-   Added Radtech Voxels
+
+[Unreleased]: https://github.com/HDest-Community/HDest-Voxels/commits/main/

README.md

@@ -1,6 +1,16 @@
 # HDest Voxels
 
+[![Nightly Build](https://github.com/HDest-Community/HDest-Voxels/actions/workflows/nightly.yml/badge.svg)](https://github.com/HDest-Community/HDest-Voxels/actions/workflows/nightly.yml)
 
+Voxels, for your hideous destruction.
+
+### Note
+
+Due to the way GZDoom loads Voxels/Models, the original sprite lumps need to be loaded in order for the voxels to replace them.  Because of this, simply downloading the repo as a ZIP will then require each addon to be loaded.  This can be circumvented by deleting the `VOXELDEF` or `MODELDEF` for the addons you choose not to run with (for example, If not running Peppergrinder, remove the `MODELDEF.peppergrinder` file from the root of the ZIP/repo to prevent GZDoom from attempting to load those voxels).
+
+However, There is a nightly build of this project that already splits out the various voxels/models for Vanilla Doom/HDest, Peppergrinder, Radtech, and other future addon voxels into separate PK3s, as well as providing a "Full" PK3 for those that have all of the included addons and don't want to load multiple files.  You can grab the latest nightly build below:
+
+[Latest Nightly Build](https://nightly.link/HDest-Community/HDest-Voxels/workflows/nightly/main/Artifacts.zip)
 
 ## Credits