Skip to content

Web powered cross-platform 3D, WebXR game engine.

License

Notifications You must be signed in to change notification settings

Xnut22/nunuStudio

This branch is 77 commits behind tentone/nunuStudio:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 8, 2022
351bbcb · Mar 8, 2022
Mar 8, 2022
Mar 18, 2021
Nov 20, 2021
Oct 18, 2020
Jul 7, 2020
Aug 25, 2020
Jan 26, 2017
Jun 27, 2020
Nov 8, 2020
Mar 18, 2021
Jul 22, 2020
Jun 27, 2020
Jan 30, 2019
Feb 12, 2018
Mar 2, 2022
Mar 1, 2022
Oct 3, 2021
Oct 30, 2020
Oct 3, 2021
Oct 3, 2021

Repository files navigation

GitHub versionnpm versionGitHub issues GitHub stars

  • nunuStudio is an open source game engine for the web it allows designers and web developers to easily develop 3D experiences for the web.
  • Powered by three.js can run directly in the web or be exported as desktop application trough nwjs.io.
  • Fully featured visual editor, supports a wide range of file formats, the tools are open source and completely free to use for both personal and commercial usage.
  • Visual scene editor, code editor, visual tools to edit textures, materials, particle emitters and a powerful scripting API that allows the creation of complex applications using JavaScript or Python.
  • Fully featured web version of the editor is available on the project page.
  • The web version is tested with Firefox, Chrome and Microsoft Edge, mobile browsers are supported as well.

  • API Documentation with full details about the inner working of every module are available. These can also be generated from the project source code by running npm run docs.
  • Basic tutorials are available on the project page. The basic tutorials explain step-by-step how to use the editor.
  • To build the project first install Node.js LTS and NPM:
    • The building system generates minified builds for the runtime and for the editor
    • Documentation generation uses YuiDocs
    • Install dependencies from npm by running npm install --legacy-peer-deps and additional non-npm packages using npm run napa
    • Build editor, runtime and documentation, run npm run build
  • Webpage of the project is built using Angular and is hosted on GitHub Pages

Screenshots

Features

  • Visual application editor

    • Drag and drop files directly into the project (images, video, models, ...)
    • Manage project resources.
    • Edit material, textures, shaders, code, ...
  • Built on three.js library w/ physics by cannon.js

    • Real time lighting and shadow map support
    • three.js libraries can be imported into the editor
    • Wide range of file formats supported (gltf, dae, obj, fbx, 3ds, ...)
  • NW.js and Cordova exports for desktop and mobile deployment

  • Compatible with WebXR for Virtual Reality and Augmented Reality

  • The project uses Webpack to build and bundle its code base.

    • The building system generates minified builds for the runtime and for the editor
    • JavaScript is optimized and minified using Uglify
    • Documentation generation uses YuiDocs
  • To build the project first install Java, Node.js and NPM and ensure that java command is working properly.

  • Install dependencies from npm by running npm install some dependencies are not available on npm and have to be installed by running npm install napa

  • Install the dependencies for the project webpage running cd source/page && npm install

  • Build editor, runtime and documentation, run npm run build

Embedding Application

  • Application developed with can be embedded into already existing web pages, and are compatible with frameworks like Angular or React.
  • To embed applications in HTML pages the following code can be used, the application is bootstrapped using the loadApp(file, id) method.
<html>
    <head>
        <script src="nunu.min.js"></script>
    </head>
    <body onload="Nunu.App.loadApp('pong.nsp', 'canvas')">
        <canvas width="800" height="480" id="canvas"></canvas>
    </body>
</html>

License

  • The project is distributed under a MIT license that allow for commercial usage of the platform without any cost.
  • The license is available on the project GitHub page

About

Web powered cross-platform 3D, WebXR game engine.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 89.4%
  • HTML 6.4%
  • TypeScript 1.3%
  • Handlebars 1.2%
  • CSS 1.0%
  • GLSL 0.7%