Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Commit

Permalink
Add Unity Package Manager Support and restructure
Browse files Browse the repository at this point in the history
  • Loading branch information
TriceHelix committed Apr 22, 2023
1 parent aa1a943 commit 4c45c62
Show file tree
Hide file tree
Showing 30 changed files with 55 additions and 9 deletions.
23 changes: 15 additions & 8 deletions README.md
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
2 changes: 1 addition & 1 deletion Editor.meta → TriceHelix.BurstSkinning.Editor.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

File renamed without changes.
8 changes: 8 additions & 0 deletions TriceHelix.BurstSkinning.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

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.
24 changes: 24 additions & 0 deletions package.json
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"
}
}
7 changes: 7 additions & 0 deletions package.json.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4c45c62

Please sign in to comment.