Client Navigation Generator (rathena#6023)

Creates navigation files for the client.

Author: vstumpf

.gitignore

@@ -144,3 +144,6 @@ Thumbs.db
 
 # CMakeFiles
 /CMakeFiles/
+
+# generated files
+generated

Makefile.in

@@ -60,6 +60,7 @@ libconfig:
 
 tools:
 	@$(MAKE) -C src/tool
+	@$(MAKE) -C src/map tools
 
 rapidyaml:
 	@$(MAKE) -C 3rdparty/rapidyaml

doc/script_commands.txt

@@ -978,6 +978,11 @@ Only the special labels which are not associated with any script command are
 listed here. There are other kinds of labels which may be triggered in a similar
 manner, but they are described with their associated commands.
 
+OnNaviGenerate:
+
+This special label triggers when running the map-server-generator binary. It is used
+in combination with 'naviregisterwarp' to register extra warps for an npc.
+
 On<label name>:
 
 These special labels are used with Mob scripts mostly, and script commands
@@ -9446,6 +9451,20 @@ with the given character id.
 
 ---------------------------------------
 
+*naviregisterwarp("<Name of Link>", "<dest_map>", <dest_x>, <dest_y>)
+
+Only useful when using the map-server-generator. Registers an extra warp from this
+npc to the destination map/x/y for the generated client files.
+
+---------------------------------------
+
+*navihide
+
+Only useful when using the map-server-generator. Hides this npc and all links from
+this npc in the navigation generation.
+
+---------------------------------------
+
 ========================
 |7.- Instance commands.|
 ========================

npc/custom/warper.txt

@@ -16,6 +16,7 @@ RAPIDYAML_INCLUDE = -I../../3rdparty/rapidyaml/src -I../../3rdparty/rapidyaml/ex
 MAP_OBJ = $(shell ls *.cpp | sed -e "s/\.cpp/\.o/g")
 #MAP_OBJ += $(shell ls *.c | sed -e "s/\.c/\.o/g")
 MAP_DIR_OBJ = $(MAP_OBJ:%=obj/%)
+MAP_GEN_DIR_OBJ = $(MAP_OBJ:%=obj-gen/%)
 MAP_H = $(shell ls ../map/*.hpp) \
 	$(shell ls ../config/*.hpp) 
 
@@ -34,6 +35,9 @@ else
 	PCRE_CFLAGS=
 endif
 
+TOOLS_DEPENDS=map-server-generator
+TOOLS_FLAGS="-DGENERATE_NAVI"
+
 @SET_MAKE@
 
 #####################################################################
@@ -43,6 +47,8 @@ all: $(ALL_DEPENDS)
 
 server: $(SERVER_DEPENDS)
 
+tools: $(TOOLS_DEPENDS)
+
 clean:
 	@echo "	CLEAN	map"
 	@rm -rf *.o obj ../../@OMAP@@EXEEXT@
@@ -66,13 +72,22 @@ obj:
 	@echo "	MKDIR	obj"
 	@-mkdir obj
 
+obj-gen:
+	@echo "	MDIR	obj-gen"
+	@-mkdir obj-gen
+
 # executables
 
 map-server: obj $(MAP_DIR_OBJ) $(COMMON_AR) $(LIBCONFIG_AR) $(RAPIDYAML_AR)
 	@echo "	LD	@OMAP@@EXEEXT@"
 	@@CXX@ @LDFLAGS@ -o ../../@OMAP@@EXEEXT@ $(MAP_DIR_OBJ) $(COMMON_AR) $(LIBCONFIG_AR) $(RAPIDYAML_AR) @LIBS@ @PCRE_LIBS@ @MYSQL_LIBS@
 
 
+map-server-generator: obj-gen $(MAP_GEN_DIR_OBJ) $(COMMON_AR) $(LIBCONFIG_AR) $(RAPIDYAML_AR)
+	@echo "	LD	map-server-generator@EXEEXT@"
+	@@CXX@ @LDFLAGS@ -o ../../map-server-generator@EXEEXT@ $(MAP_GEN_DIR_OBJ) $(COMMON_AR) $(LIBCONFIG_AR) $(RAPIDYAML_AR) @LIBS@ @PCRE_LIBS@ @MYSQL_LIBS@
+
+
 # map object files
 #cause this one failling otherwise
 obj/npc.o: npc.cpp $(MAP_H) $(COMMON_H) $(LIBCONFIG_H) $(RAPIDYAML_H)
@@ -83,6 +98,14 @@ obj/%.o: %.cpp $(MAP_H) $(COMMON_H) $(LIBCONFIG_H) $(RAPIDYAML_H)
 	@echo "	CXX	$<"
 	@@CXX@ @CXXFLAGS@ $(COMMON_INCLUDE) $(LIBCONFIG_INCLUDE) $(PCRE_CFLAGS) $(RAPIDYAML_INCLUDE) @MYSQL_CFLAGS@ @CPPFLAGS@ -c $(OUTPUT_OPTION) $<
 
+obj-gen/npc.o: npc.cpp $(MAP_H) $(COMMON_H) $(LIBCONFIG_H) $(RAPIDYAML_H)
+	@echo "	CXX	$< (custom rule)"
+	@@CXX@ @CXXFLAG_CLEARS@ $(TOOLS_FLAGS) $(COMMON_INCLUDE) $(LIBCONFIG_INCLUDE) $(PCRE_CFLAGS) $(RAPIDYAML_INCLUDE) @MYSQL_CFLAGS@ @CPPFLAGS@ -c $(OUTPUT_OPTION) $<
+	
+obj-gen/%.o: %.cpp $(MAP_H) $(COMMON_H) $(LIBCONFIG_H) $(RAPIDYAML_H)
+	@echo "	CXX	$<"
+	@@CXX@ @CXXFLAGS@ $(TOOLS_FLAGS) $(COMMON_INCLUDE) $(LIBCONFIG_INCLUDE) $(PCRE_CFLAGS) $(RAPIDYAML_INCLUDE) @MYSQL_CFLAGS@ @CPPFLAGS@ -c $(OUTPUT_OPTION) $<
+
 # missing object files
 $(COMMON_AR):
 	@$(MAKE) -C ../common server

src/map/Makefile.in

@@ -10465,6 +10465,10 @@ void battle_adjust_conf()
 	if (battle_config.custom_cell_stack_limit != 1)
 		ShowWarning("Battle setting 'custom_cell_stack_limit' takes no effect as this server was compiled without Cell Stack Limit support.\n");
 #endif
+
+#ifdef GENERATE_NAVI
+	battle_config.dynamic_mobs = 1;
+#endif
 }
 
 /*=====================================

src/map/battle.cpp

@@ -209,6 +209,7 @@
     <ClInclude Include="mapreg.hpp" />
     <ClInclude Include="mercenary.hpp" />
     <ClInclude Include="mob.hpp" />
+    <ClInclude Include="navi.hpp" />
     <ClInclude Include="npc.hpp" />
     <ClInclude Include="packets.hpp" />
     <ClInclude Include="packets_struct.hpp" />
@@ -256,6 +257,7 @@
     <ClCompile Include="mob.cpp">
       <Optimization Condition="'$(Configuration)'=='Release'">Disabled</Optimization>
     </ClCompile>
+    <ClCompile Include="navi.cpp" />
     <ClCompile Include="npc.cpp" />
     <ClCompile Include="npc_chat.cpp" />
     <ClCompile Include="party.cpp" />

src/map/map-server.vcxproj

@@ -95,6 +95,9 @@
     <ClInclude Include="mob.hpp">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="navi.hpp">
+      <Filter>Header Files</Filter>
+    </ClInclude>
     <ClInclude Include="npc.hpp">
       <Filter>Header Files</Filter>
     </ClInclude>
@@ -226,6 +229,9 @@
     <ClCompile Include="mob.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="navi.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
     <ClCompile Include="npc.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>

src/map/map-server.vcxproj.filters

@@ -6,6 +6,8 @@
 #include <stdlib.h>
 #include <math.h>
 
+#include "../config/core.hpp"
+
 #include "../common/cbasetypes.hpp"
 #include "../common/cli.hpp"
 #include "../common/core.hpp"
@@ -41,6 +43,7 @@
 #include "mapreg.hpp"
 #include "mercenary.hpp"
 #include "mob.hpp"
+#include "navi.hpp"
 #include "npc.hpp"
 #include "party.hpp"
 #include "path.hpp"
@@ -4868,7 +4871,9 @@ void do_final(void){
 	do_final_battle();
 	do_final_chrif();
 	do_final_clan();
+#ifndef GENERATE_NAVI
 	do_final_clif();
+#endif
 	do_final_npc();
 	do_final_quest();
 	do_final_achievement();
@@ -5203,7 +5208,9 @@ int do_init(int argc, char *argv[])
 	do_init_instance();
 	do_init_chrif();
 	do_init_clan();
+#ifndef GENERATE_NAVI
 	do_init_clif();
+#endif
 	do_init_script();
 	do_init_itemdb();
 	do_init_channel();
@@ -5235,6 +5242,11 @@ int do_init(int argc, char *argv[])
 
 	ShowStatus("Server is '" CL_GREEN "ready" CL_RESET "' and listening on port '" CL_WHITE "%d" CL_RESET "'.\n\n", map_port);
 
+#ifdef GENERATE_NAVI
+	navi_create_lists();
+	runflag = CORE_ST_STOP;
+#endif
+
 	if( runflag != CORE_ST_STOP )
 	{
 		shutdown_callback = do_shutdown;

src/map/map.cpp

@@ -19,6 +19,7 @@
 #include "../common/timer.hpp"
 #include "../config/core.hpp"
 
+#include "navi.hpp"
 #include "script.hpp"
 
 struct npc_data;
@@ -812,6 +813,13 @@ struct map_data {
 
 	/* speeds up clif_updatestatus processing by causing hpmeter to run only when someone with the permission can view it */
 	unsigned short hpmeter_visible;
+#ifdef GENERATE_NAVI
+	struct {
+		std::vector<const struct npc_data *> npcs;
+		std::vector<const struct navi_link *> warps_into;
+		std::vector<const struct navi_link *> warps_outof;
+	} navi;
+#endif
 };
 
 /// Stores information about a remote map (for multi-mapserver setups).