diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e5f3d02 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,55 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Files** + +Attach or link to .glb files or avatar URL that trigger the bug. + +In addition, make sure to run those files through the example scenes first. If you encounter errors or warnings, try to make sure they are not responsible for the issue. + +> Note: You have to ZIP archive them first in order for GitHub to accept the upload. +If your files are confidential: + +- Try to create a similar, but intellectual-property-free Unity example project or build that reproduces the bug in the same way (so any community member can have a look) +- Otherwise, still create this issue and send the files (or a link to them) discretely via email + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - Ready Player Me Core version + - Ready Player Me Avatar Loader version + - Ready Player Me WebView version + - glTFast version + - Unity Editor version [e.g. 2021.2.1f1] + - Render Pipeline and version [e.g. Universal Render Pipeline 12.0] + - Operating System [e.g. Windows, Mac, Linux ] + - Platform: [e.g. Editor , Windows Player, iOS] + +additionally (if significant for the bug): + + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - For WebGL: Browser [e.g. stock browser, safari] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c348a41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. e.g. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..19d25ca --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,55 @@ + + + + + +## [TICKETID](https://ready-player-me.monday.com/boards/2563815861/pulses/TICKETID) + +## Description + +- Briefly describe what this change will do + + + + +## Changes + +#### Added + +- List your additions and new features here. + +#### Updated + +- List your updates and changes here. + +#### Removed + +- List what is removed here. + + + +## How to Test + +- Add steps to locally test these changes + + + +## Checklist + +- [ ] Tests written or updated for the changes. +- [ ] Documentation is updated. +- [ ] Changelog is updated. +- [ ] QA Testing is updated. + +## QA Testing + +- Mention any useful test cases for this feature and add to QA Testing documentation. + +## Details + +- If more details are necessary to support the description with images and videos add them here. + + + + + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..9ce5735 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,80 @@ +# 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 +* Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, 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 support@readyplayer.me. 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 . + +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 . Translations are available at . \ No newline at end of file diff --git a/README.md b/README.md index daf94e3..1cb3c4e 100644 --- a/README.md +++ b/README.md @@ -23,26 +23,28 @@ The plugin can be found on GitHub [here](https://github.com/rdeioris/glTFRuntime ### Add ReadyPlayerMe and glTFRuntime plugins -There are three ways you can add the **ReadyPlayerMe** and the **glTFRuntime** plugins to your project. Add them as submodules, clone the repos, or paste the plugins inside of the Plugins folder. Make sure that the ReadyPlayerMe plugin is named as **ReadyPlayerMe**. +There are three ways you can add the **ReadyPlayerMe** and the **glTFRuntime** plugins to your project. Add them as submodules, clone the repos, or paste the plugins inside of the **Plugins** folder. -- To add the plugins to your project as a submodules, run the following command in the terminal from your project folder. This is prefered way of setting up the plugins. +- To add the plugins to your project as a submodules, run the following command in the terminal from your project folder. This is preferred way of setting up the plugins. ``` -git submodule add --name glTFRuntime -- https://github.com/rdeioris/glTFRuntime.git Plugins/glTFRuntime ; cd Plugins/glTFRuntime ; git checkout $(git describe --tags --abbrev=0) ; cd ../.. ; git submodule add --name ReadyPlayerMe -- https://github.com/readyplayerme/rpm-unreal-sdk.git Plugins/ReadyPlayerMe ; cd Plugins/ReadyPlayerMe ; git checkout $(git describe --tags --abbrev=0) ; cd ../.. +git submodule add --name glTFRuntime -- https://github.com/rdeioris/glTFRuntime.git Plugins/glTFRuntime ; cd Plugins/glTFRuntime ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ; git submodule add --name ReadyPlayerMe -- https://github.com/readyplayerme/rpm-unreal-sdk.git Plugins/ReadyPlayerMe ; cd Plugins/ReadyPlayerMe ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ``` - To clone the plugins into your project, run the following command in the terminal from your project folder. ``` -git clone https://github.com/rdeioris/glTFRuntime.git Plugins/glTFRuntime ; cd Plugins/glTFRuntime ; git checkout $(git describe --tags --abbrev=0) ; cd ../.. ; git clone https://github.com/readyplayerme/rpm-unreal-sdk.git Plugins/ReadyPlayerMe ; cd Plugins/ReadyPlayerMe ; git checkout $(git describe --tags --abbrev=0) ; cd ../.. +git clone https://github.com/rdeioris/glTFRuntime.git Plugins/glTFRuntime ; cd Plugins/glTFRuntime ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ; git clone https://github.com/readyplayerme/rpm-unreal-sdk.git Plugins/ReadyPlayerMe ; cd Plugins/ReadyPlayerMe ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ``` +- To paste the plugins inside of the Plugins folder, create a **Plugins** folder from the root of your project, download the latest tags of the [glTFRuntime](https://github.com/rdeioris/glTFRuntime.git) and [ReadyPlayerMe](https://github.com/readyplayerme/rpm-unreal-sdk.git) plugins into it. Rename the **rpm-unreal-sdk** plugin folder to the **ReadyPlayerMe**. + ### Update ReadyPlayerMe and glTFRuntime plugins To update the plugins paste the following command in the terminal from your project folder. This will fetch and switch the plugin repositories to the latest stable release. ``` -cd Plugins/glTFRuntime ; git fetch --tags ; git checkout $(git describe --tags --abbrev=0) ; cd ../.. ; cd Plugins/ReadyPlayerMe ; git fetch --tags ; git checkout $(git describe --tags --abbrev=0) ; cd ../.. +cd Plugins/glTFRuntime ; git fetch --tags ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ; cd Plugins/ReadyPlayerMe ; git fetch --tags ; git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) ; cd ../.. ``` ## Quick Start