[Release] Sro++

[Iwa13]

I've made compatible my old sro stuffs with vSro client 1.188 and coalesced into this small library. It provides hooking packet receive, sending packet and some utility functions.


Documentation

 SroPP -> Library

static void BeginInitialize()
Begins to initialize the library, hook register functions should be called after that.

Exceptions

std::logic_error("SroPP is already initialized or initializing")

static void EndInitialize()
Applies all hooks and patches to client. Library should be initialized before running client. Otherwise, packet receive hook and WorkQueue class won't perform action at all, and consequently you won't be able to call sro-related functions safely.

Exceptions

std::logic_error("SroPP is not in initialization mode")

 SroPP -> Global functions

static void PostWork<Func>(Func func)
-Posts a lambda/function to silkroad's main thread, posted works are guaranteed to be processed in same order they are invoked and in single thread. All of sro-related functions should be called through this function unless you are calling them in hooked functions. Otherwise, it will lead to random crashes.

Arguments

func: A lambda/function that will be called from sro main thread.

Ver 1.1
static std::vector<char> MakeVector(T &val)
-Serializes specified value to vector<char>

Arguments

val: Value to be serialized.

Templates

T: A non-pointer and pod type.

 SroPP -> PacketHook

static void RegisterReceive<Func>(Func func)
Registers the function that will be called when packet is received. Only in game packets are captured, starts with character data packet. If you previously registered a function, it will be replaced.

Arguments

func: A lambda/function that suitable for bool(const SroPP::Packet& packet) call.

Return value of "func" argument: If you return true, that means you've handled packet and don't let client to handle it. Hereby you can add your own packet for specific purposes. Else client will handle packet.

Ver 1.1
static void RegisterSendLoginRequest<Func>(Func func)
Registers the function that will be called when login packet (0x6102) is written. Allows you to append custom data(e.g. HWID) to end of the login packet. If you previously registered a function, it will be replaced.

Arguments

func: A lambda/function that suitable for vector<char>() call.

Return value of "func" argument: The data that will be appended to end of the login packet (0x6102)

 SroPP -> Packet

uint16_t Opcode() const;

size_t Offset() const;
Returns current reading offset.

size_t Size() const;
Returns the maximum size that you can read.

void Write<T>(T value)
Writes "value" argument to buffer. It doesn't affect return value of Offset() and Size() functions.

Arguments

value: A non-pointer and pod value.

T Read<T>()
Reads specified type from buffer and increases offset.

Templates

T: A non-pointer and pod type.

void Peek(void* buffer, size_t size) const;

Exceptions

std::logic_error("end of stream (peek)")

void Read(void* buffer, size_t size) const;

Exceptions

std::logic_error("end of stream (read)")

void Write(const void* buffer, size_t size)
void WriteStringA(const char* str)
void WriteStringW(const wchar_t* str)
std::string ReadStringA() const;
std::wstring ReadStringW() const;

void Send()

Exceptions

std::logic_error("packet cannot be sent twice")

 SroPP -> Game

static void WriteChat(ChatGroup group, wchar_t* message, uint32_t color)
Writes a message to chatbox with specified group and color.

static const wchar_t* GetUIText(const wchar_t* codename)
Loads string from text data files by codename. If there aren't any matches, it will return empty string "".
You shouldn't call this function before media.pk2 file gets loaded.

 SroPP -> Global enums

enum class ChatGroup
{
All = 1,
PM = 2,
GM = 3,
Party = 4,
Guild = 5,
Notice = 10,
Union = 11,
Academy = 16,
};

Example code:

#include "SroPP.h"
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>

void printUIText(const wchar_t* codename)
{
	wchar_t buffer[1024];
	swprintf_s(buffer, L"%s -> '%s'", codename, SroPP::Game::GetUIText(codename));
	SroPP::Game::WriteChat(SroPP::ChatGroup::GM, buffer, 255 << 8);
}

//copied from: https://github.com/ProjectHax/ServerStats/blob/master/ServerStats/shared/stream_utility.cpp
#include <sstream>
#include <cctype>
#include <iomanip>
std::string DumpToString(const void* stream, size_t size)
{
	std::stringstream ss;
	auto buffer = static_cast<const unsigned char*>(stream);
	int fields[16];
	size_t index = 0;
	size_t cur = 0;
	size_t total = size;
	if (total == 0 || total % 16)
	{
		total += (16 - (total % 16));
	}
	for (size_t x = 0; x < total; x++)
	{
		fields[index++] = cur < size ? buffer[x] : 0;
		++cur;
		if (index == 16)
		{
			for (size_t y = 0; y < 16; y++)
			{
				if (cur - 16 + y < size)
				{
					ss << std::hex << std::setfill('0') << std::setw(2) << fields[y] << ' ';
				}
				else
				{
					ss << "   ";
				}
			}
			ss << "   ";
			for (size_t y = 0; y < 16; y++)
			{
				if (cur - 16 + y < size)
				{
					int ch = fields[y];
					if (std::isprint(ch) && !std::isspace(ch))
					{
						ss << (char)ch;
					}
					else
					{
						ss << '.';
					}
				}
				else
				{
					ss << '.';
				}
			}
			ss << std::endl;
			index = 0;
		}
	}
	return ss.str();
}

