popkun change

.gitignore

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

Makefile

@@ -232,8 +232,8 @@ $$(dll_$1_$2_$3) $$(implib_$1_$2_$3):	$$(obj_$1_$2_$3) $$(abslib_$1_$2_$3) \
 	$(ccache) $$(toolchain_$1)gcc -shared $$(srcdir_$3)/$3.def \
 		-o $$(dll_$1_$2_$3) -Wl,--out-implib,$$(implib_$1_$2_$3) \
 		$$^ $$(ldflags_$3) $(optflags_$1)
-	strip -s $$(dll_$1_$2_$3)
-	ranlib $$(implib_$1_$2_$3)
+	$$(toolchain_$1)strip -s $$(dll_$1_$2_$3)
+	$$(toolchain_$1)ranlib $$(implib_$1_$2_$3)
 
 endef
 
@@ -248,7 +248,7 @@ exe_$1_$2_$3	:= $$(bindir_$1_$2)/$3.exe
 $$(exe_$1_$2_$3): $$(obj_$1_$2_$3) $$(abslib_$1_$2_$3) $$(absdpl_$1_$2_$3) \
 		| $$(bindir_$1_$2)
 	$(ccache) $$(toolchain_$1)gcc -o $$@ $$^ $$(ldflags_$3) $(optflags_$1)
-	strip -s $$@
+	$$(toolchain_$1)strip -s $$@
 
 endef
 
@@ -259,7 +259,7 @@ define t_import
 impdef_$1_$2_$3	?= imports/import_$1_$2_$3.def
 
 $$(bindir_$1_$2)/lib$3.a: $$(impdef_$1_$2_$3) | $$(bindir_$1_$2)
