assets + build rework

.gitignore

@@ -0,0 +1 @@
+*:Zone.Identifier

Module.mk

@@ -14,17 +14,15 @@ include popnhax/Module.mk
 #
 
 zipdir          := $(BUILDDIR)/zip
+popnhax_version := $(shell grep "define PROGRAM_VERSION" popnhax/dllmain.cc | cut -d'"' -f2)
 
-$(zipdir)/:
-	mkdir -p $@
+$(BUILDDIR)/popnhax_$(popnhax_version).zip: \
+	build/bin/avs2_1508-32/popnhax.dll
+	@echo ... $@
+	@mkdir -p $(zipdir)
+	@cp -a -p build/bin/avs2_1508-32/popnhax.dll $(zipdir)
+	@cp -r -a -p dist/popnhax/* $(zipdir)
+	@cd $(zipdir) \
+	&& zip -r ../popnhax_$(popnhax_version).zip ./*
 
-$(BUILDDIR)/popnhax.zip: \
-		build/bin/avs2_1508-32/popnhax.dll \
-		dist/popnhax/popnhax.xml \
-		dist/popnhax/D3d9.dll \
-		dist/popnhax/ifs_hook.dll \
-		| $(zipdir)/
-	echo ... $@
-	zip -j $@ $^
-
-all: $(BUILDDIR)/popnhax.zip
+all: $(BUILDDIR)/popnhax_$(popnhax_version).zip

README.md

@@ -2,10 +2,32 @@
 
 # popnhax
 
-Arcade game patcher.
+Patcher for pop'n music arcade game.
+
+Featuring pfree, instant retire, visual and audio offset adjust, 1000Hz input polling for true ms-based timing, unlimited favorites, auto hi-speed selection, iidx-like hard gauge and more..
 
 Based on [bemanihax](https://github.com/windyfairy/bemanihax) whose an updated version was included with omnimix v1
 
+### Features
+
+Refer to [popnhax.xml](https://github.com/CrazyRedMachine/popnhax/blob/main/dist/popnhax/popnhax.xml) for complete list and explanations
+
+More info could be found in [Release Notes](https://github.com/CrazyRedMachine/popnhax/releases) or in the [popnhax_tools](https://github.com/CrazyRedMachine/popnhax_tools) repository.
+
+### Run Instructions
+
+- Extract all files directly in the `contents` folder of your install.
+
+(**Note**: if you're running your dlls from `modules` subfolder, please rather copy them back into `contents` folder).
+
+- Edit `popnhax.xml` with a text editor and set your desired options.
+
+- Add `popnhax.dll` as an inject dll to your gamestart command or option menu.
+
+eg. modify your gamestart.bat to add `-k popnhax.dll` or `-K popnhax.dll` depending on the launcher you use.
+
+Some launchers also feature an option menu (accessible by pressing F4 ingame), in which case you can locate the "Inject Hook" setting in option tab. Enter `popnhax.dll` there.
+
 ### Build Instructions
 
-Should be working out of the box with MSYS2/MinGW32. Just run `make`.
+Using WSL is the recommended method. Just run `make`.

dist/popnhax/popnhax.xml

@@ -150,7 +150,7 @@
     <custom_categ_max_songid __type="u16">0</custom_categ_max_songid>
     <!-- Category title for customs -->
     <custom_category_title __type="str">Customs</custom_category_title>
-    <!-- Format used for category title (in BM2DXFontScript format, refer to popnhax_tools documentation)  -->
+    <!-- Format used for category title (in BM2DXFontScript format, refer to BM2DXFontScript.md in popnhax_tools repo)  -->
     <custom_category_format __type="str">[ol:4][olc:d92f0d]%s</custom_category_format>
     <!-- Format used for custom song titles on song select (Note: colors not working for kaimei and above, but rotation does, e.g. "* [rz:3]%s[/rz]" ) -->
     <custom_track_title_format __type="str"></custom_track_title_format>

popnhax/loader.cc

@@ -917,7 +917,7 @@ void parse_musicdb(const char *input_filename, const char *target, struct popnha
             }
 
             //force loading background for unilab
-            m->mask |= 0x100;
+            //m->mask |= 0x100;
 
             if ( config->custom_categ
               && config->custom_exclude_from_version