void printPacketDump(const SroPP::Packet& packet)
{
	std::string dump;
	auto appendf = [&dump](const char* format, ...)
	{
		char buf[256];
		va_list ap;
		va_start(ap, format);
		vsprintf_s(buf, format, ap);
		va_end(ap);
		dump.append(buf);
	};

	appendf("[Opcode: %4X] [Size: %Iu bytes]\n", packet.Opcode(), packet.Size());

	char packetBuffer[256];
	size_t bytesToDump = (std::min)(packet.Size(), sizeof(packetBuffer));

	if (bytesToDump > 0)
	{
		packet.Peek(packetBuffer, bytesToDump);
		dump.append(DumpToString(packetBuffer, bytesToDump));
	}

	if (size_t remaining = packet.Size() - bytesToDump)
		appendf("... + %lu bytes\n", remaining);

	dump.append("\n");
	OutputDebugStringA(dump.c_str());
}

BOOL WINAPI DllMain(HMODULE hModule, DWORD dwReason, void*)
{
	if (dwReason == DLL_PROCESS_ATTACH)
	{
		DisableThreadLibraryCalls(hModule);
		try
		{
			SroPP::Library::BeginInitialize();
			SroPP::PacketHook::RegisterReceive([](const SroPP::Packet& packet) -> bool
			{
				printPacketDump(packet);
				switch (packet.Opcode())
				{
					case 0xb045:
					{
						bool succeed = packet.Read<bool>();
						if (succeed)
						{
							uint32_t uniqueId = packet.Read<uint32_t>();
							wchar_t buffer[256];
							swprintf_s(buffer, L"Selected target ID: %lu", uniqueId);
							SroPP::Game::WriteChat(SroPP::ChatGroup::All, buffer, 0xFF00D8D8);
						}
					}
					break;
					case 0x3026:
					{
						uint8_t type = packet.Read<uint8_t>();
						if (type == 1)
						{
							uint32_t sender = packet.Read<uint32_t>();
							auto message = packet.ReadStringA();
							if (message == ".1")
							{
								printUIText(L"UIIT_MSG_GUILD_JOIN_RESULT");
								printUIText(L"SN_TALK_QTUTORIAL_CH_27");
								printUIText(L"SN_MOB_CH_GYO_CLON");
							}
						}
					}
					break;
				}
				return false;
			});
			SroPP::Library::EndInitialize();
		}
		catch (std::exception &ex)
		{
			MessageBoxA(NULL, ex.what(), "exception", MB_ICONERROR);
		}
	}
	return TRUE;
}

Example code for appending data to end of the login packet:

std::vector<char> onLoginRequest()
{
#pragma pack(push, 1)
	struct
	{
		uint32_t val1;
	} s;
#pragma pack(pop)
	
	s.val1 = 0x12345678;

	return SroPP::MakeVector(s);
}

BOOL WINAPI DllMain(HMODULE hModule, DWORD dwReason, void*)
{
	if (dwReason == DLL_PROCESS_ATTACH)
	{
		DisableThreadLibraryCalls(hModule);
		try
		{
			SroPP::Library::BeginInitialize();
			SroPP::PacketHook::RegisterSendLoginRequest(onLoginRequest);
			SroPP::Library::EndInitialize();
		}
		catch (std::exception &ex)
		{
			MessageBoxA(NULL, ex.what(), "exception", MB_ICONERROR);
			return FALSE;
		}
	}
	return TRUE;
}

thanks to pushedx for his attentive helps

[qoaway]

llgw ^^

[PortalDark]

Moved to correct section

[Royalblade*]

not bad dude.

Weeman released something very similar a few years back. Could've used that as a base.

[Gummieֆ']

What is this

[B1Q B0SS]

good

[Sonic `]

What does it do if i may ask
thanks for the respond, 2x_o0.

[qoaway]

Originally Posted by Aleჯco*

What is this

Originally Posted by Bobby`

What does it do if i may ask
thanks for the respond, 2x_o0.

It's a cpp library which allows you make advanced client side edits for your private server

[Konami$]

great

[Dracula Untold]

Same question . what is this?

[LastThief*]

If you don't know what is this, get out of the thread this isn't for you.

[EraSro]

very useful thanks dude

[Iwa13]

updated

Ver 1.1
static std::vector<char> MakeVector(T &val)
-Serializes specified value to vector<char>

Arguments

val: Value to be serialized.

Templates

T: A non-pointer and pod type.

Ver 1.1
static void RegisterSendLoginRequest<Func>(Func func)
Registers the function that will be called when login packet (0x6102) is written. Allows you to append custom data(e.g. HWID) to end of the login packet. If you previously registered a function, it will be replaced.

Arguments

func: A lambda/function that suitable for vector<char>() call.

Return value of "func" argument: The data that will be appended to end of the login packet (0x6102)

Example code for appending data to end of the login packet:

std::vector<char> onLoginRequest()
{
#pragma pack(push, 1)
	struct
	{
		uint32_t val1;
	} s;
#pragma pack(pop)
	
	s.val1 = 0x12345678;

	return SroPP::MakeVector(s);
}

BOOL WINAPI DllMain(HMODULE hModule, DWORD dwReason, void*)
{
	if (dwReason == DLL_PROCESS_ATTACH)
	{
		DisableThreadLibraryCalls(hModule);
		try
		{
			SroPP::Library::BeginInitialize();
			SroPP::PacketHook::RegisterSendLoginRequest(onLoginRequest);
			SroPP::Library::EndInitialize();
		}
		catch (std::exception &ex)
		{
			MessageBoxA(NULL, ex.what(), "exception", MB_ICONERROR);
			return FALSE;
		}
	}
	return TRUE;
}

[farukdgn]

Really great work, thanks!

[WeeMan1337]

Originally Posted by Royalblade*

not bad dude.

Weeman released something very similar a few years back. Could've used that as a base.

I think you mean Drew. edxSilkroadLoader has some similarities as well as SilkMod.