Skip to content

Commit 51e59ce

Browse files
committed
docs(readme): update features, configuration and examples
1 parent 3ceb5fa commit 51e59ce

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22
<img src="assets/lime.svg" width=400>
33
</p>
44

5-
# 👋 Introduction
5+
## 👋 Introduction
66
Lime is a *cross-platform* framework that is focused on game modding and tries to provide you with useful features for your journey.
77

88

9-
# 🗒️ Features
9+
## 🗒️ Features
1010
- Detours
1111
- x86/x86-64
12-
- Supports lambdas as detours, similar to [rcmp](https://github.com/Smertig/rcmp)
12+
- Lambda support
1313
- Instruction
14-
- Allows to work with instructions (i.e. follow jumps/calls, ...)
14+
> Allows to work with instructions (i.e. follow jumps/calls, ...)
1515
- Memory Pages
16-
- Easy Allocation
16+
> Easily allocate and work with memory pages
1717
- Module
1818
- Iterate Loaded Modules
1919
- Iterate Symbols
20+
- Load Modules
2021
- Address
2122
- Read / Write Data
2223
- Signature Scanner
@@ -26,20 +27,24 @@ Lime is a *cross-platform* framework that is focused on game modding and tries t
2627

2728
> Lime follows the `RAII` paradigm, so you won't have to care about manually cleaning anything up (i.e. when allocating a page).
2829
29-
# ⚙️ Configuration
30+
## ⚙️ Configuration
3031

31-
### Entrypoint
32+
### Static Entrypoint
3233
```cmake
3334
set(lime_static_entrypoint ON)
3435
```
35-
> Uses a platform-independent method for the entrypoint implementation.
36-
> You do not need to enable this to make use of the cross-platform entrypoint!
3736

38-
### Tests
37+
Use a platform-independent method for the entrypoint implementation.
38+
You do not need to enable this to make use of the cross-platform entrypoint!
39+
40+
### VirtualAlloc2
3941
```cmake
40-
set(lime_tests ON)
42+
set(lime_no_alloc2 OFF)
4143
```
42-
> If `ON`, tests will be built.
44+
45+
Can be used to disable the usage of `VirtualAlloc2`.
46+
47+
This should be used for compatibility with wine as it currently does not support the `LowestStartingAddress` requirement.
4348

4449
# 📦 Installation
4550
- FetchContent
@@ -67,6 +72,8 @@ set(lime_tests ON)
6772
target_link_libraries(<YourLibrary> cr::lime)
6873
```
6974

70-
# 📖 Examples
75+
## 📖 Examples
76+
77+
https://github.com/Curve/lime/blob/7de073bd4736900193f6af5c543a3cf62e6f1a73/tests/hook.test.cpp#L46-L52
7178

72-
https://github.com/Curve/lime/blob/9ca0e477e6d5493f3b82ea79b51a2e2eb9f8b85f/tests/hook.test.cpp#L25-L29
79+
> For more examples see [tests](tests/)

0 commit comments

Comments
 (0)