From aa0239ed669b98f0fa522d0393eb9d960bc5d28d Mon Sep 17 00:00:00 2001 From: Jeremy Pritts Date: Sun, 15 May 2022 21:07:51 -0400 Subject: [PATCH] bump version, update documentation, and add some licenses --- AssetRipper.Fundamentals/BuildInfo.cs | 2 +- AssetRipper.sln | 9 ++--- AssetRipperCore/README.md | 3 -- AssetRipperGUI/README.md | 3 -- AssetRipperLibrary/AssetRipperLibrary.csproj | 4 ++ AssetRipperLibrary/README.md | 3 -- Licenses/Smolv.md | 39 ++++++++++++++++++++ Licenses/SpirV.md | 25 +++++++++++++ Smolv/README.md | 2 +- SpirV/README.md | 2 +- UnitTester/README.md | 2 +- docs/articles/CommonIssues.md | 13 +------ docs/articles/ExportFeatures.md | 29 --------------- docs/articles/RoadMap.md | 3 +- docs/articles/toc.yml | 2 - 15 files changed, 78 insertions(+), 63 deletions(-) delete mode 100644 AssetRipperCore/README.md delete mode 100644 AssetRipperGUI/README.md delete mode 100644 AssetRipperLibrary/README.md create mode 100644 Licenses/Smolv.md create mode 100644 Licenses/SpirV.md delete mode 100644 docs/articles/ExportFeatures.md diff --git a/AssetRipper.Fundamentals/BuildInfo.cs b/AssetRipper.Fundamentals/BuildInfo.cs index c135dcc8e..db9ad4a39 100644 --- a/AssetRipper.Fundamentals/BuildInfo.cs +++ b/AssetRipper.Fundamentals/BuildInfo.cs @@ -12,6 +12,6 @@ public const string Author = "ds5678"; public const string CopyRight = "Copyright © 2022"; - public const string Version = "0.2.0.0"; + public const string Version = "0.2.0.1"; } } diff --git a/AssetRipper.sln b/AssetRipper.sln index fa07ce2c4..c240a4c65 100644 --- a/AssetRipper.sln +++ b/AssetRipper.sln @@ -78,7 +78,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{E3A52FDC-1 docs\articles\Credits.md = docs\articles\Credits.md docs\docfx.json = docs\docfx.json docs\articles\Downloads.md = docs\articles\Downloads.md - docs\articles\ExportFeatures.md = docs\articles\ExportFeatures.md docs\index.md = docs\index.md docs\articles\Requirements.md = docs\articles\Requirements.md docs\articles\RoadMap.md = docs\articles\RoadMap.md @@ -103,13 +102,13 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Smolv", "Smolv\Smolv.csproj EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SpirV", "SpirV\SpirV.csproj", "{2135442C-E861-486D-A07B-0367A09177F9}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.Fundamentals", "AssetRipper.Fundamentals\AssetRipper.Fundamentals.csproj", "{AC2D1259-7BFF-4960-A9B9-A5B4D4CD4F04}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AssetRipper.Fundamentals", "AssetRipper.Fundamentals\AssetRipper.Fundamentals.csproj", "{AC2D1259-7BFF-4960-A9B9-A5B4D4CD4F04}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.Yaml", "AssetRipper.Yaml\AssetRipper.Yaml.csproj", "{E3458355-E654-41B9-A06C-9E2A00EA9CE2}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AssetRipper.Yaml", "AssetRipper.Yaml\AssetRipper.Yaml.csproj", "{E3458355-E654-41B9-A06C-9E2A00EA9CE2}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.SerializationLogic", "AssetRipper.SerializationLogic\AssetRipper.SerializationLogic.csproj", "{0077BA34-CA1E-4A08-8B3A-49B8EA57EA40}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AssetRipper.SerializationLogic", "AssetRipper.SerializationLogic\AssetRipper.SerializationLogic.csproj", "{0077BA34-CA1E-4A08-8B3A-49B8EA57EA40}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AssetRipper.Yaml.Tests", "AssetRipper.Yaml.Tests\AssetRipper.Yaml.Tests.csproj", "{838B66B6-B54D-4BEE-B7E3-888E8FDE7CAE}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AssetRipper.Yaml.Tests", "AssetRipper.Yaml.Tests\AssetRipper.Yaml.Tests.csproj", "{838B66B6-B54D-4BEE-B7E3-888E8FDE7CAE}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/AssetRipperCore/README.md b/AssetRipperCore/README.md deleted file mode 100644 index 7200912ff..000000000 --- a/AssetRipperCore/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# AssetRipperCore - -Core library. It's designed as an single module without any third party dependencies. \ No newline at end of file diff --git a/AssetRipperGUI/README.md b/AssetRipperGUI/README.md deleted file mode 100644 index ca83df29d..000000000 --- a/AssetRipperGUI/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# AssetRipper GUI Version - -This project adds a user-friendly graphical interface for ripping games. \ No newline at end of file diff --git a/AssetRipperLibrary/AssetRipperLibrary.csproj b/AssetRipperLibrary/AssetRipperLibrary.csproj index 4598d8238..7332c7de1 100644 --- a/AssetRipperLibrary/AssetRipperLibrary.csproj +++ b/AssetRipperLibrary/AssetRipperLibrary.csproj @@ -137,4 +137,8 @@ + + + + diff --git a/AssetRipperLibrary/README.md b/AssetRipperLibrary/README.md deleted file mode 100644 index 63b0e0ba4..000000000 --- a/AssetRipperLibrary/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# AssetRipperLibrary - -This is an expansion library for AssetRipperCore. It includes some third party dependencies and has some extra converters. Some of these features will be Windows-only. \ No newline at end of file diff --git a/Licenses/Smolv.md b/Licenses/Smolv.md new file mode 100644 index 000000000..77e15501e --- /dev/null +++ b/Licenses/Smolv.md @@ -0,0 +1,39 @@ +------------------------------------------------------------------------------ +This software is available under 2 licenses -- choose whichever you prefer. +------------------------------------------------------------------------------ +ALTERNATIVE A - MIT License +Copyright (c) 2016-2018 Aras Pranckevicius +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +------------------------------------------------------------------------------ +ALTERNATIVE B - Public Domain (www.unlicense.org) +This is free and unencumbered software released into the public domain. +Anyone is free to copy, modify, publish, use, compile, sell, or distribute this +software, either in source code form or as a compiled binary, for any purpose, +commercial or non-commercial, and by any means. +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and to +the detriment of our heirs and successors. We intend this dedication to be an +overt act of relinquishment in perpetuity of all present and future rights to +this software under copyright law. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +------------------------------------------------------------------------------ \ No newline at end of file diff --git a/Licenses/SpirV.md b/Licenses/SpirV.md new file mode 100644 index 000000000..76fb0d967 --- /dev/null +++ b/Licenses/SpirV.md @@ -0,0 +1,25 @@ +BSD 2-Clause License + +Copyright (c) 2017, Matthäus G. Chajdas +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/Smolv/README.md b/Smolv/README.md index f420cb0fe..f952adf46 100644 --- a/Smolv/README.md +++ b/Smolv/README.md @@ -2,4 +2,4 @@ ## License -[Smolv](https://github.com/aras-p/smol-v) is licensed under the [MIT license](https://github.com/ds5678/AssetRipper/blob/master/Licenses/Smolv.md). \ No newline at end of file +[Smolv](https://github.com/aras-p/smol-v) is licensed under the [MIT license](https://github.com/AssetRipper/AssetRipper/blob/master/Licenses/Smolv.md). \ No newline at end of file diff --git a/SpirV/README.md b/SpirV/README.md index b564722e2..4280287aa 100644 --- a/SpirV/README.md +++ b/SpirV/README.md @@ -2,4 +2,4 @@ ## License -[SpirV](https://github.com/Anteru/csspv) is licensed under the [BSD 2-Clause license](https://github.com/ds5678/AssetRipper/blob/master/Licenses/SpirV.md). \ No newline at end of file +[SpirV](https://github.com/Anteru/csspv) is licensed under the [BSD 2-Clause license](https://github.com/AssetRipper/AssetRipper/blob/master/Licenses/SpirV.md). \ No newline at end of file diff --git a/UnitTester/README.md b/UnitTester/README.md index cdd8027f4..b21a18271 100644 --- a/UnitTester/README.md +++ b/UnitTester/README.md @@ -5,7 +5,7 @@ This is an automated testing program. ## File Structure ``` -root //contains the Unit Tester executable +Bins |--Tests | |--2019.4.3 //just an example | | |--Test1Name diff --git a/docs/articles/CommonIssues.md b/docs/articles/CommonIssues.md index bc541c09c..7ad576037 100644 --- a/docs/articles/CommonIssues.md +++ b/docs/articles/CommonIssues.md @@ -39,15 +39,4 @@ It is almost always caused by having two assemblies with the same name in the Ma Modified assemblies almost always cause read errors when used in AssetRipper. Here are some common changes that are known to cause lots of problems: * Publicizing an assembly changes field deserialization on Monobehaviours. * Attribute removal can also change field deserialization. -* Modified method bodies can cause decompiler errors. - -## Game ripped without errors, but Unity crashes on launch - -The most common cause of this is not upgrading your project's Unity version. Currently, AssetRipper exports everything as a `2017.3.0` project, but if the game used a newer Unity version, this needs to be upgraded in UnityHub before launching the editor. - -You should be prompted with confirmation box beginning with `Your project was last saved with a different version of Unity.`. Click `Continue`. - -Other possible causes of this issue include: -* Exporting engine assets as normal assets -* Including engine dll assemblies in the project -* Bugged Yaml export \ No newline at end of file +* Modified method bodies can cause decompiler errors. \ No newline at end of file diff --git a/docs/articles/ExportFeatures.md b/docs/articles/ExportFeatures.md deleted file mode 100644 index 059a75d11..000000000 --- a/docs/articles/ExportFeatures.md +++ /dev/null @@ -1,29 +0,0 @@ -## Export features -* Scenes -* Prefabs (GameObjects with transform components) -* AnimationClips (legacy, generic, humanoid) -* Meshes (various formats) -* Shaders (dummy) -* Textures -* Audio -* Fonts -* Movie textures -* Materials -* AnimatorControllers -* Avatars -* Terrains -* TextAssets -* Components: - * MeshRenderer - * SkinnedMeshRenderer - * Animation - * Animator - * Canvas - * Light - * ParticleSystem - * Colliders - * Rigidbody - * AudioSource - * Camera - * MonoBehaviour (Mono and Il2Cpp) - * MonoScript (Mono and Il2Cpp) \ No newline at end of file diff --git a/docs/articles/RoadMap.md b/docs/articles/RoadMap.md index b6ef3686b..60d0ad58f 100644 --- a/docs/articles/RoadMap.md +++ b/docs/articles/RoadMap.md @@ -1,9 +1,8 @@ # Development Roadmap -## 0.2.0.1 +## 0.2.0.2 * Bug fixing * TextureImporter Yaml - * Any other bugs that pop up * Mesh export - STL, OBJ, FBX, PLY, GLB * Convert Unified Exporter to the new system * Convert GLB Exporter to the new system diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml index f410385b5..5c01945ec 100644 --- a/docs/articles/toc.yml +++ b/docs/articles/toc.yml @@ -4,8 +4,6 @@ href: Downloads.md - name: Common Issues href: CommonIssues.md -- name: Export Features - href: ExportFeatures.md - name: Requirements href: Requirements.md - name: Road Map