Skip to main content

Runtime inspection toolkit for Unity IL2CPP applications — explore classes, methods, fields, and live objects in real time.

Project description

unity_helper

Runtime inspection toolkit for Unity IL2CPP applications — explore classes, methods, fields, and live objects in real time.

Python Platform License


✨ Overview

unity_helper is a Python toolkit for runtime inspection of Unity applications using the IL2CPP scripting backend. It provides reflection-like capabilities, allowing you to dynamically explore and interact with internal game structures directly from Python.


🚀 Features

  • Inspect Unity assemblies (images)
  • Explore classes, methods, and fields
  • Call methods dynamically at runtime
  • Read and modify field values
  • Interact with live Unity objects (Camera, Rigidbody, etc.)
  • Designed specifically for IL2CPP environments

⚡ Quick Start

from unity_helper import Il2cpp

ref = Il2cpp()

# Get a Unity class
time = ref.get_class_from_name(
    'UnityEngine.CoreModule.dll',
    'UnityEngine.Time'
)

print(time.name)

📦 Installation

pip install -U unity_helper

🧰 Requirements

  • Windows (64-bit)
  • Python 3.11+
  • Target application using Unity IL2CPP

🧪 Examples

🔹 Class & Method Inspection

time = ref.get_class_from_name(
    'UnityEngine.CoreModule.dll',
    'UnityEngine.Time'
)

print('Time info:', time.cls, time.name, time.object, time.type, time.instance)

for method in time.list_methods():
    print(
        'Method info:',
        method.name,
        method.address,
        method.methodInfo,
        method.is_static,
        method.param_count
    )

🔹 Calling Methods

import ctypes

set_timeScale = time.find_method('set_timeScale')
set_timeScale = time.method.set_timeScale # Getting a method the lazy way

if not set_timeScale.is_static:
    time.instance = 123456789

set_timeScale(ctypes.c_float(5))

Using ctypes directly:

new_set_timeScale = ctypes.WINFUNCTYPE(
    ctypes.c_void_p,
    ctypes.c_float
)(set_timeScale.address)

new_set_timeScale(5.0)

🔹 Field Access

for field in time.list_fields():
    print('Field:', field.name, field.type, field.is_static)

example_field = time.find_field('example_field')
example_field = time.field.example_field # Getting a field the lazy way


if not example_field.is_static:
    time.instance = 123456789

example_field.value = 9999

🔹 Working with Unity Objects

main_cam = ref.get_mainCamera()
rigidbody = unity_helper.objects.Rigidbody(123456789)

Rigidbody

velocity = rigidbody.velocity
velocity.y = 10
rigidbody.velocity = velocity

pos = rigidbody.position
print(pos.x, pos.y, pos.z)

Camera

fov = main_cam.fov
main_cam.fov = fov + 10.0

main_cam.enabled = not main_cam.enabled
print(main_cam.name)

🔹 Finding Objects

player = ref.find_object('Player')
player = ref.find_object_with_tag('Player')

🔹 Assemblies & Classes

for image in ref.list_assemblies():
    print(image)

for clazz in ref.list_classes_in_image('Assembly-CSharp.dll'):
    print(clazz.name)

🎯 Common Use Cases

  • Runtime debugging of Unity applications
  • Reverse engineering IL2CPP builds
  • Building tooling and automation scripts
  • Inspecting and modifying live game state
  • Creating game mods

⚠️ Important Notes

  • This is a Python script that must be executed within the game's process.
  • It does not work as a standalone script and cannot interact with external processes.
  • Running it outside of the game environment will not work.

🔴 Known issues

  • Accessing the scene property on a GameObject returns an invalid scene object
  • Calling a method via the built in call can lead to unexpected behavior sometimes

--

📝 TODO

📄 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unity_helper-1.2.8.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unity_helper-1.2.8-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file unity_helper-1.2.8.tar.gz.

File metadata

  • Download URL: unity_helper-1.2.8.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for unity_helper-1.2.8.tar.gz
Algorithm Hash digest
SHA256 a300ba5173be68dea77c5189aae2d3f93e585617c0a207654454d4a57447d353
MD5 9795306b1b329d937ed8265f4710b675
BLAKE2b-256 3ca486378e73167370772f6017684c8e73888d4d356c6639a13187e6b995d135

See more details on using hashes here.

File details

Details for the file unity_helper-1.2.8-py3-none-any.whl.

File metadata

  • Download URL: unity_helper-1.2.8-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for unity_helper-1.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 43fb8fe0c808c5512cfaa8736296ea82a69342d1ec36697c581c537ed352fad7
MD5 65b8a5bfc4fbca9c164659915f8c2b69
BLAKE2b-256 ef71842776d8e1c39e9a5df0acc711681773dc00e10191265a8189084a470d6d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page