Skip to content

Commit 73bee1c

Browse files
author
András Kurai
committed
Add getting started, start customization
1 parent 2ffeeb7 commit 73bee1c

File tree

5 files changed

+38
-3
lines changed

5 files changed

+38
-3
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Customization
2+
3+
After pressing the `Generate Resource Paths` button, or visiting the `ResourceGenerator` page in the Project Settings an asset will be generated in the Assets folder, which will contain settings for the code generation.
4+
5+
## Built-in settings
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Getting Started
2+
3+
The Unity Resource Generator is a Unity Editor tool which can generate a helper class which will create a helper class that contains paths to loadable Unity resources. Additionally it will also generate helper methods to load scenes.
4+
5+
The generation of the class is customizable by default and the library also lets developers create custom code to run during generation.
6+
7+
## Installation
8+
9+
Use [OpenUPM](https://openupm.com/) to install the package.
10+
11+
```
12+
openupm add com.autsoft.unityresourcegenerator
13+
```
14+
15+
## Running the tool
16+
17+
The tool will create new button in the Editor at `Tools / Generate Resource Paths`
18+
19+
![Generate Button](~/images/intro/GenerateButton.png)
20+
21+
If your click the button the helper class will be generated in the root of the `Assets` folder

Documentation/articles/intro.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

Documentation/articles/toc.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
1-
- name: Introduction
2-
href: intro.md
1+
- name: Getting Started
2+
href: GettingStarted.md
3+
- name: Customization
4+
href: Customization.md

Documentation/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,11 @@ namespace Sample
5252
}
5353
}
5454
```
55+
56+
## Installation
57+
58+
Use [OpenUPM](https://openupm.com/) to install the package.
59+
60+
```
61+
openupm add com.autsoft.unityresourcegenerator
62+
```

0 commit comments

Comments
 (0)