A binary-compatible C++ class mapping for Cube World version 0.9.1-5 for use in mod development.

For MSVC-STL binary compatibility with the existing Cube World classes, we require a compiler that will link the MSVC STL implementation. This project has settled on strictly requiring Clang/LLVM via Visual Studio 2019.

1. Setup Clang/LLVM with Visual Studio 2019 according to this article.
2. Create a new folder for your mod.

mkdir MyMod
cd MyMod
git init

3. Add this repo as a git submodule (or clone it, but submodule is preferred).

git submodule add https://github.com/CWTesseract/CWTCore

4. Create a CMakeLists.txt to build and link CWTCore.

cmake_minimum_required (VERSION 3.8)
project(MyMod)

// Add the CWTCore subdirectory for CMake to build.
add_subdirectory(CWTCore)

add_library (MyModDLL SHARED "main.cpp")

// Link and include CWTCore.
target_link_libraries (MyModDLL LINK_PUBLIC CWTCore)
target_include_directories (MyModDLL PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/CWTCore/include)

5. Create your main.cpp file.

#include <Windows.h>
#include "CWTCore.h"

using namespace CWT;

DWORD WINAPI MyFunc(LPVOID lpvParam) 
{
	// Wait until cube::Game is initialized.
	cube::Game* game = nullptr;
	while (game == nullptr) {
		game = CWT::GetGamePtr();
		Sleep(250);
	}

	// Set the local player HP.
	game->world->local_player->entity_data.hp = 500;

	return 0;
}


BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) {
	switch (fdwReason)
	{
	case DLL_PROCESS_ATTACH:
		CreateThread(NULL, 0, MyFunc, 0, 0, NULL);
	case DLL_THREAD_ATTACH:
	case DLL_THREAD_DETACH:
	case DLL_PROCESS_DETACH:
		break;
	}
	return TRUE;
}

6. Open your CMake project with Visual Studio 2019's Open Folder option.
7. If necessary, add the x64-Clang-Release build configuration according to the article above.
   • Note: You can NOT build this in debug mode, as the MSVC-STL adds extra fields that break binary compatibility.
8. Build.

• Where is the documentation?
  • There is none.