Init

DexrnZacAttack · DexrnZacAttack · commit 3e61416182e8 · 2025-03-06T16:52:14.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -398,3 +398,5 @@ FodyWeavers.xsd
 
 # JetBrains Rider
 *.sln.iml
+/out
+/.idea
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "lib/Lantern"]
+	path = lib/Lantern
+	url = https://github.com/LanternLCE/Lantern.git
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -0,0 +1,28 @@
+cmake_minimum_required(VERSION 3.30)
+project(LanternExampleMod)
+set (CMAKE_CXX_STANDARD 20)
+
+set(SRC_FILES
+        pch.h
+        pch.cpp
+        framework.h
+        TestMod.cpp
+        TestMod.h
+        LanternExampleMod.cpp
+        LanternExampleMod.h
+
+        Hooks/FJ/L10N.cpp
+        Hooks/FJ/L10N.h
+        Hooks/Minecraft.World/item/Item.cpp
+        Hooks/Minecraft.World/item/Item.h
+        Hooks/Minecraft.World/item/SwordItem.cpp
+        Hooks/Minecraft.World/item/SwordItem.h
+)
+
+include(GenerateExportHeader)
+add_subdirectory(lib/Lantern)
+include_directories(lib/Lantern/lantern lib/Lantern/lantern/lib/detours .)
+link_directories(out/build/lib/Lantern out/build/lib/Lantern/lib/detours)
+
+add_library(LanternExampleMod SHARED ${SRC_FILES})
+target_link_libraries(LanternExampleMod PRIVATE lib_detours ${CMAKE_SOURCE_DIR}/out/build/lib/Lantern/Lantern.lib)
diff --git a/Hooks/FJ/L10N.cpp b/Hooks/FJ/L10N.cpp
@@ -0,0 +1,8 @@
+﻿#include "pch.h"
+#include "L10N.h"
+
+wchar_t* L10N::GetString(uint32_t id)
+{
+    return L10N_GetString(id);
+}
+ 
diff --git a/Hooks/FJ/L10N.h b/Hooks/FJ/L10N.h
@@ -0,0 +1,19 @@
+#pragma once
+#include <Psapi.h>
+#include <iostream>
+#include <cstdio>
+#include <cstdint>
+#include "Util/Logger.h"
+#include "Util/HookHelper.h"
+
+class L10N {
+public:
+	/// <summary>
+	/// Gets a string from the LOC string table
+	/// </summary>
+	/// <param name="id">The ID of the string</param>
+	/// <returns></returns>
+	static wchar_t* GetString(uint32_t id);
+};
+
+CREATE_FUNC(L10N_GetString, 0x14078ee20, wchar_t*, uint32_t id);
diff --git a/Hooks/Minecraft.World/item/Item.cpp b/Hooks/Minecraft.World/item/Item.cpp
@@ -0,0 +1,8 @@
+#include "pch.h"
+#include "Item.h"
+
+void Item::registerItem(int id, std::wstring* str_id, Item* item)
+{
+    LOGW("Registering item ", *str_id, " (", L10N::GetString(item->descriptionId), ") with ID ", id);
+    Item_registerItem(id, str_id, item);
+}
diff --git a/Hooks/Minecraft.World/item/Item.h b/Hooks/Minecraft.World/item/Item.h
@@ -0,0 +1,47 @@
+#pragma once
+#include <Psapi.h>
+#include <iostream>
+#include <cstdio>
+#include <cstdint>
+#include "Util/Logger.h"
+#include "Util/HookHelper.h"
+#include "Hooks/FJ/L10N.h"
+
+class Item {
+public:
+    VTable vftable;
+    uint64_t* unk1;
+    uint64_t* unk2;
+    int maxStackSize;
+    int uses;
+    uint64_t* unk4;
+    uint64_t* unk5;
+    bool handEquipped;
+    uint8_t unk6[7];
+    uint64_t* unk7;
+    std::wstring unk8;
+    uint32_t descriptionId;
+    uint32_t useDescriptionId;
+    std::wstring name;
+    bool unk12;
+
+    class Tier {
+    public:
+        int level;
+        int uses;
+        float speed;
+        float attackDamageBonus;
+        int enchantmentValue;
+        int unk;
+    };
+
+    /// <summary>
+    /// Registers an Item
+    /// </summary>
+    /// <param name="id">The numerical ID of the item</param>
+    /// <param name="str_id">The string ID of the item</param>
+    /// <param name="item">An instance of the Item</param>
+    static void registerItem(int id, std::wstring* str_id, Item* item);
+};
+
+CREATE_FUNC(Item_registerItem, 0x140313f10, void, int param_1, std::wstring* param_2, Item* param_3);
diff --git a/Hooks/Minecraft.World/item/SwordItem.cpp b/Hooks/Minecraft.World/item/SwordItem.cpp
@@ -0,0 +1,16 @@
+#include "pch.h"
+#include "SwordItem.h"
+
+SwordItem* SwordItem::SwordItem_C1(SwordItem* self, Item::Tier* tier)
+{
+    // Log that it was called
+    LOGW(L"SwordItem ctor called");
+    // Here we modify the attack damage bonus to be an insane amount. (FLT_MAX)
+    // For some reason it also modifies a few other items... maybe they use the same constructor?
+    tier->attackDamageBonus = FLT_MAX;
+    // separate var incase we want to modify/view the value after it's created before we return.
+    // this calls the original function to continue initializing.
+    SwordItem* si = SwordItem_SwordItem_C1(self, tier);
+    // Then we return the result
+    return si;
+}
diff --git a/Hooks/Minecraft.World/item/SwordItem.h b/Hooks/Minecraft.World/item/SwordItem.h
@@ -0,0 +1,17 @@
+#pragma once
+#include <Psapi.h>
+#include <iostream>
+#include <cstdio>
+#include <cstdint>
+#include "Util/Logger.h"
+#include "Util/HookHelper.h"
+#include "Item.h"
+
+class SwordItem : Item {
+public:
+	// Fake constructor, static so it can be used when registering the hook.
+	static SwordItem* SwordItem_C1(SwordItem* self, Item::Tier* tier);
+};
+
+// "Create" funcs down here
+CREATE_FUNC(SwordItem_SwordItem_C1, 0x1404b5100, SwordItem*, SwordItem* self, Item::Tier* tier);
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Lantern
+Copyright (c) 2025 LanternLCE
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/LanternExampleMod.cpp b/LanternExampleMod.cpp
@@ -0,0 +1,26 @@
+// dllmain.cpp : Defines the entry point for the DLL application.
+#include "pch.h"
+#include "Util/Logger.h"
+#include "LanternExampleMod.h"
+
+BOOL APIENTRY DllMain( HMODULE hModule,
+                       DWORD  ul_reason_for_call,
+                       LPVOID lpReserved
+)
+{
+    switch (ul_reason_for_call)
+    {
+    case DLL_PROCESS_ATTACH:
+    case DLL_THREAD_ATTACH:
+    case DLL_THREAD_DETACH:
+    case DLL_PROCESS_DETACH:
+        break;
+    }
+    return TRUE;
+}
+
+TestMod* Initialize()
+{
+    LOGW(L"Starting TestMod");
+    return new TestMod();
+}
diff --git a/LanternExampleMod.h b/LanternExampleMod.h
@@ -0,0 +1,7 @@
+#pragma once
+#include "TestMod.h"
+
+extern "C" {
+	__declspec(dllexport) TestMod* Initialize();
+};
+
diff --git a/README.md b/README.md
@@ -1,2 +1,24 @@
 # ExampleMod
