Skip to content

detail running instructions #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

detail running instructions #1

wants to merge 1 commit into from

Conversation

drewrip
Copy link

@drewrip drewrip commented Dec 11, 2023

@Jkim-Hack Let me know if you think I missed anything

Copy link
Collaborator

@jkim-y jkim-y left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the additions Drew! In the future, if this work ever becomes more popular we can add a little animation on how to run everything, like a tl;dr demo. But this is good for now :).

@@ -1,5 +1,5 @@
# AutoVR
Everything in ts needs to be compiled. index.out.js is the compiled ts code and is the only ts depeendency that run.py needs. To compile, run the compile.sh script in the ts folder to produce the index.out.js file.
Everything in ts needs to be compiled. index.out.js is the compiled ts code and is the only ts dependency that run.py needs. To compile, run the compile.sh script in the ts folder to produce the index.out.js file.


Usage: python3 run.py \<device name\> \<host package\> \<script.json\>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this run.py command entirely just so we don't confuse users. run.py was originally suppose to also include support for running one package at a time. autovr.py now achieves this.


First ensure Frida server is running on the device. More details can be found [here](https://frida.re/docs/android/).

Build the AutoVR codebase. In the `ts/` directory, run:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "Build the AutoVR injected Frida codebase." or something similar.

./compile.sh
```

This should complete building the AutoVR codebase. Next we need to generate the `script.json` file.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "AutoVR injected Frida codebase." or something similar.

apktool d <apk path>.apk
```

We then need to run [Il2CppDumper](https://github.com/Perfare/Il2CppDumper) on the dissassembled apk. This can be done using:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not entirely necessary, but a side not that not all Unity games will be compiled using IL2CPP. Maybe we should add something in the main header saying AutoVR can only run on IL2CPP compiled Unity games.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants