Completed support of custom node backgrounds

Author: JanWichelmann

.gitignore

@@ -25,6 +25,7 @@ Thumbs.db
 *.lib
 *.sbr
 obj/
+.vs/
 [Rr]elease*/
 _ReSharper*/
 [Tt]est[Rr]esult*

AoKHBlacksmith.txt

@@ -34,7 +34,7 @@ A modded sample empires2_x1_p1.dat is in the "DATA" folder. "Editor" contains a
 [b]Requirements[/b]
 The tech tree view itself was built with Microsoft Visual Studio 2015, so you'll need [url=https://www.microsoft.com/de-de/download/details.aspx?id=48145]the appropiate Visual C++ redistributable[/url].
 
-The editor depends on the .NET Framework 4.0. It should already be installed on current windows systems; if not, you can find it [url=https://www.microsoft.com/en-us/download/details.aspx?id=17718]here[/url].
+The editor depends on the .NET Framework 4.5. It should already be installed on current windows systems; if not, you can find it [url=https://www.microsoft.com/en-us/download/details.aspx?id=30653]here[/url].
 
 To find out if all requirements are installed just start the programs, they will tell you when some dependencies are not found.
 
@@ -45,5 +45,16 @@ This software is published under the MIT/X11 license. Please read the LICENSE fo
 
 [b]Updates[/b]
 
+[u]1.2.0[/u]
+- Added support for custom tree element backgrounds
+- Upgraded editor to .NET 4.5
+
+[u]1.1.1[/u]
+View:
+- Fixed crash when switching civs in the tech tree view
+- Removed leftover vertical line below elements with hidden children
+Editor:
+- Fixed a few crashes when copying, pasting, moving and deleting nodes
+
 [u]1.1.0[/u]
-Implemented customizable designs and tree compression.
+Implemented customizable designs and tree compression

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2016 Jan Wichelmann
+Copyright (c) 2015-2017 Jan Wichelmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -8,13 +8,14 @@ As a consequence, the DAT tech tree structure used by this implementation is inc
 You can edit it with this tool: https://github.com/Janworks/AoETechTreeTool
 If you want to do more modding than just changing the tech tree view itself, use the TechTreeEditor, which also exports the new tech tree format: https://github.com/Janworks/TechTreeEditor
 
+I created this software while working on the (german) Agearena AddOn (http://www.agearena.de/forum/index.php?mode=viewforum&forum_id=7) and will update it periodically.
+
 
 ## USAGE
 
 Unpack the EXE and DLL files to the age2_x1 folder of Age of Empires II. If you haven't already created a custom empires2_x1_p1.dat with the new tech tree, you can unpack the empires2_x1_p1.dat of the archive into the DATA folder, replacing the old one (do not forget a backup!).
 
 The launcher starts the age2_x1.exe process and injects the TechTree.dll containing the code changes to add a new age.
-I created this software while working on the (german) Agearena AddOn (http://www.agearena.de/forum/index.php?mode=viewforum&forum_id=7) and will update it periodically.
 
 > AoETechTree.exe PARAMS
 
@@ -30,12 +31,7 @@ As this software is build with Microsoft Visual Studio 2015, you'll need the app
 
 This software was tested with the UserPatch v1.4 installed, so there should be no incompabilities.
 
-Also some virus scanners may have problems with this software, as it uses DLL injection to patch the running Age of Empires II process. This method is also used by many viruses, so some virus scanners block it by default. If you have problems running this software, try to create an exception in the scanners filter rules.
-
-
-## TODO
-
-* Add another renderer that is easier moddable and less hardcoded than the vanilla one in terms of age count, resolution and background images.
+Also some virus scanners may have problems with this software, as it uses DLL injection to patch the running Age of Empires II process. This method is also used by many viruses, so some virus scanners block it by default. If you have problems running this software, try to create an exception in the scanner's filter rules.
 
 
 ## LEGAL INFO & CREDITS

TechTree/TechTree.cpp

@@ -16,13 +16,40 @@
 // Override new operator with game new operator.
 void *operator new(unsigned int size)
 {
+	// Debug code for buffer overflow detection
+	// Puts two large 256 marker byte chunks before and after the allocated memory, which are then checked on deallocation.
+	// This will likely crash the game when destructing some controls, because the game destructor doesn't call the modified delete[] operator.
+	// But as long as one doesn't close the tech tree window, these lines shouldn't cause any further problems.
+	/*void *mem = ((void *(__cdecl *)(unsigned int))0x006137B0)(4 + 256 + size + 256 + 1);
+	reinterpret_cast<int *>(mem)[0] = size;
+	for(int i = 0; i < 256; ++i)
+		reinterpret_cast<unsigned char *>(mem)[4 + i] = 0xF0;
+	for(int i = 0; i < 256; ++i)
+		reinterpret_cast<unsigned char *>(mem)[4 + 256 + size + i] = 0xF1;
+	reinterpret_cast<unsigned char *>(mem)[4 + 256 + size + 256] = 0x00; // Deleted flag
+	return (void*)((int)mem + 4 + 256);*/
+
 	// Call game new
 	return ((void *(__cdecl *)(unsigned int))0x006137B0)(size);
 }
 
 // Override delete operator with game delete operator.
 void operator delete(void *ptr)
 {
+	// Debug code for buffer overflow detection
+	/*void *mem = (void *)((int)ptr - 4 - 256);
+	int size = ((int *)mem)[0];
+	for(int i = 0; i < 256; ++i)
+		if(reinterpret_cast<unsigned char *>(mem)[4 + i] != 0xF0)
+			__asm int 3;
+	for(int i = 0; i < 256; ++i)
+		if(reinterpret_cast<unsigned char *>(mem)[4 + 256 + size + i] != 0xF1)
+			__asm int 3;
+	if(reinterpret_cast<unsigned char *>(mem)[4 + 256 + size + 256] != 0x00)
+		__asm int 3;
+	reinterpret_cast<unsigned char *>(mem)[4 + 256 + size + 256] = 0x01;
+	((void(__cdecl *)(void *))0x006137BE)(mem);*/
+
 	// Call game delete
 	((void(__cdecl *)(void *))0x006137BE)(ptr);
 }

TechTree/TechTreeData.cpp

@@ -38,10 +38,6 @@ void TechTreeData::__Install()
 	CopyBytesToAddr(0x004268DD, patch1, sizeof(patch1));
 	INSTALL_WRAPPER_DIRECT(Constructor, 0x004268ED);
 
-	// Patch version number (no page protection change needed)
-	// NOTE: Replaced by special marker string after regular tech tree data to maintain compability with unpatched game versions
-	//*reinterpret_cast<char *>(0x0066B15A) = 'T';
-
 	// Install destructor (overwrite VTable address assignment as that isn't neccessary)
 	BYTE patch2[] =
 	{
@@ -61,15 +57,18 @@ TechTreeData::TechTreeData(int datFileHandle)
 	// -> dataBufferSize: The size of the data buffer.
 	int(__cdecl *ReadDataFromCompressedFile)(int fileHandle, char *dataBuffer, unsigned int dataBufferSize) = reinterpret_cast<int(__cdecl *)(int, char *, unsigned int)>(0x00542850);
 
-	// Read version marker
-	char techTreeVersionMarker[5];
-	ReadDataFromCompressedFile(datFileHandle, techTreeVersionMarker, 4);
-	techTreeVersionMarker[4] = '\0';
-	if(std::string("NTT1").compare(techTreeVersionMarker) != 0)
+	// Read marker
+	const unsigned char TECH_TREE_VERSION = 1;
+	char techTreeMarker[4];
+	unsigned char techTreeVersion;
+	ReadDataFromCompressedFile(datFileHandle, techTreeMarker, 3);
+	techTreeMarker[3] = '\0';
+	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&techTreeVersion), 1);
+	if(std::string("NTT").compare(techTreeMarker) != 0 || techTreeVersion != TECH_TREE_VERSION)
 	{
 		// Malformed data file, exit process with error message and let the OS do the cleanup (the game would have crashed anyway...)
-		std::string errorMessage = "Invalid tech tree version marker (expected NTT1): ";
-		MessageBoxA(NULL, (errorMessage + techTreeVersionMarker).c_str(), "Error reading DAT file", MB_OK | MB_ICONERROR);
+		std::string errorMessage = "Invalid tech tree marker (expected NTT, version " + std::to_string(TECH_TREE_VERSION) + "): " + techTreeMarker + ", version " + std::to_string(techTreeVersion);
+		MessageBoxA(NULL, errorMessage.c_str(), "Error reading DAT file", MB_OK | MB_ICONERROR);
 		ExitProcess(1);
 	}
 

TechTree/TechTreeDesign.cpp

@@ -89,8 +89,23 @@ TechTreeDesign::TechTreeDesign(int datFileHandle)
 	// Read popup bevel data
 	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(_popupBoxBevelColorIndices), 6);
 
-	// Read remaining data
+	// Read node data
 	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&_nodeFontIndex), 1);
