|
1 | 1 | # ProjectCleaner |
2 | | -Unreal engine plugin for managing unused assets and empty folders in project. |
| 2 | +Unreal engine plugin for managing unused assets and empty folders in your project. |
3 | 3 |
|
4 | | -No more Migration and other hacky methods needed. |
| 4 | +No more need for Migration and other hacky methods. |
5 | 5 |
|
6 | 6 | Versions Supported: 4.27+ |
7 | 7 | Platform: Windows and Linux |
8 | 8 |
|
9 | | -<img src="https://user-images.githubusercontent.com/8270558/162420930-760e035b-6e91-43c4-9cd0-0e0beddf8d31.png" /> |
| 9 | +<img src="https://github.com/ashe23/ProjectCleaner/assets/8270558/265ed34e-1b7b-46fb-953c-bc0d37c10fd1" /> |
10 | 10 |
|
11 | 11 | # Installation |
12 | | -Plugin available on marketplace [Marketplace URL](https://www.unrealengine.com/marketplace/en-US/product/4d7f5dc837fc4b009bb91e678adf9fd0) |
| 12 | +The plugin is available on the marketplace [Marketplace URL](https://www.unrealengine.com/marketplace/en-US/product/4d7f5dc837fc4b009bb91e678adf9fd0) |
13 | 13 |
|
14 | 14 | # Installation from github |
15 | 15 | 1) Create 'Plugins' folder in your project root directory |
16 | 16 | 2) Download appropriate version of .zip in releases |
17 | 17 | 3) Extract to Plugins folder |
18 | | -4) Open Project, and thats it! |
| 18 | +4) Open your project, and you're done! |
19 | 19 |
|
20 | 20 | # Installation from source |
21 | 21 | 1) Create 'Plugins' folder in your project root directory |
22 | | -2) Clone repository to 'Plugins' folder (make sure you picked correct branch for your engine version) |
23 | | -3) Build solution and that it! |
| 22 | +2) Clone the repository to the 'Plugins' folder (make sure you pick the correct branch for your engine version). |
| 23 | +3) Build the solution and you're done! |
24 | 24 |
|
25 | 25 | # Features |
26 | | -* Unused assets detection ([Unused assets Docs](https://github.com/ashe23/ProjectCleaner/wiki/Unused-assets)) |
| 26 | +* Detection of unused assets |
| 27 | +* Detection of corrupted assets |
| 28 | +* Detection of indirect assets |
| 29 | +* Detection of external files |
27 | 30 | * Empty folders detection |
28 | | -* Non Engine files detection ([Non Engine Files Docs](https://github.com/ashe23/ProjectCleaner/wiki/Non-Engine-Files)) |
29 | | -* Corrupted assets detection ([Corrupted assets Docs](https://github.com/ashe23/ProjectCleaner/wiki/Corrupted-Assets)) |
30 | | -* Indirectly used assets detection ([Indirectly used assets Docs](https://github.com/ashe23/ProjectCleaner/wiki/Indirectly-used-assets)) |
31 | | -* Configurable options for scanning |
32 | | -* Command line interface ([CLI docs](https://github.com/ashe23/ProjectCleaner/wiki/Command-line-interface)) |
| 31 | +* Subsystem class that exposes most of the plugin functionality, which can be utilized in Blueprints or Python scripts. |
| 32 | +* Command line interface using Commandlets |
| 33 | +* Works fast on Large projects |
| 34 | +* Intiutive and informative user interface |
| 35 | +* Per-folder asset usage information |
| 36 | +* Configurable scanning and exclusion settings |
0 commit comments