Skip to content

Commit 1281c22

Browse files
committed
feat(README): Add usage instructions.
1 parent 1542ca5 commit 1281c22

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,24 @@
22
A standalone YimMenu lua runtime for Legacy/Enhanced.
33
Strictly for educational purposes.
44

5+
## Usage
6+
1. Inject YimLuaAPI without YimMenu(V2) and load into Single Player
7+
2. Press insert, go to debug -> GTA Cache -> Rebuild Cache
8+
3. Wait for it to build the cache
9+
4. Close the game
10+
5. Restart inject YimLuaAPI and YimMenu(V2)
11+
12+
You only need to do steps 1-4 once.
13+
14+
> [!CAUTION]
15+
> This does **NOT** bypass the Anti-Cheat!
16+
> You must inject YimMenu or YimMenuV2 to join online.
17+
18+
519
## API Changes
620
This API is not 1 to 1 compatible with YimMenu's but it's pretty close.
721

22+
823
### Missing features
924
- `network.set_player_coords` Only works on local player
1025
- `network.set_all_player_coords` Only works on local player
@@ -17,20 +32,6 @@ This API is not 1 to 1 compatible with YimMenu's but it's pretty close.
1732
- `network.force_script_on_player` Complains about not being implemented, then does nothing
1833
- `network.send_chat_message` Complains about not being implemented, then does nothing
1934
- `network.send_chat_message_to_player` Complains about not being implemented, then does nothing
20-
- `vehicles.get_vehicle_display_name` Return an empty string
21-
- `vehicles.get_vehicle_display_name_string` Return an empty string
22-
- `vehicles.get_all_vehicles_by_class` Return an empty table
23-
- `vehicles.get_all_vehicles_by_mfr` Return an empty table
24-
- `weapons.get_weapon_display_name` Return an empty string
25-
- `weapons.get_weapon_display_name_string` Return an empty string
26-
- `weapons.get_all_weapons_of_group_type` Return an empty table
27-
- `weapons.get_all_weapons_of_group_type_string` Return an empty table
28-
- `weapons.get_all_weapon_components` Return an empty table
29-
- `weapons.get_all_weapon_components_string` Return an empty table
30-
- `weapons.get_weapon_component_display_name` Return an empty string
31-
- `weapons.get_weapon_component_display_name_string` Return an empty string
32-
- `weapons.get_weapon_component_display_desc` Return an empty string
33-
- `weapons.get_weapon_component_display_desc_string` Return an empty string
3435
- `script.start_launcher_script` Complains about not being implemented, then does nothing
3536

3637
### API Extentions

0 commit comments

Comments
 (0)