mirror of
https://github.com/AssetRipper/AssetRipper.git
synced 2025-12-11 20:15:29 +01:00
Improved design of
- Credits.md - Downloads.md - index.md - Requirements.md - RoadMap.md - RunningOnMac.md
This commit is contained in:
TridleWork
Jeremy Pritts
parent
5db69b8536
commit
93feea590d
@ -2,48 +2,40 @@
|
||||
|
||||
## Licensed Works
|
||||
|
||||
[AsmResolver](https://github.com/Washi1337/AsmResolver) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/AsmResolver.md).
|
||||
| Project | License |
|
||||
|---------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------|
|
||||
| [AsmResolver](https://github.com/Washi1337/AsmResolver) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/AsmResolver.md) |
|
||||
| [Avalonia](https://github.com/AvaloniaUI/Avalonia) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Avalonia.md) |
|
||||
| [Cpp2IL](https://github.com/SamboyCoding/Cpp2IL) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Cpp2IL.md) |
|
||||
| Crunch | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Crunch.md) |
|
||||
| [darkfx](https://github.com/steffen-wilke/darkfx) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/darkfx.md) |
|
||||
| [Fmod5Sharp](https://github.com/SamboyCoding/Fmod5Sharp) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Fmod5Sharp.md) |
|
||||
| [ICSharpCode.Decompiler](https://github.com/icsharpcode/ILSpy) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/ILSpy.md) |
|
||||
| [K4os.Compression.LZ4](https://github.com/MiloszKrajewski/K4os.Compression.LZ4) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Lz4.md) |
|
||||
| [LibVLCSharp](https://github.com/videolan/libvlcsharp) | [LGPL-2.1](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/LibVLCSharp.md) |
|
||||
| [MessageBox.Avalonia](https://github.com/AvaloniaCommunity/MessageBox.Avalonia) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/MessageBoxAvalonia.md) |
|
||||
| [NAudio](https://github.com/naudio/NAudio) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/NAudio.md) |
|
||||
| [NAudio.Vorbis](https://github.com/naudio/Vorbis) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/NAudioVorbis.md) |
|
||||
| [NVorbis](https://github.com/NVorbis/NVorbis) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/NVorbis.md) |
|
||||
| [SharpCompress](https://github.com/adamhathcock/sharpcompress) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SharpCompress.md) |
|
||||
| [SharpGLTF](https://github.com/vpenades/SharpGLTF) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SharpGLTF.md) |
|
||||
| [SharpZipLib](https://github.com/icsharpcode/SharpZipLib) | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SharpZipLib.md) |
|
||||
| Smolv | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Smolv.md) |
|
||||
| SpirV | [MIT](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SpirV.md) |
|
||||
| [StbImageWriteSharp](https://github.com/StbSharp/StbImageWriteSharp) | Public Domain |
|
||||
|
||||
[Avalonia](https://github.com/AvaloniaUI/Avalonia) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Avalonia.md).
|
||||
## Project Heritage
|
||||
|
||||
[Cpp2IL](https://github.com/SamboyCoding/Cpp2IL) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Cpp2IL.md).
|
||||
AssetRipper builds upon the work of several open-source projects:
|
||||
|
||||
Crunch is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Crunch.md).
|
||||
1. **[uTinyRipper](https://github.com/mafaca/UtinyRipper)** by [mafaca](https://github.com/mafaca)
|
||||
- AssetRipper began as a fork of this project
|
||||
- Licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/uTinyRipper.md)
|
||||
|
||||
[darkfx](https://github.com/steffen-wilke/darkfx) is licensed under the [MIT License](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/darkfx.md).
|
||||
2. **[AssetStudio](https://github.com/Perfare/AssetStudio)** by [Perfare](https://github.com/Perfare)
|
||||
- Contributed code to AssetRipper
|
||||
- Licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/AssetStudio.md)
|
||||
|
||||
[Fmod5Sharp](https://github.com/SamboyCoding/Fmod5Sharp) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Fmod5Sharp.md).
|
||||
|
||||
[ICSharpCode.Decompiler](https://github.com/icsharpcode/ILSpy) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/ILSpy.md).
|
||||
|
||||
[K4os.Compression.LZ4](https://github.com/MiloszKrajewski/K4os.Compression.LZ4) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Lz4.md).
|
||||
|
||||
[LibVLCSharp](https://github.com/videolan/libvlcsharp) is licensed under the [LGPL-2.1 License](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/LibVLCSharp.md)
|
||||
|
||||
[MessageBox.Avalonia](https://github.com/AvaloniaCommunity/MessageBox.Avalonia) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/MessageBoxAvalonia.md).
|
||||
|
||||
[NAudio](https://github.com/naudio/NAudio) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/NAudio.md).
|
||||
|
||||
[NAudio.Vorbis](https://github.com/naudio/Vorbis) is licensed under the [MIT License](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/NAudioVorbis.md).
|
||||
|
||||
[NVorbis](https://github.com/NVorbis/NVorbis) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/NVorbis.md).
|
||||
|
||||
[SharpCompress](https://github.com/adamhathcock/sharpcompress) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SharpCompress.md).
|
||||
|
||||
[SharpGLTF](https://github.com/vpenades/SharpGLTF) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SharpGLTF.md).
|
||||
|
||||
[SharpZipLib](https://github.com/icsharpcode/SharpZipLib) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SharpZipLib.md).
|
||||
|
||||
Smolv is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/Smolv.md).
|
||||
|
||||
SpirV is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/SpirV.md).
|
||||
|
||||
[StbImageWriteSharp](https://github.com/StbSharp/StbImageWriteSharp) is in the public domain.
|
||||
|
||||
## Other
|
||||
|
||||
This began as a fork of [mafaca](https://github.com/mafaca)'s [uTinyRipper](https://github.com/mafaca/UtinyRipper) project licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/uTinyRipper.md).
|
||||
|
||||
It has borrowed code from [Perfare](https://github.com/Perfare)'s [AssetStudio](https://github.com/Perfare/AssetStudio) project licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/AssetStudio.md).
|
||||
|
||||
It has borrowed code from [spacehamster](https://github.com/spacehamster)'s [uTinyRipperExporter](https://github.com/spacehamster/UtinyRipperExporter) project licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/uTinyRipperExporter.md).
|
||||
3. **[uTinyRipperExporter](https://github.com/spacehamster/UtinyRipperExporter)** by [spacehamster](https://github.com/spacehamster)
|
||||
- Contributed code to AssetRipper
|
||||
- Licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Source/Licenses/uTinyRipperExporter.md)
|
||||
@ -1,27 +1,39 @@
|
||||
# Downloads
|
||||
# Downloads
|
||||
|
||||
## Releases [](https://github.com/AssetRipper/AssetRipper/releases/latest)
|
||||
## Stable Releases [](https://github.com/AssetRipper/AssetRipper/releases/latest)
|
||||
|
||||
Release notes can be found on the [latest release page](https://github.com/AssetRipper/AssetRipper/releases/latest).
|
||||
Get the latest stable version of AssetRipper for your platform:
|
||||
|
||||
* [Windows x64](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_win_x64.zip)
|
||||
* [Windows Arm64](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_win_arm64.zip)
|
||||
* [Mac x64](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_mac_x64.zip)
|
||||
* [Mac Arm64](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_mac_arm64.zip)
|
||||
* [Linux x64](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_linux_x64.zip)
|
||||
| Platform | Download Link |
|
||||
|---------------|-----------------------------------------------------------------------------------------------------------|
|
||||
| Windows x64 | [Download](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_win_x64.zip) |
|
||||
| Windows Arm64 | [Download](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_win_arm64.zip) |
|
||||
| Mac x64 | [Download](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_mac_x64.zip) |
|
||||
| Mac Arm64 | [Download](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_mac_arm64.zip) |
|
||||
| Linux x64 | [Download](https://github.com/AssetRipper/AssetRipper/releases/latest/download/AssetRipper_linux_x64.zip) |
|
||||
|
||||
## Pre-Releases [](https://github.com/AssetRipper/AssetRipper/releases)
|
||||
📝 [Release Notes](https://github.com/AssetRipper/AssetRipper/releases/latest)
|
||||
|
||||
Occasionally, I'll do a pre-release when I want to showcase an experimental feature.
|
||||
## Pre-Releases [](https://github.com/AssetRipper/AssetRipper/releases)
|
||||
|
||||
These pre-releases can be found in the list of [releases](https://github.com/AssetRipper/AssetRipper/releases).
|
||||
Pre-releases showcase experimental features and are available in the [releases section](https://github.com/AssetRipper/AssetRipper/releases).
|
||||
|
||||
## Alpha Builds [](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master)
|
||||
⚠️ These versions may be unstable and are recommended for testing purposes only.
|
||||
|
||||
For advanced users, every commit is automatically built into an alpha build with Github Actions.
|
||||
## Alpha Builds [](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master)
|
||||
|
||||
* [Windows x64](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_win_x64.zip)
|
||||
* [Windows Arm64](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_win_arm64.zip)
|
||||
* [Mac x64](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_mac_x64.zip)
|
||||
* [Mac Arm64](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_mac_arm64.zip)
|
||||
* [Linux x64](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_linux_x64.zip)
|
||||
For advanced users, every commit triggers an automatic alpha build via Github Actions:
|
||||
|
||||
| Platform | Download Link |
|
||||
|---------------|-------------------------------------------------------------------------------------------------------------|
|
||||
| Windows x64 | [Download](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_win_x64.zip) |
|
||||
| Windows Arm64 | [Download](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_win_arm64.zip) |
|
||||
| Mac x64 | [Download](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_mac_x64.zip) |
|
||||
| Mac Arm64 | [Download](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_mac_arm64.zip) |
|
||||
| Linux x64 | [Download](https://nightly.link/AssetRipper/AssetRipper/workflows/publish/master/AssetRipper_linux_x64.zip) |
|
||||
|
||||
⚠️ Alpha builds are highly experimental and may contain bugs or unfinished features.
|
||||
|
||||
---
|
||||
|
||||
If you encounter any issues, please report them on our [Issue Tracker](https://github.com/AssetRipper/AssetRipper/issues).
|
||||
@ -1,13 +1,24 @@
|
||||
# Requirements:
|
||||
# Development and Usage Requirements
|
||||
|
||||
If you want to build a solution, you'll need:
|
||||
## Building the Solution
|
||||
|
||||
* [.NET 8](https://dotnet.microsoft.com/download/dotnet/7.0)
|
||||
* Compiler with C# 12 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)
|
||||
To build AssetRipper from source, you'll need:
|
||||
|
||||
If you want to run binary files, you need to install:
|
||||
### Essential Software
|
||||
- [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
|
||||
|
||||
* [Unity](https://unity.com/releases/editor/archive) (NOTE: your editor version must be no less than the game's version and ideally should be the exact same.)
|
||||
### Compatible IDEs/Editors (with C# 12 support)
|
||||
Choose one of the following:
|
||||
- [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (Community edition is free for open-source development)
|
||||
- [Visual Studio Code](https://code.visualstudio.com/Download) with C# extension
|
||||
- [JetBrains Rider](https://www.jetbrains.com/rider/) (commercial software, free for students and open-source developers)
|
||||
|
||||
## Running AssetRipper
|
||||
|
||||
if you want to run binary files, you need to install:
|
||||
|
||||
### Unity Editor
|
||||
- [Download Unity](https://unity.com/releases/editor/archive)
|
||||
- ⚠️ Important: Your Unity editor version should be:
|
||||
- At least as recent as the game version you're working with
|
||||
- Ideally, use the exact same version as the target game for best compatibility
|
||||
|
||||
@ -1,113 +1,99 @@
|
||||
# Development Roadmap
|
||||
|
||||
## 1.0.16
|
||||
This release will focus on fixing bugs and improving the user experience in the GUI.
|
||||
## 1. Planned But Unscheduled
|
||||
|
||||
## 1.0.X
|
||||
These releases will likely focus on cleaning up the project and preparing to release more premium features.
|
||||
### 1.1 Import
|
||||
- **Script Import**
|
||||
- Use type trees for assembly reconstruction
|
||||
|
||||
## Planned But Unscheduled
|
||||
* Import
|
||||
* Script Import
|
||||
* Use type trees for assembly reconstruction
|
||||
* Export
|
||||
* Script Export
|
||||
* Assembly renaming
|
||||
* Miscellaneous Export
|
||||
* Copy plugins folder into output
|
||||
* Primary Content Extraction
|
||||
* Binary Export
|
||||
* SerializeFile writing as an alternative to yaml export.
|
||||
* UI
|
||||
* Improved Asset previews
|
||||
* Add a Mesh preview
|
||||
* Scene preview
|
||||
* Add a Material preview
|
||||
* Remove native dependencies
|
||||
* Replace crunch with managed code
|
||||
* Implement support for decoding Bc textures with managed code for non-multiples of 4
|
||||
### 1.2 Export
|
||||
- **Script Export**
|
||||
- Assembly renaming
|
||||
- **Miscellaneous Export**
|
||||
- Copy plugins folder into output
|
||||
- **Binary Export**
|
||||
- SerializeFile writing as an alternative to yaml export
|
||||
|
||||
## Concept Ideas
|
||||
> Note: This is just a collection of ideas. These might not be desirable or feasible, so many of them might never be implemented. Do not interpret their inclusion here as any form of commitment.
|
||||
### 1.3 UI
|
||||
- **Improved Asset Previews**
|
||||
- Add a Mesh preview
|
||||
- Scene preview
|
||||
- Add a Material preview
|
||||
|
||||
* Import
|
||||
* Asset Loading
|
||||
* Extract assets and save to disk for lower ram usage
|
||||
* Export
|
||||
* Audio Export
|
||||
* WWise audio extraction
|
||||
* Shader Export
|
||||
* Replace all shaders on materials with a built-in shader (for example, the Standard shader)
|
||||
* Selective Export
|
||||
* Export Selected object to folder
|
||||
* Export Selected object to compressed zip file
|
||||
* Asset editing
|
||||
* GUI quality of life features
|
||||
* Preferences Window
|
||||
* Font setting
|
||||
* Configurable keybindings?
|
||||
* Console
|
||||
* Enterable commands
|
||||
* Find all references
|
||||
* Search Window
|
||||
* Dedicated window
|
||||
* Filters for various asset types
|
||||
* Filters for files
|
||||
* Might be redundant due to tree view search
|
||||
* Tree View Search
|
||||
* Filters for various asset types
|
||||
* Name filter
|
||||
* Rows limit
|
||||
* Result count
|
||||
* Option to group resources
|
||||
* Tabs
|
||||
* Inspector Tab
|
||||
* Tag
|
||||
* Layer
|
||||
* ID
|
||||
* File name
|
||||
* Asset Specific Properties
|
||||
* Sortable
|
||||
* Selectable with indepth description below
|
||||
* Moveable Tabs
|
||||
* Error Tab
|
||||
* Import Settings
|
||||
* Ignore scenes option
|
||||
* Import bundle as level
|
||||
* Assembly de-obfuscation
|
||||
* Performance Improvements
|
||||
* Asynchronous import/export
|
||||
* Filtered Export
|
||||
* Resources (png, wav, avi, obj, ...)
|
||||
* Prefabs
|
||||
* Scripts
|
||||
* Asset Bundle Construction
|
||||
* Editing and Repacking of games and asset bundles
|
||||
* Asset Header Editor
|
||||
* Asset Duplication and Creation
|
||||
* Asset Editing and Replacement
|
||||
* Copy and paste assets
|
||||
* Prefab Creation
|
||||
* Asset Exporting
|
||||
* Export as Prefab
|
||||
* Export as Unitypackage
|
||||
* Node Dump
|
||||
* Asset Previews
|
||||
* Meshes
|
||||
* Colored semi-transparency
|
||||
* Triangle count
|
||||
* FPS meter
|
||||
* Corner cube for orientation
|
||||
* XYZ axis for orientation
|
||||
* Toggle face cull
|
||||
* Wireframe option
|
||||
* Textures
|
||||
* Background options (for example: checkers, white, black, default)
|
||||
* Select the color channels to display
|
||||
* For example, disable the alpha channel
|
||||
* Or show only the blue channel
|
||||
* Video Display
|
||||
* Animations
|
||||
* Scripts
|
||||
* view as text
|
||||
* notify if script missing
|
||||
### 1.4 Remove Native Dependencies
|
||||
- Replace crunch with managed code
|
||||
- Implement support for decoding Bc textures with managed code for non-multiples of 4
|
||||
|
||||
---
|
||||
|
||||
## 2. Concept Ideas
|
||||
|
||||
> **Note:** This is a collection of ideas that might not be desirable or feasible. Many of them may never be implemented. Do not interpret their inclusion as any form of commitment.
|
||||
|
||||
### 2.1 Import/Export Enhancements
|
||||
- **Asset Loading**
|
||||
- Extract assets and save to disk for lower RAM usage
|
||||
- **Audio Export**
|
||||
- WWise audio extraction
|
||||
- **Shader Export**
|
||||
- Replace all shaders on materials with a built-in shader (e.g., Standard shader)
|
||||
- **Selective Export**
|
||||
- Export selected object to folder or compressed zip file
|
||||
- **Filtered Export**
|
||||
- Resources (png, wav, avi, obj, ...)
|
||||
- Prefabs
|
||||
- Scripts
|
||||
|
||||
### 2.2 UI and User Experience
|
||||
- **GUI Quality of Life Features**
|
||||
- Preferences Window (Font setting, Configurable keybindings)
|
||||
- **Console**
|
||||
- Enterable commands
|
||||
- **Search Functionality**
|
||||
- Dedicated search window
|
||||
- Tree View Search (Filters, Name filter, Rows limit, Result count, Group resources option)
|
||||
- **Tabs**
|
||||
- Inspector Tab (Tag, Layer, ID, File name, Asset Specific Properties)
|
||||
- Moveable Tabs
|
||||
- Error Tab
|
||||
|
||||
### 2.3 Asset Management
|
||||
- **Asset Editing**
|
||||
- **Asset Bundle Construction**
|
||||
- Editing and Repacking of games and asset bundles
|
||||
- Asset Header Editor
|
||||
- Asset Duplication and Creation
|
||||
- Asset Editing and Replacement
|
||||
- Copy and paste assets
|
||||
- Prefab Creation
|
||||
- **Asset Exporting**
|
||||
- Export as Prefab
|
||||
- Export as Unitypackage
|
||||
- Node Dump
|
||||
|
||||
### 2.4 Asset Previews
|
||||
- **Meshes**
|
||||
- Colored semi-transparency
|
||||
- Triangle count
|
||||
- FPS meter
|
||||
- Orientation aids (Corner cube, XYZ axis)
|
||||
- Toggle face cull
|
||||
- Wireframe option
|
||||
- **Textures**
|
||||
- Background options (e.g., checkers, white, black, default)
|
||||
- Color channel display options
|
||||
- **Other Asset Types**
|
||||
- Video Display
|
||||
- Animations
|
||||
- Scripts (view as text, notify if script missing)
|
||||
|
||||
### 2.5 Performance and Settings
|
||||
- **Import Settings**
|
||||
- Ignore scenes option
|
||||
- Import bundle as level
|
||||
- Assembly de-obfuscation
|
||||
- **Performance Improvements**
|
||||
- Asynchronous import/export
|
||||
|
||||
### 2.6 Miscellaneous
|
||||
- Find all references
|
||||
@ -1,111 +1,96 @@
|
||||
# Running on Mac
|
||||
# Running AssetRipper on macOS
|
||||
|
||||
> Disclaimer: The project developer does not have access to a Mac. This guide is community contributed.
|
||||
> ⚠️ Disclaimer: The project developer does not have access to a Mac. This guide is community-contributed.
|
||||
|
||||
In order to run AssetRipper on mac, you'll first need to have everything listed in the [requirements](https://assetripper.github.io/AssetRipper/articles/Requirements.html) tab.
|
||||
This guide will help you run AssetRipper on macOS. Before proceeding, ensure you have all the necessary [requirements](https://assetripper.github.io/AssetRipper/articles/Requirements.html).
|
||||
|
||||
## Running the GUI version
|
||||
If you're done with the requirements, lets see how to run the GUI version.
|
||||
## Running the GUI Version
|
||||
|
||||
First, you'll need to download the GUI release from [here](https://github.com/AssetRipper/AssetRipper/releases).
|
||||
### Step 1: Download AssetRipper
|
||||
|
||||
Make sure you download the `AssetRipperGUI_mac64.zip` file as shown below.
|
||||
1. Download the GUI release from the [AssetRipper releases page](https://github.com/AssetRipper/AssetRipper/releases).
|
||||
2. Choose the `AssetRipperGUI_mac64.zip` file.
|
||||
|
||||
|
||||
|
||||
|
||||
After downloading, right click and open the file to extract as shown below.
|
||||
### Step 2: Extract the Archive
|
||||
|
||||
|
||||
1. Right-click the downloaded file and select "Open" to extract its contents.
|
||||
|
||||
After extracting, you should see this folder named `AssetRipperGUI_mac64`.
|
||||
|
||||
|
||||
|
||||
2. You should now see a folder named `AssetRipperGUI_mac64`.
|
||||
|
||||
And inside that folder, there should be many other files:
|
||||
|
||||
|
||||
|
||||
3. Inside this folder, you'll find various files, including the `AssetRipper` executable.
|
||||
|
||||
You should also see this file called `AssetRipper`.
|
||||
|
||||
|
||||
|
||||
|
||||
### Step 3: Open Terminal in the AssetRipper Folder
|
||||
|
||||
Now go back to the `AssetRipperGUI_mac64` folder and select it. Then go to `Finder`, `Services`, `New Terminal at Folder` as shown.
|
||||
1. Select the `AssetRipperGUI_mac64` folder.
|
||||
2. Go to `Finder` > `Services` > `New Terminal at Folder`.
|
||||
|
||||
|
||||
|
||||
|
||||
Now you should see the terminal open:
|
||||
|
||||
|
||||
|
||||
Now you'll need to type in the following command and press `enter`:
|
||||
### Step 4: Run AssetRipper
|
||||
|
||||
1. In the Terminal, enter the following command:
|
||||
```
|
||||
./AssetRipper
|
||||
```
|
||||
2. You may encounter a "Permission denied" error.
|
||||
|
||||
Then you should see an error saying `-bash: ./AssetRipper: Permission denied`.
|
||||
|
||||
|
||||
|
||||
To fix that, you'll need to type in this command:
|
||||
|
||||
|
||||
3. To fix this, enter the following command:
|
||||
```
|
||||
chmod +x AssetRipper
|
||||
```
|
||||
After entering that, you should see an empty line
|
||||
|
||||
|
||||
|
||||
Now again try the following command and it should work.
|
||||
|
||||
4. Now, try running AssetRipper again:
|
||||
```
|
||||
./AssetRipper
|
||||
```
|
||||
|
||||
Now something like this should pop up:
|
||||
### Step 5: Handle Security Prompts
|
||||
|
||||
|
||||
1. You may see a security prompt. Click "Cancel" for now.
|
||||
|
||||
Click cancel. To verify that, you'll need to open system preferences using `⌘ + space` and search for `System preferences` and press `enter`. Then inside, find for `Security & Privacy` as shown below:
|
||||
|
||||
|
||||
|
||||
2. Open System Preferences (⌘ + Space, search for "System Preferences").
|
||||
3. Go to "Security & Privacy" > "General" tab.
|
||||
4. At the bottom, click "Allow Anyway" for AssetRipper.
|
||||
|
||||
Now go to the `General` tab:
|
||||
|
||||
|
||||
|
||||
5. Run the `./AssetRipper` command again in Terminal.
|
||||
6. Click "Open" when prompted.
|
||||
|
||||
And at the bottom, something like this should popup. Click Allow Anyway:
|
||||
|
||||
|
||||
|
||||
7. You may see additional security prompts. Click "OK" and allow them as needed.
|
||||
|
||||
Now again try this command:
|
||||
|
||||
|
||||
|
||||
```
|
||||
./AssetRipper
|
||||
```
|
||||
### Step 6: AssetRipper GUI
|
||||
|
||||
Then it will show something like this, click Open:
|
||||
After completing these steps, the AssetRipper GUI should open:
|
||||
|
||||
|
||||
|
||||
|
||||
Then things like this will popup, click OK and do the same steps shown above to open them:
|
||||
## Reopening AssetRipper
|
||||
|
||||
|
||||
Once you've gone through the initial setup, you can easily reopen AssetRipper:
|
||||
|
||||
|
||||
1. Navigate to the `AssetRipperGUI_mac64` folder.
|
||||
2. Double-click the `AssetRipper` file to launch the application.
|
||||
|
||||
Like that you should see multiple popups, click OK and allow them.
|
||||
|
||||
|
||||
After a while, you should see Asset Ripper GUI open:
|
||||
Congratulations! You've successfully set up and run AssetRipper on macOS.
|
||||
|
||||
|
||||
|
||||
Now lets say you got it opened, but you closed it and want to open it again. But luckily, you won't need to follow all the steps above to open again!
|
||||
|
||||
Just go to the `AssetRipperGUI_mac64` folder and double click this file and it should open again!
|
||||
|
||||
|
||||
|
||||
And there you have it :)
|
||||
|
||||
|
||||
|
||||
@ -1,39 +1,66 @@
|
||||
# AssetRipper
|
||||
<h1 align="center">AssetRipper</h1>
|
||||
|
||||
[](https://github.com/AssetRipper/AssetRipper/raw/master/Media/Images/2D_Logo/AssetRipperLogoBackground.png)
|
||||
<p align="center">
|
||||
<img src="https://github.com/AssetRipper/AssetRipper/raw/master/Media/Images/2D_Logo/AssetRipperLogoBackground.png" alt="AssetRipper Logo" width="50%">
|
||||
</p>
|
||||
|
||||
[](https://github.com/AssetRipper/AssetRipper/releases)
|
||||
[](https://github.com/AssetRipper/AssetRipper/releases/latest)
|
||||
[](https://github.com/AssetRipper/AssetRipper/releases/latest)
|
||||
[](http://weblate.samboy.dev/engage/assetripper/)
|
||||
<p align="center">
|
||||
<a href="https://github.com/AssetRipper/AssetRipper/releases"><img src="https://img.shields.io/github/downloads/AssetRipper/AssetRipper/total.svg?label=Downloads&logo=github" alt="Total Downloads"></a>
|
||||
<a href="https://github.com/AssetRipper/AssetRipper/releases/latest"><img src="https://img.shields.io/github/v/release/AssetRipper/AssetRipper?label=Release&logo=github" alt="Latest Release"></a>
|
||||
<a href="https://github.com/AssetRipper/AssetRipper/blob/master/LICENSE.md"><img src="https://img.shields.io/github/license/AssetRipper/AssetRipper?label=License&logo=gnu" alt="License"></a>
|
||||
<a href="https://discord.gg/XqXa53W2Yh"><img src="https://img.shields.io/discord/867514400701153281?label=Discord&logo=discord&color=5865F2" alt="Discord"></a>
|
||||
</p>
|
||||
|
||||
AssetRipper is a tool for extracting assets from serialized files (*CAB-*\*, *\*.assets*, *\*.sharedAssets*, etc.) and assets bundles (*\*.unity3d*, *\*.bundle*, etc.) and converting them into the native Unity engine format.
|
||||
<p align="center">
|
||||
<a href="#Features">Features</a> •
|
||||
<a href="#getting-started">Getting Started</a> •
|
||||
<a href="#supported-unity-versions">Supported Versions</a> •
|
||||
<a href="#contributing">Contributing</a> •
|
||||
<a href="#Donations">Donations</a>
|
||||
</p>
|
||||
|
||||
AssetRipper is a powerful tool for extracting and converting Unity engine assets. It can process:
|
||||
- Serialized files (`*CAB-*`, `*.assets`, `*.sharedAssets`, etc.)
|
||||
- Asset bundles (`*.unity3d`, `*.bundle`, etc.)
|
||||
|
||||
The extracted assets are converted into the native Unity engine format for easy use.
|
||||
|
||||
# Getting Started
|
||||
|
||||
1. Download the latest release from the [Releases page](https://github.com/AssetRipper/AssetRipper/releases/latest)
|
||||
2. Extract the downloaded archive
|
||||
3. Run AssetRipper executable
|
||||
4. Open your Unity game folder or asset files
|
||||
5. Wait for the extraction and conversion process to complete
|
||||
6. Access your extracted assets in the output folder
|
||||
|
||||
# Supported Unity Versions
|
||||
|
||||
AssetRipper supports Unity versions from `3.5.0` to `6000.0.X`. However, support quality may vary for different Unity versions.
|
||||
|
||||
# Contributing
|
||||
|
||||
We welcome contributions from the community! Whether it's bug reports, feature requests, or code contributions, please feel free to get involved.
|
||||
|
||||
<a href="https://github.com/AssetRipper/AssetRipper/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=AssetRipper/AssetRipper"/>
|
||||
</a>
|
||||
|
||||
# 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).
|
||||
Your support helps maintain and improve AssetRipper. If you find this tool useful, please consider donating:
|
||||
|
||||
[GitHub Sponsors](https://github.com/sponsors/ds5678)
|
||||
|
||||
[Patreon](https://www.patreon.com/ds5678)
|
||||
|
||||
[Paypal](https://paypal.me/ds5678)
|
||||
|
||||
# Supported Versions
|
||||
|
||||
Unity `3.5.0` to `6000.0.X`
|
||||
|
||||
# Discord [](https://discord.gg/XqXa53W2Yh)
|
||||
|
||||
The development of this project has a dedicated [Discord server](https://discord.gg/XqXa53W2Yh). Feel free to come say hi. This is also an alternative location for people to post issues.
|
||||
- [GitHub Sponsors](https://github.com/sponsors/ds5678)
|
||||
- [Patreon](https://www.patreon.com/ds5678)
|
||||
- [PayPal](https://paypal.me/ds5678)
|
||||
|
||||
Donors receive a special role on our [Discord server](https://discord.gg/XqXa53W2Yh).
|
||||
|
||||
# Legal Disclaimers
|
||||
|
||||
AssetRipper is licensed under the [GNU General Public License v3.0](https://github.com/AssetRipper/AssetRipper/blob/master/LICENSE.md)
|
||||
- AssetRipper is licensed under the [GNU General Public License v3.0](https://github.com/AssetRipper/AssetRipper/blob/master/LICENSE.md)
|
||||
- Using or distributing output from this software may be subject to copyright laws in your jurisdiction
|
||||
- AssetRipper is not sponsored by or affiliated with Unity Technologies or its affiliates
|
||||
- "Unity" is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere
|
||||
|
||||
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](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.
|
||||
For a full list of attributions, please see our [Credits](articles/Credits.md) page.
|
||||
Loading…
x
Reference in New Issue
Block a user