three-engine - npm Package Compare versions

Comparing version 1.0.31 to 1.0.32

package.json

 {
   "name": "three-engine",
-  "version": "1.0.31",
-  "description": "TypeScript definitions for three-engine",
-  "main": "",
-  "types": "index.d.ts",
-  "scripts": {},
+  "sideEffects": false,
+  "keywords": [
+    "three-engine",
+    "three.js",
+    "engine",
+    "three",
+    "js",
+    "javascript",
+    "framework",
+    "three",
+    "3d",
+    "virtual-reality",
+    "augmented-reality",
+    "webgl",
+    "webgl2",
+    "webaudio",
+    "webgpu", 
+    "webxr",
+    "canvas",
+    "svg",
+    "html5"
+  ],
+  "version": "1.0.32",
+  "description": "Engine/framework for three.js",
+  "main": "./build/three-engine.min.js",
+  "module": "./build/three-engine.module.js",
+  "exports": {
+    ".": {
+      "import": "./build/three-engine.module.js",
+      "require": "./build/three-engine.cjs"
+    },
+    "./tools/*": "./src/tools/*"
+  },
+  "files": [
+    "build/three-engine.js",
+    "build/three-engine.cjs",
+    "build/three-engine.min.js",
+    "build/three-engine.module.js",
+    "LICENSE.md",
+    "package.json",
+    "README.md",
+    "src"
+  ],
+  "scripts": {
+    "start": "npm run dev",
+    "dev": "npm run build && npm run explorer",
+    "explorer": "servez -p 8080 --ssl --hidden --no-index",
+    "example": "http-server . -o /examples/example.html",
+    "build": "cdir build && webpack build --config webpack.prod.js --env min && webpack build --config webpack.prod.js --env js && webpack build --config webpack.prod.js --env module && webpack build --config webpack.prod.js --env cjs",
+    "lint": "eslint src --ext js",
+    "lint-fix": "eslint src --ext js --fix"
+  },
   "author": "Artur Brytkowski",
   "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "^7.20.2",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-react": "^7.18.6",
+    "autoprefixer": "^10.4.13",
+    "babel-loader": "^9.1.0",
+    "clear-directory": "^1.0.7",
+    "css-loader": "^6.7.2",
+    "cssnano": "^5.1.14",
+    "eslint": "^8.28.0",
+    "eslint-plugin-react": "^7.31.11",
+    "html-webpack-plugin": "^5.5.0",
+    "http-server": "^14.1.1",
+    "mini-css-extract-plugin": "^2.7.1",
+    "postcss-loader": "^7.0.1",
+    "sass": "^1.56.1",
+    "sass-loader": "^13.2.0",
+    "servez": "^1.14.1",
+    "style-loader": "^3.3.1",
+    "webpack": "^5.75.0",
+    "webpack-bundle-analyzer": "^4.7.0",
+    "webpack-cli": "^5.0.0",
+    "webpack-dev-server": "^4.11.1",
+    "webpack-merge": "^5.8.0"
+  },
   "dependencies": {
-    "@types/three": "^0.148.0"
+    "three": "^0.148.0"
   }
 }

README.md

@@ -1,2 +0,2 @@
-<h1 align="center"><b>three-engine-ts-types</b></h1>
+<h1 align="center"><b>three-engine</b></h1>
 <p align="center">
@@ -7,11 +7,77 @@ <img src="https://global.discourse-cdn.com/standard17/uploads/threejs/optimized/2X/e/e4f86d2200d2d35c30f7b1494e96b9595ebc2751_2_1016x1024.png" style="width: 200px;">
 
+## What is <b>three-engine</b>?
+three-engine is framework/engine for three.js.
+
+## Compatibility
+Complatible with three.js r.147
+
 ## How to install
-    npm install @types/three-engine
+    npm install three-engine
 
-## Compatilibility
+## How to use
+    import * as THREE from 'three';
+    import ThreeEngine from 'three-engine';
+    new ThreeEngine({
+        callbacks: {
+            init: threeEngine => {
+                const box = new THREE.Mesh(new THREE.BoxGeometry(0.5, 0.5, 0.5), new THREE.MeshStandardMaterial);
+                box.setupClickable();
+                threeEngine.scene.add(box);
+                box.onClick = function(){console.log('Clicked')};
+                box.onHover = function(){console.log('Hovered')};
+            }
+        },
+        setup: {
+            enableControls: true,
+            enableTestLights: true,
+            enableAntialias: true,
+            DEV_MODE: true
+        }
+    });
 
-- <b>three.js</b> r.148
+## Example
 
-- <b>three-engine</b> 1.0.31
+You can find example in <b>/examples/example.js</b>.
+To run example:
 
+    git clone https://github.com/allala0/three-engine.git
+    cd three-engine
+    npm install
+    npm run example
+
+## TODO
+- [ ] **Documentation!!!**
+- [ ] **Fix FXAA antialias warning**
+- [ ] **Export all tools in ThreeEngine**
+- [ ] **Axes helper with signed axes**
+- [ ] **Screenshots**
+- [ ] **Thick lines**
+- [ ] **Built in shaders**
+    - [ ] **Outline shader**
+- [ ] **Particle system**
+- [ ] **Geometry sprites**
+- [ ] **Physics engine**
+- [ ] **3D models**
+- [ ] **3D models animations**
+- [ ] **PerspectiveCamera min width**
+- [ ] **Builtin custom geometries**
+- [ ] **Geometry editor**
+- [ ] **Postprocessing pipeline manager**
+- [ ] **3D Editor with UI (adding, moving and rotating, scaling objects, lights, cameras etc. with mouse)**
+- [ ] **Material editor**
+- [ ] **Zoom to cursor in controls**
+- [ ] **First person camera**
+- [ ] **Third person camera**
+- [ ] **Keyboard and mouse controls**
+- [ ] **Multiplayer engine (Colyseus)**
+- [ ] **AI**
+- [ ] **Helpers for test lights**
+- [ ] **Custom loading screens**
+- [ ] **Shadow config in gui**
+- [ ] **Keyboard input**
+- [ ] **UI system**
+- [ ] **Sound system**
+- [ ] **Settings template**
+- [ ] **Mobile touch controls (pinch)**
+
 <br>
@@ -18,0 +84,0 @@ Creator: <b>Artur Brytkowski</b>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1255938

increased by2239.02%

Number of package files

30

increased by11.11%

Lines of code

19068

increased by2422.22%

Number of lines in readme file

88

increased by300%

Worsened metrics

Dev dependency count

23

increased byInfinity%

Number of low supply chain risk alerts

3

increased by200%

Dependency changes

• + Addedthree@^0.148.0

• + Addedthree@0.148.0(transitive)

• - Removed@types/three@^0.148.0

• - Removed@types/three@0.148.1(transitive)

• - Removed@types/webxr@0.5.20(transitive)