+	int nodeBackgroundCount;
+	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&nodeBackgroundCount), 4);
+	for(int i = 0; i < nodeBackgroundCount; i++)
+	{
+		// Read and discard name
+		ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&len), 4);
+		char *garbage = new char[len];
+		ReadDataFromCompressedFile(datFileHandle, garbage, len);
+		delete[] garbage;
+
+		// Read and save frame index
+		int frameIndex;
+		ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&frameIndex), 4);
+		_nodeBackgrounds.push_back(frameIndex);
+	}
 }
 
 TechTreeDesign::~TechTreeDesign()

TechTree/TechTreeDesign.h

@@ -131,9 +131,13 @@ class TechTreeDesign
 	// The bevel (border) colors of the popup box.
 	unsigned char _popupBoxBevelColorIndices[6];
 
-	// The Index
+	// The font index of the tree node labels.
 	unsigned char _nodeFontIndex;
 
+	// The different node backgrounds; here only the frame indices for the node SLP are needed.
+	// The first three indices match the TechTreeElement::ItemType members, so each node type has a default background design.
+	std::vector<int> _nodeBackgrounds;
+
 public:
 	// Constructor. Reads the tech tree element data from the given DAT file handle.
 	// Parameters:

TechTree/TechTreeElement.cpp

@@ -45,14 +45,17 @@ TechTreeElement::TechTreeElement(int datFileHandle, TechTreeElement *parentBuild
 	short childElementCount;
 	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&childElementCount), 2);
 	for(int i = 0; i < childElementCount; ++i)
