Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 4.81 KB

README.md

File metadata and controls

96 lines (61 loc) · 4.81 KB
Raw

Three.V8

Three.V8 was created as a proof of concept (POC) of an embedabble 3D rendering engine using JavaScript as user script.

The ongoing development targets mobile devices, tries to provide another JavaScript based application framework with 3D rendering as its core-function.

The source code here builds & runs on Windows, which can be used for evaluation or script development/debugging.

The Windows implementation requires Visual Studio 2022 to be built, becuase:

  • V8 binary is acquired from NuGet
  • A C# WPF GUI is provided as an example of how to embed the engine.

Subprojects

  • ThreeEngine: C++ 3D rendering engine.
  • Test.Cpp: Simple example using the C++ engine directly.
  • Three.V8: V8 bindings of the 3D rendering engine.
  • Test.V8: Simple example using the V8 engine.
  • Three.V8.CLR: C# bindings of the V8 engine (itself) and OpenGL.
  • GamePlayer: C# WPF GUI embedding the V8 engine.
  • game: Example scripts. The math library and other utilities are borrowed directly from Three.js. Most assets are from discoverthreejs.com and sketchfab.com.

3rd-party libraries

  • V8: For running user script.
  • Three.js: Reusing existing JS utilities.
  • tiny-gltf: For loading GLTF models.
  • draco: Mesh decoder. Used by tiny-gltf.
  • boost: For http(boost::beast).
  • boost::certify: For https.
  • boost::url: For url processing.
  • openssl: For https.
  • nanovg: For embedded GUI subsystem.
  • stb_image: For loading images.
  • libwebp: For loading webp images
  • glm: For geometry maths.
  • glew: For OpenGL Wrangling.
  • bvh: For acceleration of ray-casting.
  • crc64: For state hashing.
  • ffmpeg: For multimedia codecs.
  • PortAudio: For audio I/O.
  • JVB: source-code under "third-party/JVB" are transcribed from Jan Van Bergen's work.

Building

Building is straightforward using Visual Studio 2022. Just make sure to resolve the git submodules first.

Runing GamePlayer

Run the executable "GamePlayer\bin\Release\GamePlayer.exe":

screenshot.png tolerance The script "../../../game/bundle.js" is loaded by default. You can load your own script by clicking the button "Load Script".

The engine doesn't support ES6 modules eg. "import". User scripts need to be pre-bundled using bundlers like rollup.js

Security Model

Three.V8 is NOT a web-browser, therefore it does not always follow the web-security protocols.

Instead, Three.V8 works like other script-based game-engines, i.e., the script is a part of the application package.

Part of the scripting APIs does have direct access to native file-systems and devices. There is not a web-browser style sandbox.

"eval()" should be banned in production code. The engine ensures that only the scripts pass from the host application can be executed. As a result, we consider the host application to have full responsibility that the executed scripts come from reliable sources.

Note that the network scripting APIs are capable of obtaining all kinds of data from the internet, including scripts. We just make sure that the scripts obtained this way doesn't have a chance to get executed.

Updating the scripts from a remote source can possibly be conducted by the host application, which would provide some extra convinience. However, this type of behavior might be forbidden by some mobile platforms, even if the sources are reliable. We therefore call for some reasonable tolerance from these platforms.

License

The source code is licensed under '"Anti 996" License' by Fei Yang and Vulcan Eon (北京鲜衣怒马文化传媒有限公司).

Documentation

User Script APIs

Features and Code Snippets

All features are also available in a unreleased Android build.

Please contact me if you are interested in the Android version of Three.V8:

GMail: hyangfeih@gmail.com

Twitter: @feiyangvr

You can use the mobile engine in your own product by business cooperation with Vulcan Eon.

Or, more preferable, try hiring me.

Android.png