diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**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):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /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: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. 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. diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..ac6621f --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c1caaad --- /dev/null +++ b/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 +team@etherealengine.org. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c375ebd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,63 @@ +## Contrib Rules + +When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +### Code Standards + +We have strict formatting rules for all `.ts` and `.tsx` files. Please use the `npm run format` hook before making a commit to ensure the rules are adhered to. The commit hook will fail if the formatter has not been run and there are formatting issues. + +### Pull Request Process + +Develop on your own branch and submit PRs for review. + +If you are part of the Ethereal Engine development team, please create branches on ths repository, otherwise create a fork and branches to PR. + +Ensure any extraneous local project files, installs or build dependencies are removed before making a PR. You may make a seperate PR for adding to the .gitignore. + +Before merging in any Pull Request, ensure that all checks pass, particularly the workflow/compile-codebase check. This ensures that the codebase will continue to build and deploy successfully. + +You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. + +### Building new versions + +Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer. (https://semver.org/) + + + +## Pull Request Template + +## Summary + +* Some retargeting system clean-up +* Removed redundant math functions + +## Checklist +- [ ] CI/CD checks pass `npm run check` + - [ ] Linter passing via `npm run lint` + - [ ] Typescript passing via `npm run check-errors` + - [ ] Unit & Integration tests passing via `npm run test` + - [ ] Docker build process passing via `npm run build-client` +- [ ] If this PR is still a WIP, convert to a draft +- [ ] When this PR is ready, mark it as "Ready for review" +- [ ] Changes have been manually QA'd +- [ ] Changes reviewed by at least 2 approved reviewers + +## References + +References to pertaining issue(s) + +## QA Steps + +1. git checkout pr_branch_name +2. npm install +3. npm run dev-reinit +4. npm run dev + +List any additional steps required to QA the changes of this PR, as well as any supplemental images or videos. + +## Reviewers + +Reviewers for this PR +@[github id] diff --git a/LICENSE b/LICENSE index 17e3ed8..d426124 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 XR Foundation +Copyright (c) 2021-2023 Ethereal Engine - Formerly XREngine by XR Foundation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 34884b0..c0b9b55 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # Universal Volumetric -The open source Universal Volumetric (".uvol") compressed interchange format for streaming mesh sequences. This project includes a cross-platform player implementation using h.264 video for texture encoding and Draco and Corto compression for GLTF 3D model. +### The open source Universal Volumetric (".uvol") compressed interchange format for streaming mesh sequences. + +#### This tech was built in partnership with Wild Capture and others. + +You can see an example on Wild Capture's site, here: http://wildcapture.co/volumetric.html + +This project includes a cross-platform player implementation using h.264 video for texture encoding and Draco and Corto compression for GLTF 3D model. The initial version focuses on performance. Currently, single material mesh sequences of any length are supported. The next version will focus on higher compression ratio, streamability and integration into USD and glTF. @@ -10,9 +16,6 @@ The current implementation uses the MIT-licensed Corto codec from CNR-ISTI Visua If you are proficient in C++, python, JS, Unity/C#, or you want to support this project creatively or financially, please get in touch! ### Example -This tech was built in partnership with Wild Capture and others. - -You can see an example on Wild Capture's site, here: http://wildcapture.co/volumetric.html Current uvol files consist of a .uvol binary, manifest file and video texture. Future versions will embed everything into the uvol binary or in a single MP4 container. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..034e848 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +Tell them where to go, how often they can expect to get an update on a +reported vulnerability, what to expect if the vulnerability is accepted or +declined, etc. diff --git a/android/build.gradle b/android/build.gradle index 80b045e..c7fcfbf 100644 --- a/android/build.gradle +++ b/android/build.gradle @@ -5,7 +5,7 @@ buildscript { mavenCentral() } dependencies { - classpath "com.android.tools.build:gradle:7.4.1" + classpath "com.android.tools.build:gradle:7.4.2" // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties index e1e81d9..970c1b6 100644 --- a/android/gradle/wrapper/gradle-wrapper.properties +++ b/android/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ #Wed Jun 16 21:24:57 PDT 2021 distributionBase=GRADLE_USER_HOME -distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.1-bin.zip distributionPath=wrapper/dists zipStorePath=wrapper/dists zipStoreBase=GRADLE_USER_HOME diff --git a/encoder/package.json b/encoder/package.json index d186286..dcc46af 100755 --- a/encoder/package.json +++ b/encoder/package.json @@ -1,10 +1,10 @@ { - "name": "@etherealengine/Universal-Volumetric", + "name": "volumetric", "version": "0.2.0", "private": true, "repository": { "type": "git", - "url": "git://github.com/etherealengine/Universal-Volumetric.git" + "url": "git://github.com/AtlasFoundation/Volumetric.git" }, "engines": { "yarn": ">= 0.18.0" @@ -14,18 +14,13 @@ "scripts": { "encode": "babel ./src/libs/cortodecoder.js --out-file corto.js --plugins @@babel/plugin-transform-modules-umd" }, - "author": "Ethereal Engine", "license": "MIT", "type": "module", - "bugs": { - "url": "https://github.com/etherealengine/three-volumetric/issues" - }, - "homepage": "https://github.com/etherealengine/Universal-Volumetri#readme", "devDependencies": { - "@babel/cli": "7.20.7", - "@babel/core": "7.20.12", - "@babel/plugin-transform-modules-commonjs": "7.20.11", - "@types/glob": "8.0.1", + "@babel/cli": "7.21.0", + "@babel/core": "7.21.0", + "@babel/plugin-transform-modules-commonjs": "7.21.2", + "@types/glob": "8.1.0", "ts-loader": "9.4.2", "ts-node": "10.9.1", "typescript": "4.9.5" @@ -33,7 +28,7 @@ "dependencies": { "esm": "3.2.25", "http-range-fetcher": "1.5.0", - "three": "0.149.0", + "three": "0.150.1", "three-obj-loader-cjs-module": "1.0.0", "xmlhttprequest": "1.8.0" } diff --git a/encoder/src/Encoder30.js b/encoder/src/Encoder30.js index ca8a17b..05d29a8 100755 --- a/encoder/src/Encoder30.js +++ b/encoder/src/Encoder30.js @@ -1,5 +1,4 @@ // UVol ENCODER -// Written by Shaw for XR3ngine // MIT licensed // This encoder uses Corto for quantized mesh compression diff --git a/package.json b/package.json index e7ee83d..ffdd5f2 100755 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "@etherealengine/volumetric", - "version": "1.0.13", + "name": "Ethereal Engine: Universal Volumetric", + "version": "1.0.11", "repository": { "type": "git", "url": "git://github.com/etherealengine/Universal-Volumetric.git" @@ -14,9 +14,6 @@ }, ".": {} }, - "publishConfig": { - "access": "public" - }, "files": [ "dist", "player.d.ts", @@ -25,7 +22,7 @@ "npmClient": "yarn", "jest": "ts-jest", "scripts": { - "patch-npm": "npm version patch && npm publish", + "patch-npm": "npm version patch && npm publish --access public", "build": "npm run build-player && npm run build-worker", "build-player": "tsc", "build-worker": "vite build --config vite.worker.config.ts", @@ -44,15 +41,10 @@ "prettier --write" ] }, - "author": "EtherealEngine", "license": "MIT", - "bugs": { - "url": "https://github.com/etherealengine/Universal-Volumetric/issues" - }, - "homepage": "https://github.com/etherealengine/Universal-Volumetric#readme", "devDependencies": { - "@babel/cli": "7.20.7", - "@babel/core": "7.20.12", + "@babel/cli": "7.21.0", + "@babel/core": "7.21.0", "@types/three": "0.149.0", "@ianvs/prettier-plugin-sort-imports": "3.7.1", "prettier": "2.8.4",