release v0.7.2

.github/contributing.md

@@ -6,6 +6,7 @@ Hi! I'm really excited that you are interested in contributing to Orillusion. Be
 - [Issue Reporting Guidelines](#issue-reporting-guidelines)
 - [Pull Request Guidelines](#pull-request-guidelines)
 - [Development Setup](#development-setup)
+- [Write New Samples](#write-new-samples)
 - [NPM Scripts](#scripts)
 - [Project Structure](#project-structure)
 
@@ -41,10 +42,11 @@ Hi! I'm really excited that you are interested in contributing to Orillusion. Be
 
 [Node.js](https://nodejs.org) **version 16+**, and [PNPM](https://pnpm.io) **version 7+** is perferred.
 
-First, you need to clone/flok repo:
+First, you need to fork repo
+Then, clone your forked repo
 
 ```bash
-$ git clone [email protected]:Orillusion/orillusion.git
+$ git clone [email protected]:XXX/orillusion.git
 $ cd orillusion
 $ git checkout dev # `dev` branch is perfered to start your development
 ```
@@ -75,6 +77,22 @@ A high level overview of main tools used:
 - [Electron](https://www.electronjs.org/) for CI unit testing
 - [TypeDoc](https://typedoc.org/) for API docs generating
 
+## Write New Samples
+
+1. create new entry `ts` in `/samples/xxx/Sample_xxx.ts`, the file name should be self-explanatory and start with `Sample_`. If there is no folder/category for your sample, create new one.
+
+2. write your scene code, take [/samples/base/Sample_Transform.ts](../samples/base/Sample_Transform.ts) as a starter template/example. 
+
+3. Coding rules:
+    1. import core modules from `@orillusion/core`, e.g. `Engine3D, Scene3D, Object3D, ...`.
+    2. import plugins/extentions from `@orillusion/xxx`, e.g. `@orillusion/stats, @orillusion/particle, @orillusion/physics...`.
+    3. perfer using [Top-level await](https://v8.dev/features/top-level-await) to initialize the `Engine3D` and other async APIs.
+    4. perfer embedding all `functions/classes/modules` into one single `ts` file.
+    5. perfer using [dat.gui](https://github.com/dataarts/dat.gui) to control your scene parameters.
+    6. write comments as much as possible to make your code more readable and self-documented.
+
+4. If your sample requires local files, e.g. gltf models, images, we perfer you upload them to a public filehosting service, e.g. github pages, cloudflare CDNs, npmjs, AWS S3, Aliyun OSS, etc. Then use the public URLs to import them in your samples. Otherwise, you can add files to the `/public` folder and make PRs to our [assets](https://github.com/Orillusion/assets) repo so that you can import files directly from the `/` path.
+
 ## Scripts
 
 ### Start a Dev server
@@ -149,4 +167,4 @@ A overview of project structure:
 └─ 📄 README.md           # Read Me!
 ```
 
-Welcome to submit PRs to extend `@orillusion` packages
+Welcome to submit PRs to extend `@orillusion` packages

CHANGELOG.md

@@ -1,3 +1,38 @@
+## [0.7.2](https://github.com/Orillusion/orillusion/compare/v0.7.1...v0.7.2) (2024-01-26)
+
+
+### Bug Fixes
+
+* duplicated class name ([#341](https://github.com/Orillusion/orillusion/issues/341)) ([fe73994](https://github.com/Orillusion/orillusion/commit/fe73994063333feaff538285b82aefdd91ce02cf))
+* Fix the error caused by removing the Sky Box. ([#344](https://github.com/Orillusion/orillusion/issues/344)) ([b02c85a](https://github.com/Orillusion/orillusion/commit/b02c85a6c4637f3a0fbe630dbd9d9a39065b01d8))
+* Fix turning shadows on and off for Materials and MeshRenderers ([#343](https://github.com/Orillusion/orillusion/issues/343)) ([6858cc0](https://github.com/Orillusion/orillusion/commit/6858cc056a25c78e841d4c929ca36e09dd34e9fb))
+* **gltfParser:** Fixed some model indices parsing errors ([#354](https://github.com/Orillusion/orillusion/issues/354)) ([9714d6e](https://github.com/Orillusion/orillusion/commit/9714d6e8d7bdf6bdd9357f78fd33cf9dbc520649))
+* **media-extention:** fix get/set baseColor ([c6c5526](https://github.com/Orillusion/orillusion/commit/c6c5526cab00c21969e5d2b12ab358e487785edf))
+* **physics:** fix new build with Ammo ([bba64a1](https://github.com/Orillusion/orillusion/commit/bba64a1ab35a89b712cd7dd6843118a331b01afe))
+* Shadow of double side materials. ([#337](https://github.com/Orillusion/orillusion/issues/337)) ([e4004e7](https://github.com/Orillusion/orillusion/commit/e4004e747b4723db6f41636e997e662cb6343441))
+* **shadow:** copy texture to texture error ([#339](https://github.com/Orillusion/orillusion/issues/339)) ([6fea86a](https://github.com/Orillusion/orillusion/commit/6fea86ae644b58d0d5a909a667e2b111d286632e))
+* **SkeletonAnimation:** skeleton animation parser ([#353](https://github.com/Orillusion/orillusion/issues/353)) ([10ee99e](https://github.com/Orillusion/orillusion/commit/10ee99e4ebbc9b5c708c458c7d40bd93cb192375))
+
+
+### Features
+
+* **compute:** Add custom compute shader samples ([#336](https://github.com/Orillusion/orillusion/issues/336)) ([c4a7db1](https://github.com/Orillusion/orillusion/commit/c4a7db1a571529c97f550b4fe93d8dc74cf92f59))
+* Renderer of Shape3D ([#360](https://github.com/Orillusion/orillusion/issues/360)) ([9f856bb](https://github.com/Orillusion/orillusion/commit/9f856bb069e7a121b319ebee6b2384984a37e230)), closes [#304](https://github.com/Orillusion/orillusion/issues/304) [#318](https://github.com/Orillusion/orillusion/issues/318)
+* **sample:** add draw mesh line sample ([#331](https://github.com/Orillusion/orillusion/issues/331)) ([b7bf873](https://github.com/Orillusion/orillusion/commit/b7bf87362e6d9ad2d755ff22f462c71f2b2f18f1))
+* **sample:** add moveble light sample ([#355](https://github.com/Orillusion/orillusion/issues/355)) ([b7f186b](https://github.com/Orillusion/orillusion/commit/b7f186ba6009fd702b8a5280dca1c15a00290d3e))
+* **sample:** GUI text barrage ([#333](https://github.com/Orillusion/orillusion/issues/333)) ([ea2ed66](https://github.com/Orillusion/orillusion/commit/ea2ed6685f78c557cdd4447d4752f1a436ced20d))
+* **shader:** add ComputeShader auto binding ([#359](https://github.com/Orillusion/orillusion/issues/359)) ([b0319d9](https://github.com/Orillusion/orillusion/commit/b0319d9138a2d09896f021044f84c069287bbbdd))
+* **shader:** add logarithmic depth ([#346](https://github.com/Orillusion/orillusion/issues/346)) ([24afa9d](https://github.com/Orillusion/orillusion/commit/24afa9dea4da9e6a034303b965807cc8ccf4ee32))
+* update @orillusion/ammo ([a926196](https://github.com/Orillusion/orillusion/commit/a926196edac77e99ff631b5b924ae7faa1fef22b))
+
+
+### Performance Improvements
+
+* **build:** use esnext as build target ([2fc6f27](https://github.com/Orillusion/orillusion/commit/2fc6f27d91ebdee871168cad2a723d76411cdfd3))
+* Use pixelRatio from UIPanel. ([#338](https://github.com/Orillusion/orillusion/issues/338)) ([03529da](https://github.com/Orillusion/orillusion/commit/03529da3293da748d9f1a6183dab7ee902043bd3))
+
+
+
 ## [0.7.1](https://github.com/Orillusion/orillusion/compare/v0.7.0...v0.7.1) (2023-11-14)
 
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Orillusion
+Copyright (c) 2024 Orillusion
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

index.html

@@ -4,7 +4,7 @@
 <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Graphic3D | Samples</title>
+    <title>Orillusion | Samples</title>
     <style>
         html,
         body {

package.json

@@ -1,8 +1,9 @@
 {
     "name": "@orillusion/core",
-    "version": "0.7.1",
+    "version": "0.7.2",
     "author": "Orillusion",
     "description": "Orillusion WebGPU Engine",
+    "type": "module",
     "main": "./dist/orillusion.umd.js",
     "module": "./dist/orillusion.es.js",
     "exports": {
@@ -35,23 +36,25 @@
         "minify": "./node_modules/vite/node_modules/.bin/esbuild dist/orillusion.es.max.js --minify --outfile=dist/orillusion.es.js && ./node_modules/vite/node_modules/.bin/esbuild dist/orillusion.umd.max.js --minify --outfile=dist/orillusion.umd.js",
         "test": "electron test/ci/main.js",
         "test:ci": "xvfb-maybe -- electron --enable-unsafe-webgpu --enable-features=Vulkan --use-vulkan=swiftshader --use-webgpu-adapter=swiftshader --no-sandbox test/ci/main.js",
-        "docs": "npm run docs:core && npm run docs:physics && npm run docs:media && npm run docs:stats && npm run docs:particle",
+        "docs": "npm run docs:core && npm run docs:physics && npm run docs:media && npm run docs:stats && npm run docs:particle && npm run docs:graphic",
         "docs:typedoc": "npx typedoc --plugin typedoc-plugin-markdown --plugin ./script/typedoc-plugin-not-exported.js --tsconfig tsconfig.build.json --gitRevision main --hideBreadcrumbs true --allReflectionsHaveOwnDocument true --readme none --excludeInternal --excludePrivate --excludeProtected --sort source-order --out",
         "docs:core": "npm run docs:typedoc docs/api src/index.ts",
         "docs:physics": "cd packages/physics && npm run docs",
         "docs:media": "cd packages/media-extention && npm run docs",
         "docs:stats": "cd packages/stats && npm run docs",
         "docs:particle": "cd packages/particle && npm run docs",
+        "docs:graphic": "cd packages/graphic && npm run docs",
         "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
     },
     "devDependencies": {
-        "@webgpu/types": "^0.1.32",
+        "@webgpu/types": "^0.1.40",
         "conventional-changelog-cli": "^2.2.2",
-        "electron": "^26.0.0",
-        "typedoc": "^0.24.7",
-        "typedoc-plugin-markdown": "^3.15.3",
-        "typescript": "^5.0.4",
-        "vite": "^4.3.9",
+        "earcut": "^2.2.4",
+        "electron": "^28.2.0",
+        "typedoc": "^0.25.7",
+        "typedoc-plugin-markdown": "^3.17.1",
+        "typescript": "^5.3.3",
+        "vite": "^5.0.12",
         "xvfb-maybe": "^0.2.1"
     }
 }