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

more documentation changes

Browse Source
This commit is contained in:
Jeremy Pritts 2021-11-15 02:58:09 -05:00
parent e8e1363109
commit fb38a48448
7 changed files with 32 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ You can find a list of "good first issues" [here](https://github.com/ds5678/Asse
## Pull Requests
I welcome contributions to AssetRipper and have accepted many patches, but if you want your code to be included, please familiarise yourself with the following guidelines:
I welcome contributions to AssetRipper and have accepted many patches, but if you want your code to be included, please familiarize yourself with the following guidelines:
* Your submission must be your own work, and able to be released under the GPL license.
* You will need to make sure your code conforms to the layout and naming conventions used elsewhere in AssetRipper.
* Try to write "clean code" - avoid long functions and long classes. Try to add a new feature by creating a new class rather than putting loads of extra code inside an existing one.

3
README.md
View File

@ -20,6 +20,7 @@ Thank you for considering to support me. I have normal expenses like food, elect
[Patreon](https://www.patreon.com/ds5678)
[Paypal](https://paypal.me/ds5678)
# Links
@ -39,6 +40,6 @@ AssetRipper is licensed under the [GNU General Public License v3.0](License.md).
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.
The full list of licensed works can be found on the [Credits](https://ds5678.github.io/AssetRipper/Credits.html) page.
The full list of licensed works can be found on the [Credits](https://ds5678.github.io/AssetRipper/articles/Credits.html) page.
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.

4
docs/api/index.md
View File

@ -1,2 +1,2 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
# API Documentation
This section contains all the generated documentation for the project.

11
docs/articles/Requirements.md
View File

@ -2,14 +2,15 @@
If you want to build a solution, you'll need:
* [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0)
* Compiler with C# 10 syntax support, such as [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/)
> If you have a preview installed of the requested .NET SDK version, you also need to set the option to enable previews in Visual Studio. Go to Tools > Options > Environment > Preview Features, and make sure that Use previews of the .NET Core SDK is checked.
* [.NET 6](https://dotnet.microsoft.com/download/dotnet/6.0)
* Compiler with C# 10 syntax support, such as:
* [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
* [Visual Studio Code](https://code.visualstudio.com/Download)
* [JetBrains Rider](https://www.jetbrains.com/rider/) (proprietary)
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)
* [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)
## Linux Dependencies

5
docs/articles/RoadMap.md
View File

@ -20,7 +20,9 @@
* Move ProjectExporter and ProjectExporterBase
* Move GameStructure
* Struct Reading Overhaul
* Yaml method generation in the AssemblyDumper project
* Yaml method generation
* ~~Type Tree method generation~~
* Fetch Dependency method generation
* Apply interfaces in the generated assemblies
* Implement generation of version specific Asset Factories
* Implement a system for loading the assemblies on demand
@ -28,6 +30,7 @@
* Remove the `Classes` and `Converters` namespaces
* Remove any additional legacy code
* Merge the common project back into the core project
* Add newer Unity versions to the TypeTreeDumps repository
## 0.2.1.0
This release will be primarily focused on cleaning up and refactoring the project. Such cleanup may include:

25
docs/articles/Structure.md
View File

@ -1,28 +1,33 @@
## Structure
* [*AssetAnalyzer*](../AssetAnalyzer/README.md)
* [*AssetAnalyzer*](https://github.com/ds5678/AssetRipper/blob/master/AssetAnalyzer/README.md)
Simple program to investigate file header information.
* [*AssetRipperCore*](../AssetRipperCore/README.md)
* [*AssetRipperCore*](https://github.com/ds5678/AssetRipper/blob/master/AssetRipperCore/README.md)
Core library. It's designed as an single module without any third party dependencies.
Core library. It's designed as an single module without any native dependencies.
* [*AssetRipperLibrary*](../AssetRipperLibrary/README.md)
* [*AssetRipperLibrary*](https://github.com/ds5678/AssetRipper/blob/master/AssetRipperLibrary/README.md)
This is an expansion library for AssetRipperCore. It includes some extra exporters:
* AudioClip export
* Texture2D export (with Sprites)
* Shader DirectX blob export
* Dummy Shader Export
* Text Asset Export
* Font Export
* Movie Texture Export
* Mesh Export
* Script Export (Mono and IL2Cpp)
* [*AssetRipperGUI*](../AssetRipperGUI/README.md)
* [*AssetRipperGUI*](https://github.com/ds5678/AssetRipper/blob/master/AssetRipperGUI/README.md)
Basic graphic interface application utilizing the AssetRipperLibrary.
Basic cross-platform graphical interface application utilizing the AssetRipperLibrary.
* [*AssetRipperConsole*](../AssetRipperConsole/README.md)
* [*AssetRipperConsole*](https://github.com/ds5678/AssetRipper/blob/master/AssetRipperConsole/README.md)
Command line equivalent of AssetRipperGUI. Since it has no GUI, it can be cross-platform compatible.
Command line equivalent of AssetRipperGUI.
* [*UnitTester*](../UnitTester/README.md)
* [*UnitTester*](https://github.com/ds5678/AssetRipper/blob/master/UnitTester/README.md)
Automated tester to verify project integrity while making changes.

5
docs/index.md
View File

@ -13,14 +13,13 @@ AssetRipper is a tool for extracting assets from serialized files (*CAB-*\*, *\*
Current supported versions: `3.4.0` to `2021.1.x`
[Site Navigation](SiteMap.md)
# Donations
Thank you for considering to support me. I have normal expenses like food, electric, internet, and rent. Your donations help to ensure that I can continue to afford developing this project. Anyone with a positive lifetime contribution is entitled to the Donator role on the [Discord server](https://discord.gg/XqXa53W2Yh).
[Patreon](https://www.patreon.com/ds5678)
[Paypal](https://paypal.me/ds5678)
# Discord [![](https://img.shields.io/discord/867514400701153281?color=blue&label=AssetRipper)](https://discord.gg/XqXa53W2Yh)
@ -33,6 +32,6 @@ AssetRipper is licensed under the [GNU General Public License v3.0](https://gith
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.
The full list of licensed works can be found on the [Credits](Credits.md) page.
The full list of licensed works can be found on the [Credits](articles/Credits.md) page.
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.