This repository has been archived by the owner on Sep 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Unity Package Manager Support and restructure
- Loading branch information
1 parent
aa1a943
commit 4c45c62
Showing
30 changed files
with
55 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,30 @@ | ||
# Burst Skinning for Unity | ||
|
||
### Fast Mesh Skinning on the CPU using Linear Blend (LBS) and Dual Quaternion (DQS) utilizing the Unity Jobs system and Burst compilation | ||
Requires Unity 2022.2 and newer. | ||
|
||
--- | ||
|
||
This repository is currently a WIP. The code is fully functional but not yet well documented, and may or may not be expanded upon in the future. | ||
#### Installation (via Package Manager) | ||
* Click "Add package from git URL..." | ||
* Enter `https://github.com/TriceHelix/BurstSkinning.git` and click "Add" | ||
* Done! | ||
|
||
To get started, add a `BurstSkinner` component to a GameObject and configure it. Alternatively implement the interface `IBurstSkinnable` and pass deriving instances to `BurstSkinningUtility.Skin()` for more customizable skinning. | ||
|
||
This code was developed and tested in Unity 2022.2+, older versions technically work but are not officially supported. | ||
|
||
--- | ||
|
||
##### Dependencies (Unity Package Manager): | ||
*NOTE: This will install the following dependencies:* | ||
* Unity.Burst | ||
* Unity.Collections | ||
* Unity.Mathematics | ||
|
||
--- | ||
|
||
#### Getting Started | ||
Add a `BurstSkinner` component to a GameObject and configure it. (Add Component -> Mesh -> Burst Skinner) | ||
|
||
Alternatively you can implement the interface `IBurstSkinnable` and pass deriving instances to `BurstSkinningUtility.Skin()` for more customizable skinning. | ||
|
||
This repository is still a major WIP and is currently used internally for a larger project. More Documentation will be added in the future. | ||
|
||
--- | ||
|
||
##### References | ||
* Ladislav Kavan - https://skinning.org/direct-methods.pdf |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{ | ||
"name": "com.tricehelix.burstskinning", | ||
"version": "0.2.0", | ||
"displayName": "Burst Skinning", | ||
"description": "Fast Mesh Skinning on the CPU using Linear Blend (LBS) and Dual Quaternion (DQS) utilizing the Unity Jobs system and Burst compilation", | ||
"unity": "2022.2", | ||
"documentationUrl": "https://github.com/TriceHelix/BurstSkinning", | ||
"changelogUrl": "https://github.com/TriceHelix/BurstSkinning", | ||
"license": "LICENSE.txt", | ||
"licensesUrl": "https://github.com/TriceHelix/BurstSkinning/blob/master/LICENSE.txt", | ||
"dependencies": { | ||
"com.unity.burst": "1.8.0", | ||
"com.unity.collections": "2.1.0" | ||
}, | ||
"keywords": [ | ||
"burst", | ||
"mesh skinning" | ||
], | ||
"author": { | ||
"name": "Trice Helix", | ||
"email": "trice.helix@gmail.com", | ||
"url": "https://github.com/TriceHelix" | ||
} | ||
} |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.