-		_children.push_back(new TechTreeElement(datFileHandle, ((_elementType == ItemType::Building || _elementType == ItemType::UniqueBuilding || _elementType == ItemType::SupportBuilding) ? this : parentBuilding)));
+		_children.push_back(new TechTreeElement(datFileHandle, (_elementType == ItemType::Building ? this : parentBuilding)));
 
 	// Read required elements
 	short requiredCount;
 	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&requiredCount), 2);
 	for(int i = 0; i < requiredCount; ++i)
 		_requiredElements.push_back(new RequiredElement(datFileHandle));
 
+	// Read background index
+	ReadDataFromCompressedFile(datFileHandle, reinterpret_cast<char *>(&_backgroundIndex), 4);
+
 	// Initialize name variables
 	_elementNameFirstLine[0] = '\0';
 	_elementNameSecondLine[0] = '\0';
@@ -145,7 +148,7 @@ void TechTreeElement::UpdateRenderState(char selectedCivId, int unknownGameAndPl
 
 		// Calculate DLL index
 		int dllIndex = -1;
-		if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable || (_elementType >= ItemType::UniqueUnit && _elementType <= ItemType::MercenaryUnit) || _elementType == ItemType::UniqueBuilding || _elementType == ItemType::SupportBuilding)
+		if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable)
 			dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_civs[selectedCivId]->_units[_elementObjectID]->_languageDllNameId + 9000;
 		else if(_elementType == TechTreeElement::ItemType::Research)
 			dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_researches->_researches[_elementObjectID]._languageDLLName1 + 10000;
@@ -157,7 +160,7 @@ void TechTreeElement::UpdateRenderState(char selectedCivId, int unknownGameAndPl
 		if(elementNameBuffer[0] == '\0')
 		{
 			// Determine ID
-			if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable || (_elementType >= ItemType::UniqueUnit && _elementType <= ItemType::MercenaryUnit) || _elementType == ItemType::UniqueBuilding || _elementType == ItemType::SupportBuilding)
+			if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable)
 				dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_civs[selectedCivId]->_units[_elementObjectID]->_languageDllNameId;
 			else if(_elementType == TechTreeElement::ItemType::Research)
 				dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_researches->_researches[_elementObjectID]._languageDLLName1;
@@ -234,7 +237,7 @@ void TechTreeElement::RequiredElement::UpdateDisplayName(char selectedCivId)
 
 		// Calculate DLL index
 		int dllIndex = -1;
-		if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable || (_elementType >= ItemType::UniqueUnit && _elementType <= ItemType::MercenaryUnit) || _elementType == ItemType::UniqueBuilding || _elementType == ItemType::SupportBuilding)
+		if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable)
 			dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_civs[selectedCivId]->_units[_elementObjectID]->_languageDllNameId + 9000;
 		else if(_elementType == TechTreeElement::ItemType::Research)
 			dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_researches->_researches[_elementObjectID]._languageDLLName1 + 10000;
@@ -246,7 +249,7 @@ void TechTreeElement::RequiredElement::UpdateDisplayName(char selectedCivId)
 		if(elementNameBuffer[0] == '\0')
 		{
 			// Determine ID
-			if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable || (_elementType >= ItemType::UniqueUnit && _elementType <= ItemType::MercenaryUnit) || _elementType == ItemType::UniqueBuilding || _elementType == ItemType::SupportBuilding)
+			if(_elementType == TechTreeElement::ItemType::Building || _elementType == TechTreeElement::ItemType::Creatable)
 				dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_civs[selectedCivId]->_units[_elementObjectID]->_languageDllNameId;
 			else if(_elementType == TechTreeElement::ItemType::Research)
 				dllIndex = (*_staticGameObjectPointer)->GetGameDataHandler()->_researches->_researches[_elementObjectID]._languageDLLName1;

TechTree/TechTreeElement.h

@@ -22,13 +22,7 @@ class TechTreeElement
 	{
 		Research = 0,
 		Creatable = 1,
-		Building = 2,
-        UniqueUnit = 3,
-        SupportUnit = 4,
-        RaiderUnit = 5,
-        MercenaryUnit = 6,
-        UniqueBuilding = 7,
-        SupportBuilding = 8
+		Building = 2
 	};
 
 	// The possible tech tree element render modes.
@@ -107,6 +101,9 @@ class TechTreeElement
 	// The types and IDs of required elements. These don't need to be real tree elements.
 	std::vector<RequiredElement *> _requiredElements;
 
+	// The element render background index.
+	int _backgroundIndex;
+
 	// The element render position (precomputed for performance reasons).
 	// This does not need to be a absolute pixel position; that depends on the renderer.
 	Point _renderPosition;