Merge branch 'main' of https://github.com/munkybutt/SkinPlusPlus

Author: munkybutt

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -12,7 +12,7 @@
   <a href="https://github.com/munkybutt/SkinPlusPlus/blob/main/LICENSE">
     <img src="https://img.shields.io/github/license/munkybutt/SkinPlusPlus?style=for-the-badge"
   </a>
-  <a href="https://github.com/munkybutt/SkinPlusPlus/releases/tag/v0.3.0">
+  <a href="https://github.com/munkybutt/SkinPlusPlus/releases/latest">
     <!-- <img src="https://badge.fury.io/gh/munkybutt%2FSkinPlusPlus.svg?style=for-the-badge"> -->
     <img src="https://img.shields.io/github/release/munkybutt/SkinPlusPlus?style=for-the-badge&include_prereleases">
   </a>
@@ -25,6 +25,7 @@
 </p>
 
 <p align="center">
+  <a href="#disclaimer">Disclaimer</a> •
   <a href="#key-features">Key Features</a> •
   <a href="#usage">Usage</a> •
   <a href="#performance">Performance</a> •
@@ -34,6 +35,11 @@
 </p>
 
 
+## Disclaimer
+
+This software (SkinPlusPlus) is provided "as is", without any warranty. The authors or copyright holders will not be liable for any damages or claims related to the software or its use.
+
+
 ## Key Features
 * Save and load skin data with speed
   - Logic is written in c++ but exposed with python bindings
@@ -43,8 +49,10 @@
 
 * Currently supported DCCs:
   - 3DsMax:
+    - 2024 - Python310
     - 2023 - Python39
-  	- 2021 and 2022 - Python37
+    - 2022 - Python37
+  	- 2021 - Python37
   - Maya:
     - 2023 - Python39
     - 2022 - Python37
@@ -58,8 +66,13 @@ There are three types of data that are of interest when working with skin data:
 PySkinData is a c++ struct containing the above data, exposed to python as the SkinData class.  
 This struct allows the data to be typed correctly rather than all typed as floats.  
 On the c++ side, the data is stored in Eigen matrices.  
-On the Python side, the data is exposed via Pybind11 as numpy arrays.  
-It also provides a friendly interface to the raw data in the form of the following properties:
+On the Python side, the data is exposed via Pybind11 as numpy arrays.
+
+Due to the relationship between Eigen and Pybind11, there is no performance hit when passing arrays to and from c++.
+
+🔥 It is fast 🔥
+
+It also provides a simple interface to the raw data in the form of the following properties:
 - SkinData.weights
 - SkinData.bone_ids
 - SkinData.positions