-	dlltool -l $$@ -d $$<
+	$$(toolchain_$1)dlltool -l $$@ -d $$<
 
 endef
 

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_v$(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_v$(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_v$(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

@@ -5,6 +5,18 @@
     <patch_db __type="bool">0</patch_db>
     <!-- Force unlock music, charts, characters, and deco parts when applicable -->
     <force_unlocks __type="bool">0</force_unlocks>
+    <!-- Put customs into their own category (0: no, 1: simple category with all customs, 2: subcategories by folder name) -->
+    <custom_categ __type="u8">2</custom_categ>
+    <!-- Prevent customs from showing up in version folders -->
+    <custom_exclude_from_version __type="bool">1</custom_exclude_from_version>
+    <!-- Prevent customs from showing up in level folders -->
+    <custom_exclude_from_level __type="bool">0</custom_exclude_from_level>
+
+  <!-- Other categories -->
+    <!-- Bring back score challenge in the game for servers supporting it (only for kaimei onwards) -->
+    <score_challenge __type="bool">0</score_challenge>
+    <!-- Handle favorites through data_mods/<game>.<friendID>.fav files (Note: allows UNLIMITED favorites as well as favorites without an account/server) -->
+    <local_favorites __type="bool">0</local_favorites>
 
   <!-- Classic patches -->
     <!-- Prevent crash on boot when using a different default audio source (aka HDMI audio patch) -->
@@ -27,10 +39,6 @@
     <!-- quick_retire with pfree also enables quick retry: press numpad 8 during song or on result screen to retry (keep holding to skip option select) -->
     <quick_retire __type="bool">0</quick_retire>
 
-  <!-- Network features -->
-    <!-- Bring back score challenge in the game for servers supporting it (only for kaimei onwards) -->
-    <score_challenge __type="bool">0</score_challenge>
-
   <!-- Audio offset -->
     <!-- Offset the audio by x ms (negative plays audio earlier). This will disable keysounds -->
     <audio_offset __type="s8">0</audio_offset>
@@ -49,7 +57,7 @@
     <hispeed_default_bpm __type="u16">0</hispeed_default_bpm>
 
     <!-- IIDX-like hard gauge (start with full gauge, instant fail if gauge drops to 0) -->
-    <!-- Gauge details: increment: +0.1% for each cool/great/good (like spicy gauge), decrement: -9% for each bad, or -4.5% if gauge <=30% ) -->
+    <!-- Gauge details: increment: +0.1% for each cool/great/good (like spicy gauge), decrement: -9% for each bad, or -4.5% if gauge <=30% (like IIDX) -->
     <iidx_hard_gauge __type="bool">0</iidx_hard_gauge>
     <!-- Force full options by default (useful when no numpad is available) -->
     <force_full_opt __type="bool">0</force_full_opt>
@@ -96,14 +104,16 @@
        ======================================================================================== -->
 
   <!-- Datecode and Multiboot -->
-    <!-- Force a different datecode than the one found in ea3-config (yyyymmdd00) -->
-    <force_datecode __type="str"></force_datecode>
+    <!-- Force a different datecode than the one found in ea3-config (yyyymmdd00), or use "auto" to let music limit decide for you if patch_db is on -->
+    <force_datecode __type="str">auto</force_datecode>
     <!-- Also apply force_datecode to network packets -->
     <network_datecode __type="bool">1</network_datecode>
-    <!-- Disable multiboot auto conf tuning (which takes place when using popn22_yyyymmddrr.dll format and an xml without force_datecode option) -->
+    <!-- Disable multiboot auto conf tuning (which takes place when using popn22_yyyymmddrr.dll format and an xml without another datecode in force_datecode) -->
     <disable_multiboot __type="bool">0</disable_multiboot>
 
   <!-- Timing and lanes -->
+    <!-- Base visual offset (value will be added to the base SD (-60) and base HD (-76) values) -->
+    <base_offset __type="s8">0</base_offset>
     <!-- Automatically play keysounds during songs -->
     <disable_keysounds __type="bool">0</disable_keysounds>
     <!-- Offset the keysounds by x ms (negative is earlier). With disable_keysounds, becomes an audio offset -->
@@ -122,14 +132,30 @@
     <enhanced_polling_priority __type="s8">1</enhanced_polling_priority>
 
   <!-- Song db patches -->
-    <!-- Auto select patch file from data_mods folder (will detect datecode from ea3-config or force_datecode option) -->
+    <!-- Auto select patch file from data_mods folder based on music limit, or datecode otherwise (will detect datecode from ea3-config or force_datecode option) -->
     <patch_xml_auto __type="bool">1</patch_xml_auto>
     <!-- Manually set XML file containing patches (requires patch_xml_auto to be disabled) -->
     <patch_xml_filename __type="str"></patch_xml_filename>
-    <!-- Force the newly created buffers to be the same size as the original buffers -->
+    <!-- Force the newly created buffers to be the same size as the original buffers (not recommended) -->
     <disable_expansions __type="bool">0</disable_expansions>
-    <!-- Copy the new table information over top the old tables (automatically enables disable_expansions) -->
+    <!-- Copy the new table information over top the old tables (automatically enables disable_expansions) (not recommended) -->
     <disable_redirection __type="bool">0</disable_redirection>
+    <!-- Do not perform music limit checks for patch_xml_auto (not recommended) -->
+    <ignore_music_limit __type="bool">0</ignore_music_limit>
+
+  <!-- Custom category options -->
+    <!-- minimum songid for a song to be seen as "custom" -->
+    <custom_categ_min_songid __type="u16">4000</custom_categ_min_songid>
+    <!-- maximum songid for a song to be seen as "custom" (0 = no limit, not recommended since "random" category will use fake song ids in the 65400+ range) -->
+    <custom_categ_max_songid __type="u16">65400</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 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>
+    <!-- Optional secondary format used for older games only (Full colors supported, e.g. "[ol:4][olc:d92f0d]%s") -->
+    <custom_track_title_format2 __type="str"></custom_track_title_format2>
 
   <!-- Translation -->
     <!-- Disable .dict string replacements and .ips patches -->

popnhax/Module.mk

@@ -14,4 +14,5 @@ srcpp_popnhax      := \
     dllmain.cc \
     loader.cc \
     SearchFile.cc \
-    translation.cc
+    translation.cc \
+    custom_categs.cc

popnhax/config.h

@@ -4,6 +4,7 @@
 #include <stdbool.h>
 
 struct popnhax_config {
+    uint8_t game_version;
     bool practice_mode;
     bool hidden_is_offset;
     bool iidx_hard_gauge;
@@ -14,6 +15,11 @@ struct popnhax_config {
     bool quick_retire;
     bool back_to_song_select;
     bool score_challenge;
+    uint8_t custom_categ;
+    uint16_t custom_categ_min_songid;
+    uint16_t custom_categ_max_songid;
+    bool custom_exclude_from_version;
+    bool custom_exclude_from_level;
     bool force_hd_timing;
     uint8_t force_hd_resolution;
     bool force_unlocks;
@@ -26,12 +32,14 @@ struct popnhax_config {
     bool force_full_opt;
     bool netvs_off;
     bool guidese_off;
+    bool local_favorites;
 
     bool patch_db;
     bool disable_expansions;
     bool disable_redirection;
     bool disable_multiboot;
     bool patch_xml_auto;
+    bool ignore_music_limit;
     char patch_xml_filename[MAX_PATH];
     char force_datecode[11];
     bool network_datecode;
@@ -51,6 +59,11 @@ struct popnhax_config {
     uint8_t survival_gauge;
     bool survival_iidx;
     bool survival_spicy;
+    int8_t base_offset;
+    char custom_category_title[16];
+    char custom_category_format[64];
+    char custom_track_title_format[64];
+    char custom_track_title_format2[64];
 };
 
 #endif

popnhax/custom_categs.h

@@ -0,0 +1,10 @@
+#ifndef __CUSTOM_CATEGS_H__
+#define __CUSTOM_CATEGS_H__
+
+#include <stdint.h>
+#include "popnhax/config.h"
+
+bool patch_custom_categs(const char *dllFilename, struct popnhax_config *config);
+bool patch_local_favorites(const char *dllFilename, uint8_t version);
+
+#endif

popnhax/loader.cc

@@ -5,6 +5,7 @@
 
 #include "imports/avs.h"
 #include "util/patch.h"
+#include "util/log.h"
 #include "xmlhelper.h"
 
 #include "tableinfo.h"
@@ -66,7 +67,7 @@ uint32_t add_chart(uint32_t cur_idx, uint8_t *folder, uint8_t *filename, int32_t
                    uint32_t file_type, uint16_t used_keys, bool override_idx);
 
 void parse_charadb(const char *input_filename, const char *target);
-void parse_musicdb(const char *input_filename, const char *target);
+void parse_musicdb(const char *input_filename, const char *target, struct popnhax_config *config);
 
 std::map<uint32_t, int8_t> chart_type_overrides;
 
@@ -818,7 +819,7 @@ void parse_charadb(const char *input_filename, const char *target) {
     free(config_xml);
 }
 
-void parse_musicdb(const char *input_filename, const char *target) {
+void parse_musicdb(const char *input_filename, const char *target, struct popnhax_config *config) {
     if (!file_exists(input_filename)) {
         printf("Couldn't find %s, skipping...\n", input_filename);
         return;
@@ -915,6 +916,18 @@ void parse_musicdb(const char *input_filename, const char *target) {
                 }
             }
 
+            //force loading background for unilab
+            //m->mask |= 0x100;
+
+            if ( config->custom_categ
+              && config->custom_exclude_from_version
+              && idx >= config->custom_categ_min_songid
+              && (config->custom_categ_max_songid == 0 || idx <= config->custom_categ_max_songid) )
+            {
+                m->cs_version = 0;
+                m->folder = 0;
+            }
+
             if ((prop_chart = property_search(config_xml, prop, "charts/chart"))) {
                 for (; prop_chart != NULL; prop_chart = property_node_traversal(
                                                prop_chart, TRAVERSE_NEXT_SEARCH_RESULT)) {
@@ -992,7 +1005,7 @@ void parse_musicdb(const char *input_filename, const char *target) {
     free(config_xml);
 }
 
-void load_databases(const char *target_datecode) {
+void load_databases(const char *target_datecode, struct popnhax_config *config) {
 
     SearchFile s;
     printf("XML db files search...\n");
@@ -1013,11 +1026,11 @@ void load_databases(const char *target_datecode) {
         if ( strstr(result[i].c_str(), "musicdb") == NULL )
             continue;
         printf("(musicdb) Loading %s...\n", result[i].c_str());
-        parse_musicdb(result[i].c_str(), target_datecode);
+        parse_musicdb(result[i].c_str(), target_datecode, config);
     }
 }
 
-void musichax_core_init(bool force_unlocks, bool is_expansion_allowed, bool is_redirection_allowed,
+void musichax_core_init(struct popnhax_config *config,
                         char *target_datecode,
 
                         char *base_data,
@@ -1036,6 +1049,10 @@ void musichax_core_init(bool force_unlocks, bool is_expansion_allowed, bool is_r
 
                         uint64_t chara_size, uint64_t *new_chara_size, char *orig_chara_data,
                         uint8_t **new_chara_table) {
+    bool force_unlocks = config->force_unlocks;
+    bool is_expansion_allowed = !config->disable_expansions;
+    bool is_redirection_allowed = !config->disable_redirection;
+
     if (style_size > fontstyle_table_size) {
         fontstyle_table_size = style_size;
     }
@@ -1181,7 +1198,7 @@ void musichax_core_init(bool force_unlocks, bool is_expansion_allowed, bool is_r
             cur->chara_x, cur->chara_y, cur->unk1, cur->display_bpm, cur->hold_flags, true);
     }
 
-    load_databases((const char *)target_datecode);
+    load_databases((const char *)target_datecode, config);
 
     // Add some filler charts to fix some bugs (hack)
     for (int i = 0; i < 10; i++) {

popnhax/loader.h

@@ -2,10 +2,11 @@
 #define __LOADER_H__
 
 #include <stdint.h>
+#include "popnhax/config.h"
 
 int8_t get_chart_type_override(uint8_t *, uint32_t, uint32_t);
 
-void musichax_core_init(bool force_unlocks, bool is_expansion_allowed, bool is_redirection_allowed,
+void musichax_core_init(struct popnhax_config *config,
                         char *target_datecode, char *base_data, uint64_t music_size,
                         uint64_t *new_music_size, char *orig_music_data, uint8_t **new_music_table,
                         uint64_t chart_size, uint64_t *new_chart_size, char *orig_chart_data,

util/search.cc

@@ -73,3 +73,8 @@ int search(char *haystack, size_t haystack_size, const char *needle, size_t need
     int res = _search((unsigned char*) haystack, haystack_size, (const unsigned char *)needle, needle_size, orig_offset, 0);
     return res;
 }
+
+int search_debug(char *haystack, size_t haystack_size, const char *needle, size_t needle_size, size_t orig_offset) {
+    int res = _search((unsigned char*) haystack, haystack_size, (const unsigned char *)needle, needle_size, orig_offset, 2);
+    return res;
+}

util/search.h

@@ -2,5 +2,6 @@
 #define __SEARCH_H__
 
 int search(char *haystack, size_t haystack_size, const char *needle, size_t needle_size, size_t orig_offset);
+int search_debug(char *haystack, size_t haystack_size, const char *needle, size_t needle_size, size_t orig_offset);
 
 #endif