[WIP] PyLoader

10 Abr 2021, 08:23

PyLoader

This is a .asi plugin that makes it possible to make changes to the game code using python scripts. It's similar to MoonLoader but for python (Hence the name). Currently, the PyLoader is using python version 3.8x (Windows 7+) with nearly all of the CLEO4 opcodes present. This makes it possible to take advantage of the easier syntax and thousands of modules available for Python online.

What's working:
1. Error traceback on script crash (won't crash your game most of the time :p)
2. Ability to load, unload, reload scripts without restarting your game.
3. A Large number of python modules available and working.

Documentation about this stuff can be found here. Example scripts are here

Installation:

Install Visual C++ Redistributable 2019 x86 and asi loader
Download PyLoader.7z and extract everything in the game directory.

Note: You need v1.0 of the game.

Credits:

12 Abr 2021, 07:04

SCM: ✓
C++: ✓
Lua: ✓
C#: ✓
Python: ✓

SpoilerAbrir

On-topic: Any plans for Mod Loader support?

12 Abr 2021, 07:09

HzanRsxa2959 escreveu: ↑
12 Abr 2021, 07:04
SCM: ✓
C++: ✓
Lua: ✓
C#: ✓
Python: ✓
SpoilerAbrir

On-topic: Any plans to make it compatible with Mod Loader?

Can't say about that atm. There's already a lot of work to do to make it usable.

12 Abr 2021, 07:12

I understand.
Very nice project. Maybe this will motivate me to learn python.
Good luck!

12 Abr 2021, 20:08

Cool! Keep it up

03 Mai 2021, 09:07

It's been a while so, progress update

1. All of the opcodes have been ported.
2. Ported some of the custom cleo4 opcodes as well (non-bass)
3. Fixed issues with the high CPU usage and improved the script handler.
4. There's a snippet extension for VS Code here

Here are some sample scripts,

SpoilerAbrir

Código: Selecionar tudo

#CreateCar.py
import common, opcodes, hud, script

script.name("CreateCar")
script.author("Grinch_")
script.desc("Spawns a car when Left Shift is pressed")
script.version("1.0")

while True:
    common.wait(0)

    if common.key_pressed(0xA0):
        while common.key_pressed(0xA0):
            common.wait(0)

        handle = opcodes.get_player_char(0)
        if opcodes.is_char_in_any_car(handle):
            hud.set_help_message("Already in a car", False, False, False)
        else:
            opcodes.request_model(400)
            opcodes.load_all_models_now()
            coord = opcodes.get_char_coordinates(handle)
            car : int = opcodes.create_car(400, coord[0], coord[1], coord[2])
            opcodes.warp_char_into_car(handle, car)
            opcodes.mark_model_as_no_longer_needed(400)

Código: Selecionar tudo

#Message.py
import common, hud

print("Working directory: {}".format(common.get_working_dir()))
print("Game directory: {}".format(common.get_game_dir()))

while True:
    if (common.key_pressed(0x09)):
      hud.set_help_message("Hello World", False, False, False)

    common.wait(0)

More here

Download from here

16 Mai 2021, 10:45

Some more progress,

Added a wiki here
Added nop, set_raw, get_raw, read_float, write_float
Bug fixes for write_memory, read_memory, get_closet_ped, get_closet_vehicle
Added on_script_terminate event
Add an update checker
Cleaned up code
Fixed a startup crash #5
Scripts can now be loaded/unloaded during runtime
Added script.get_file_name()
script.load, script.unload, script.reload, script.get_desc, script.get_author, script.get_name(), script.get_file_name, script.get_version now takes script name as optional argument. More in wiki
Added a reload_all example

Download from here

03 Jun 2021, 10:06

PyLoader v0.05
1. Added bass opcodes & pybass3 (uses the same bass version as CLEO4)
2. Added more events, More about them here.

SpoilerAbrir

pedCreateEvent
pedRenderEvent
pedDestroyEvent
objCreateEvent
objRenderEvent
objDestroyEvent
vehCreateEvent
vehRenderEvent
vehDestroyEvent

With that, mostly all of the CLEO4 opcodes are now present, some might still have bugs.

Download here

05 Jun 2021, 00:51

Grinch_ escreveu: ↑
03 Jun 2021, 10:06
Added more events

Great! Love me some event-based scripting.
Any plans to add the following:

SpoilerAbrir

1.

Código: Selecionar tudo

on_game_save(hash : int)

This function is called after the game is saved.
hash - contains the crc32 of the save file.

2.

Código: Selecionar tudo

on_game_load(hash : int)

This function is called after the game is loaded.
hash - contains the crc32 of the save file. 0 if new game.

3.

Código: Selecionar tudo

on_save_confirmation(hash : int)

This function is called before the game is saved.
hash - contains the crc32 of the save file.

4.

Código: Selecionar tudo

on_system_initialized()

This function is called only once when the game is launched, just like MoonLoader.
Also, MoonLoader allows the scripts to run before scripts have initialized (before the game has loaded). Can the same be done with PyLoader, i.e., say that I were to port AutoID to PyLoader, how far would I get?

Comments:

For 1 and 2 it is as easy as calculating the CRC32 of the save file, while for 3 you have to call the function itself which calculates the crc32 of the save file, since the save file does not exist at that point. The last 4 bytes of the save file contain the crc32 of the save file, but do not use it! I had to learn the hard way: fastman92 Limit Adjuster removes it when it changes the save file format. Also, the hash must be consistent between the three events.
1, 2, 3: While CLEO+ and MoonLoader do return the save slot, I think crc32 of the save file is better since it is closer to CLEO saves and many more obvious reasons. I haven't found the function that calculates the crc32 hash of the save file yet, though.
3: This is a very important event considering what users had to go through before CLEO+. Needs to hook the function CGenericGameStorage::DoGameSpecificStuffBeforeSave (CLEO+ also does this). IIRC Plugin-SDK allows you to do this easily.

I personally think that script-reloading is a nightmare to deal with, so if you could add the following script properties:

work-in-pause (from MoonLoader)
forced-reloading-only (from MoonLoader)
self-reloading-only (only script itself can unload/reload itself)

A new event: on_camera_render (or on_script_process? Maybe you can find a better name).(Like CScriptEngine_Update) This function is called before the camera mover is updated. More information here.

Sorry if this seems too much, but these are just suggestions; do what you feel like.

Good luck!

05 Jun 2021, 01:46

HzanRsxa2959 escreveu: ↑
05 Jun 2021, 00:51

Grinch_ escreveu: ↑
03 Jun 2021, 10:06
Added more events
Great! Love me some event-based scripting.
Any plans to add the following:
SpoilerAbrir
1.
Código: Selecionar tudo
on_game_save(hash : int)
This function is called after the game is saved.
hash - contains the crc32 of the save file.

2.
Código: Selecionar tudo
on_game_load(hash : int)
This function is called after the game is loaded.
hash - contains the crc32 of the save file. 0 if new game.

3.
Código: Selecionar tudo
on_save_confirmation(hash : int)
This function is called before the game is saved.
hash - contains the crc32 of the save file.

4.
Código: Selecionar tudo
on_system_initialized()
This function is called only once when the game is launched, just like MoonLoader.
Also, MoonLoader allows the scripts to run before scripts have initialized (before the game has loaded). Can the same be done with PyLoader, i.e., say that I were to port AutoID to PyLoader, how far would I get?

Comments:

For 1 and 2 it is as easy as calculating the CRC32 of the save file, while for 3 you have to call the function itself which calculates the crc32 of the save file, since the save file does not exist at that point. The last 4 bytes of the save file contain the crc32 of the save file, but do not use it! I had to learn the hard way: fastman92 Limit Adjuster removes it when it changes the save file format. Also, the hash must be consistent between the three events.

1, 2, 3: While CLEO+ and MoonLoader do return the save slot, I think crc32 of the save file is better since it is closer to CLEO saves and many more obvious reasons. I haven't found the function that calculates the crc32 hash of the save file yet, though.

3: This is a very important event considering what users had to go through before CLEO+. Needs to hook the function CGenericGameStorage::DoGameSpecificStuffBeforeSave (CLEO+ also does this). IIRC Plugin-SDK allows you to do this easily.

I personally think that script-reloading is a nightmare to deal with, so if you could add the following script properties:

work-in-pause (from MoonLoader)

forced-reloading-only (from MoonLoader)

self-reloading-only (only script itself can unload/reload itself)

A new event: on_camera_render (or on_script_process? Maybe you can find a better name).(Like CScriptEngine_Update) This function is called before the camera mover is updated. More information here.

Sorry if this seems too much, but these are just suggestions; do what you feel like.

Good luck!

These are some good suggestions. Probably gonna take a while since am the only one :/.
Currently working on an alternative to the extension with proper IntelliSense support.
Imagem

Edit: "say that I were to port AutoID to PyLoader, how far would I get?" I haven't fully checked how it works but I'd say it'd be far better if you port it to asi insttead.

05 Jun 2021, 06:41

Grinch_ escreveu: ↑
05 Jun 2021, 01:46
These are some good suggestions.

Thanks. I voiced my concerns after experience with different GTA SA scripting plugins.

Grinch_ escreveu: ↑
05 Jun 2021, 01:46
Edit: "say that I were to port AutoID to PyLoader, how far would I get?" I haven't fully checked how it works but I'd say it'd be far better if you port it to asi insttead.

Thanks for the advice. Junior said this too, and that's the plan.

30 Jul 2021, 06:17

Suggestion:

Código: Selecionar tudo

make_hook(address : int, function : function)

From here. Here is the source. Maybe take a look at this file.

31 Jul 2021, 10:17

Here, this may be helpful for calculating the save file checksum:
https://github.com/x87/GTA-Save-Formats ... asasave.bt

And these are from re3 (for GTA 3):
https://github.com/GTAmodding/re3/blob/ ... e/PCSave.h
https://github.com/GTAmodding/re3/blob/ ... PCSave.cpp

27 Set 2021, 18:06

PyLoader v0.07
1. Fixed path issue
2. Added some missing python modules
3. Added on_restart & on_load_save events
4. Fix issue with char* call_function & call_method
5. Added a new hud class Download from here

06 Out 2021, 16:26

PyLoader v0.08

Add reload_all with new scripts support
Added force shutdown for infinite looping scripts
Added psdk classes - CClock, CHud, CSprite2d, CTimer, RwTexture, RwTexDictionary, RwRaster, RwObject, RwLLLink, RwLinkist
Added helper classes - camera, ped, vehicle
Rename cleo module to addition
Moved call_function, call_method, free_library, load_library, get_proc_address to memory module
Moved test_cheat to common module
Fixed bugs with call_function, call_method, get_raw, write_float, set_area_visible
Code refactoring

Forum.MixMods

[WIP] PyLoader

[WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader

Re: [WIP] PyLoader