Skip to content

Commit e53345b

Browse files
docs: improve README
1 parent 7fd6eb3 commit e53345b

File tree

3 files changed

+132
-14
lines changed

3 files changed

+132
-14
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# unity-scene-repacker
22

3+
![demo asciicast](./docs/demo-cast.svg)
4+
35
When modding a unity game, you often want to `Instantiate` objects from a scene that isn't loaded.
46
One solution for this is to load all the scenes you're interested in at startup, copy the gameobjects somewhere and unload the scene.
57
This works, but is slow and memory intensive.
@@ -9,26 +11,26 @@ This project lets you read scenes from the distributed game, take only what you
911
## Installation
1012

1113
```sh
12-
# compile from source
13-
cargo install --git https://github.com/jakobhellermann/unity-scene-repacker --branch rewrite
14+
uv tool install unity-scene-repacker # if you have uv installed
15+
cargo install --git https://github.com/jakobhellermann/unity-scene-repacker # to compile from source
1416
```
1517

1618
## Usage
1719

18-
```json
20+
```jsonc
1921
objects.json
2022
{
21-
"A6_S3_Tutorial_And_SecretBoss_Remake": [
22-
"A6_S3/Room/Prefab/Enemy/StealthGameMonster_RunningHog (3)",
23-
"A6_S3/Room/Prefab/Enemy_2/\u5f29\u83c1\u82f1"
24-
],
25-
"A0_S7_CaveReturned": [
26-
"A0_S7/Room/StealthGameMonster_TutorialDummyNonAttack"
27-
],
28-
"AG_SG1": [
29-
"AG_SG1/Room/Shield Crawler Spawner \u4e1f\u91d1\u96fb\u87f2"
30-
],
31-
...
23+
"Fungus1_12": [
24+
"simple_grass",
25+
"green_grass_2",
26+
"green_grass_3",
27+
"green_grass_1 (1)"
28+
],
29+
"White_Palace_01": [
30+
"WhiteBench",
31+
"White_ Spikes"
32+
],
33+
...
3234
}
3335
```
3436

docs/demo-cast.svg

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)