readme.md

👾 menu

🗺️ comments navigation

1. @note:
2. @todo:
3. @test: [things to test] [date]
4. @credits:
5. @xref:

🧪 conventions

1. prefix classes with 'C' and interfaces classes 'I'

class CSomeClass;
class ISomeInterface;

2. postfix structures with '_t'

struct SomeStruct_t;

3. prefix enumerations with 'E'

enum ESomeEnum

4. thirdparty (sdk, dependencies) macroses should be uppercase

#define SOMEMACROS

5. prefix own macroses with the first filename character

#define M_SOMEMATHMACROS

📄 code style

1. all curly braces should be on it's own line

if (true)
{
	while (true)
	{
		// something...
	}
}

2. the first characters of variables must be like type

bool bSomeBool; int iSomeInt; float flSomeFloat; double dbSomeDouble;
char chSomeSymbol; const char* szSomeString (std::string too);
BYTE dSomeByte; DWORD dwSomeDword; unsigned uSomeInt + type (e.g. unsigned long ulOffset);
CSomeClass someClass; CSomeClass* pSomeClass;

3. enumerations must inherit type

enum ESomeEnum : short

3.1. enumerations members should be uppercase

SOME_ENUM_MEMBER = 0

4. includes paths must be separated with one slash

4.1. additional: file names preferably be lowercase

5. use number literal's (uppercase)

long lSomeLong = 0L;
unsigned int uSomeOffset = 0x0; // hex
unsigned int uSomeInt = 0U;
unsigned long ulSomeLong = 0UL;

6. use c++ style casts

void* pSomeHandle = const_cast<void*>(pSomeConstHandle);
int iSomeInt = static_cast<int>(flSomeFloat);
int* pSomePointer = *reinterpret_cast<int**>(pSomeAddress);

🔖 preprocessor definitions

1. _DEBUG - disable string encryption and activate external console logging (automatic switches with compilation configuration)
2. DEBUG_CONSOLE - activate external console logging but deactivate file logging

🔧 prerequisites

1. directx sdk
2. c++ redistributables

❓ faq

how do i open the menu?

• menu key is INSERT

how do i unload the cheat?

• panic key is END

🎈 additional dependencies

1. dear imgui
2. json
3. freetype font rasterizer
4. {fmt} formatting
5. minhook