-Minimal example mod to show how to use Lantern
+Example mod to show how to use Lantern
+
+This mod does the following:
+- All swords deal +FLT_MAX damage (plus some other items for some reason)
+- Registered items get logged into the console
+
+## How to use
+- Clone the repo with recursive submodules
+- Open the project in Visual Studio or CLion
+- Build the project
+- In the output folder (out/build), grab the following files:
+  - LanternExampleMod.dll
+    - This is the mod
+  - lib/Lantern/Lantern.dll
+    - This is the mod loader.
+- Move Lantern.dll to the correct folder 
+  - (WinDurango) Place Lantern.dll into the Mods folder of MC (create if needed)
+  - (Other) Place Lantern.dll in any folder (empty recommended)
+- Create a subfolder named LanternMods in the same directory
+- Place LanternExampleMod.dll into LanternMods
+- Launch the game (Inject Lantern.dll if needed)
+  - WinDurango will automatically inject any DLLs in the Mods folder. 
+
diff --git a/TestMod.cpp b/TestMod.cpp
@@ -0,0 +1,37 @@
+#include "pch.h"
+#include "TestMod.h"
+#include "Util/HookHelper.h"
+#include "Hooks/Minecraft.World/item/Item.h"
+#include "InternalHooks/Minecraft.h"
+#include "Hooks/Minecraft.World/item/SwordItem.h"
+
+// This stores all the hooks
+std::vector<std::tuple<PVOID*, PVOID>> hooks;
+
+void TestMod::Enable()
+{
+	Minecraft::onMain->addEventListener([]()
+		{
+			LOG("Main called");
+			// Things that require the game to be started such as UWP dependant methods can be called here.
+		});
+
+	// Register hooks down here (May change in the future)
+	registerHook(&(PVOID&)SwordItem_SwordItem_C1, &SwordItem::SwordItem_C1); // Swords do a lot of damage
+	registerHook(&(PVOID&)Item_registerItem, &Item::registerItem); // Item::registerItem logging
+}
+
+void TestMod::Disable()
+{
+	unregisterHooks(hooks);
+}
+
+std::wstring TestMod::GetVersion()
+{
+	return L"1.0.0";
+}
+
+std::wstring TestMod::GetName()
+{
+	return L"Lantern Example Mod";
+}
diff --git a/TestMod.h b/TestMod.h
@@ -0,0 +1,24 @@
+#pragma once
+#include "LanternMod.h"
+
+class TestMod : public LanternMod
+{
+public:
+	/// <summary>
+	/// Runs when the mod is enabled
+	/// </summary>
+	void Enable() override;
+	/// <summary>
+	/// Runs when the mod is disabled
+	/// </summary>
+	void Disable() override;
+	/// <summary>
+	/// Gets the mod version
+	/// </summary>
+	std::wstring GetVersion() override;
+	/// <summary>
+	/// Gets the mod name
+	/// </summary>
+	std::wstring GetName() override;
+};
+
diff --git a/framework.h b/framework.h
@@ -0,0 +1,6 @@
+#pragma once
+
+#define WIN32_LEAN_AND_MEAN             // Exclude rarely-used stuff from Windows headers
+// Windows Header Files
+#include <Windows.h>
+#include <detours.h>
diff --git a/lib/Lantern b/lib/Lantern
@@ -0,0 +1 @@
+Subproject commit 6ecba794e6c10e6edd358c908029c0447112ec8f
diff --git a/pch.cpp b/pch.cpp
@@ -0,0 +1,5 @@
+// pch.cpp: source file corresponding to the pre-compiled header
+
+#include "pch.h"
+
+// When you are using pre-compiled headers, this source file is necessary for compilation to succeed.
diff --git a/pch.h b/pch.h
@@ -0,0 +1,13 @@
+// pch.h: This is a precompiled header file.
+// Files listed below are compiled only once, improving build performance for future builds.
+// This also affects IntelliSense performance, including code completion and many code browsing features.
+// However, files listed here are ALL re-compiled if any one of them is updated between builds.
+// Do not add files here that you will be updating frequently as this negates the performance advantage.
+
+#ifndef PCH_H
+#define PCH_H
+
+// add headers that you want to pre-compile here
+#include "framework.h"
+
+#endif //PCH_H

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "lib/Lantern"]`
	`2`	`+ path = lib/Lantern`
	`3`	`+ url = https://github.com/LanternLCE/Lantern.git`