Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/curve/lime
🍋 A cross-platform modding library
https://github.com/curve/lime
cpp cpp-library cpp20 cpp20-library cross-platform detours game-hacking hooking hooking-library memory-hacking modding modding-framework modding-library
Last synced: 16 days ago
JSON representation
🍋 A cross-platform modding library
- Host: GitHub
- URL: https://github.com/curve/lime
- Owner: Curve
- License: mit
- Created: 2021-09-15T18:34:43.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T13:08:36.000Z (6 months ago)
- Last Synced: 2024-05-22T13:32:31.979Z (6 months ago)
- Topics: cpp, cpp-library, cpp20, cpp20-library, cross-platform, detours, game-hacking, hooking, hooking-library, memory-hacking, modding, modding-framework, modding-library
- Language: C++
- Homepage:
- Size: 891 KB
- Stars: 10
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## 👋 Introduction
Lime is a *cross-platform* library that is focused on game modding and tries to provide you with useful features for your journey.
## 🗒️ Features
- Detours
- x86/x86-64
- Lambda support
- (Cross-Platform) Calling Convention support _(for lambdas!)_
- Instruction
- Get next / prev instruction
- Get immediates, displacement, size, mnemonic
- Calculate absolute target _(follow relative instructions...)_
- Memory Pages
- Allocate pages
- Anywhere
- Exactly at specified address
- In ±2GB range of specified address
- Read / Write / Restore protection
- Module
- Iterate Loaded Modules
- Iterate Symbols
- Load Modules
- Address
- Read / Write Data
- Signature Scanner
- Supports Traditional & IDA Signatures
- Cross-Platform Entrypoint
- _[MinGW]_ Proxy-DLL Generation
> [!NOTE]
> Lime follows `RAII` so you won't have to care about manually cleaning anything up (i.e. when allocating a page).
## ⚙️ Configuration
### Static Entrypoint
```cmake
set(lime_static_entrypoint ON)
```
> Default is: `OFF`
Use a platform-independent method for the entrypoint implementation.
You do not need to enable this to make use of the cross-platform entrypoint!
### VirtualAlloc2
```cmake
set(lime_no_alloc2 ON)
```
> Default is: `OFF`
Can be used to disable the usage of `VirtualAlloc2`.
~~This should be used for compatibility with wine as it currently does not support the `LowestStartingAddress` requirement.~~
Should work since wine 8.11 🎉
# 📦 Installation
* Using [CPM](https://github.com/cpm-cmake/CPM.cmake)
```cmake
CPMFindPackage(
NAME lime
VERSION 5.0
GIT_REPOSITORY "https://github.com/Curve/lime"
)
```
* Using FetchContent
```cmake
include(FetchContent)
FetchContent_Declare(lime GIT_REPOSITORY "https://github.com/Curve/lime" GIT_TAG v5.0)
FetchContent_MakeAvailable(lime)
target_link_libraries( cr::lime)
```
## 📖 Examples
https://github.com/Curve/lime/blob/7de073bd4736900193f6af5c543a3cf62e6f1a73/tests/hook.test.cpp#L46-L52
https://github.com/Curve/lime/blob/9ee66d3cc9e8976d5d8a40856d7ee5a09d32c415/tests/hook.test.cpp#L44-L52
> For more examples see [tests](tests/)
## 🌐 Who's using Lime
[profuis-patch](https://github.com/simplytest/profuis-patch)
> [Extend the list!](https://github.com/Curve/lime/issues/new)