Gittes-archive/AssetRipper_AssetRipper
2
0
Fork 0
mirror of https://github.com/AssetRipper/AssetRipper.git synced 2025-12-11 20:15:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

[skip ci] documentation

Browse Source
This commit is contained in:
Jeremy Pritts 2021-08-24 22:09:07 -04:00
parent 3f9c43c83f
commit b287c77d73
5 changed files with 54 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
AssetRipper.sln
View File

@ -11,7 +11,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
ProjectSection(SolutionItems) = preProject
.editorconfig = .editorconfig
.gitignore = .gitignore
LICENSE = LICENSE
LICENSE.md = LICENSE.md
README.md = README.md
EndProjectSection
EndProject
@ -78,6 +78,7 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{E3A52FDC-1C4D-430F-A1BA-BFC5671181D4}"
ProjectSection(SolutionItems) = preProject
Docs\ExportFeatures.md = Docs\ExportFeatures.md
Docs\RoadMap.md = Docs\RoadMap.md
Docs\Structure.md = Docs\Structure.md
EndProjectSection
EndProject

36
Docs/RoadMap.md Normal file
View File

@ -0,0 +1,36 @@
# Development Roadmap
## 0.1.6.0
* Extend Windows-only features to Mac and Linux
* Shader exporter (done!)
* Texture exporter (partially done)
* Audio exporter (partially done)
* OBJ mesh export
* Better shader implementation (done!)
* Move Third Party Dependencies to Nuget Packages
* Spirv
* Smolv
* Brotli
## 0.2.0.0
* Overhaul struct reading, which would enable:
* universal version support
* support for exporting any unity component
* a cleaner, smaller codebase
* exporting to the original unity version
## Elusive But High Priority
* Predetermined GUID support
## Unscheduled
* Option to reference assemblies instead of scripts
* Full script decompilation
* FBX export
* GUI improvements
* Settings page
* Audio player
* Mesh preview
* List shader properties
* Different background color
* Export Selected object to project
* Export Selected object to file

2
Docs/Structure.md
View File

@ -10,7 +10,7 @@
* [*AssetRipperLibrary*](../AssetRipperLibrary/README.md)
This is an expansion library for AssetRipperCore. It includes some third party dependencies and has some extra converters, so on Windows it additionally exports:
This is an expansion library for AssetRipperCore. It includes some extra exporters:
* AudioClip export
* Texture2D export (with Sprites)
* Shader DirectX blob export

0
LICENSE → LICENSE.md
View File

32
README.md
View File

@ -19,12 +19,12 @@ Thank you for considering to support me. I have normal expenses like food, elect
[Patreon](https://www.patreon.com/ds5678)
## Downloads
## Downloads [![](https://img.shields.io/github/v/release/ds5678/AssetRipper)](https://github.com/ds5678/AssetRipper/releases/latest)
Milestone download links can be found on the [latest release page](https://github.com/ds5678/AssetRipper/releases/latest).
## Alpha Builds
## Alpha Builds [![](https://img.shields.io/github/workflow/status/ds5678/AssetRipper/Publish/master)](https://github.com/ds5678/AssetRipper/actions/workflows/publish.yml)
For advanced users, every commit is automatically built into an alpha build with Github Actions. You can obtain these builds on the [actions page](https://github.com/ds5678/AssetRipper/actions/workflows/publish.yml) if you're logged in with a github account.
@ -47,27 +47,19 @@ If you want to run binary files, you need to install:
* [Unity 2017.3.0f3 or greater](https://unity3d.com/get-unity/download/archive) (NOTE: your editor version must be no less than the game's version)
## To Do
* Predetermined GUID support
* Extend Windows-only features to Mac and Linux
* OBJ mesh export
* GUI settings page
## Other Pages
* [Export Features](Docs/ExportFeatures.md)
* [Development Roadmap](Docs/Roadmap.md)
* [Structure](Docs/Structure.md)
## Goals
* Better shader implementation
* Overhaul struct reading for universal version support
* Option to reference assemblies instead of scripts
## License
## License [![](https://img.shields.io/github/license/ds5678/AssetRipper?color=green)](License.md)
AssetRipper is licensed under the GNU General Public License v3.0
## Copyright Issues
## Legal Issues
Please be aware that distributing the output from this software may be against copyright legislation in your jurisdiction. You are responsible for ensuring that you're not breaking any laws.
Please be aware that using or distributing the output from this software may be against copyright legislation in your jurisdiction. You are responsible for ensuring that you're not breaking any laws.
## Credits
@ -106,3 +98,9 @@ LibOgg and LibVorbis are licensed from [Xiph](https://www.xiph.org/) under the [
## Disclaimer
This software is not sponsored by or affiliated with Unity Technologies or its affiliates. "Unity" is a registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.
## Contact Information
Any **organizations** wishing to contact me may use the email listed on my profile.
Except in rare circumstances, **individuals** must use the appropriate public channels to reach me.