ShadowEditor is a free, open source gaming project written in JavaScript and released under MIT. It has 1,716 GitHub stars, 325 forks and 28 open issues, and was last pushed 6 months ago. On this registry it ranks #75 of 89 tracked projects in Gaming, with 5 head-to-head comparisons available.

What is ShadowEditor?

ShadowEditor is a cross-platform 3D scene editor built on three.js, Go and MongoDB that runs both as a web application and as an Electron desktop application, for developers and designers who need to author, script and publish interactive 3D scenes.

What it is

ShadowEditor is an MIT-licensed 3D scene editor whose declared technology stack spans html, css, javascript, rollup, react.js, webgl, three.js, golang, mongodb, nodejs, electron and protocol buffers. Scenes are drawn with three.js, which the v0.6.0 release upgraded to r130, and are served by a Go backend that persists data in MongoDB; the same editor is packaged with Electron when a desktop build is wanted. The project sits squarely in the three.js and WebGL ecosystem named by its topics: editor, three-editor, threejs, webgl, game-engine, gis, scene and web-gis.

The concrete problem it solves is the assembly of three.js scene graphs by hand in JavaScript, together with the file-and-server plumbing needed to keep those scenes. Instead of writing object hierarchies, materials and event handlers as source code, users edit scenes visually, attach scripts with lifecycle, touch and VR callbacks, and let the Go server store the result in MongoDB. Deployment-level settings such as HTTPS are handled through a config.toml file rather than in application code, and the same backend serves scenes to the browser at the configured address.

Key capabilities

  • Visual editing of three.js scenes rendered through WebGL, with the underlying library upgraded to r130 in the v0.6.0 release.
  • A scripting layer exposing touch events onTouchStart, onTouchEnd and onTouchMove for mobile browsers, alongside the VR events onVRConnected, onVRDisconnected, onVRSelectStart and onVRSelectEnd.
  • VR support toggled by a checkbox in the status bar, including all-in-one handle controllers such as HTC Vive.
  • Visual settings for the polygonOffset, polygonOffsetFactor and polygonOffsetUnits material parameters, exposed specifically to resolve depth conflicts.
  • Scene transform controls and full scene export, including the skyball texture that had previously been dropped on export.
  • HTTPS enablement through config.toml for self-hosted deployments.
  • A core-plus-extensions architecture from v0.6.1 onward, where the editor provides core features and extended APIs and other features arrive as extensions, in the manner of VSCode.

Who uses it and how

  • Teams that want a self-contained deployment run the compiled server, which ships with MongoDB built in and starts from start.bat on Windows or start.sh on Ubuntu.
  • Evaluation and single-machine use follow the documented path of opening http://localhost:2020 in Google Chrome after the server starts.
  • Desktop users take the Electron build, which shares the editor code with the web version.
  • GIS-oriented work is signalled by the gis and web-gis topics, and game scene authoring by the game-engine topic.
  • VR authoring runs against all-in-one handle controllers such as HTC Vive, with VR enabled from the status bar.

Getting started

Download the compiled Windows or Ubuntu server, which bundles MongoDB, run start.bat or start.sh, and open http://localhost:2020 in Google Chrome; the Windows build also requires the Visual C++ Redistributable for Visual Studio 2015. A hosted web demo is available at the project homepage for those who only want to try the editor.

How it compares

No paid or competing products are named anywhere in the material available for this entry, so ShadowEditor stands alone in this registry rather than being positioned against a specific alternative. What distinguishes it as catalogued here is the combination of an MIT licence, a Go and MongoDB backend that can be operated on your own hardware with your own data, and one editor codebase shared between web and Electron desktop builds.

When to use it — and when not to

A self-hoster must operate the Go server and its MongoDB instance, and on Windows must also install the Visual C++ Redistributable for Visual Studio 2015 before anything runs. The release record argues for caution: v0.6.0 is dated July 24, 2021 while v0.6.1 is still listed as coming soon, and the reworked vite4, vue3, ts5 and ant-design-vue7 version is only announced, so anyone needing a predictable release cadence or long-term support commitments should look elsewhere. Support for Bin type models has been dropped, and because v0.6.1 moves non-core features out into extensions, users who depend on the current feature set should confirm those features remain in the core before upgrading.

project readme (upstream, from github) — read inline

Shadow Editor

English / 中文    |    Windows Server    |    Ubuntu Server    |    Web Demo |    official Website

Note: The server is a compiled version with built-in mongodb, execute start.bat or start.sh to start, and visit http://localhost:2020 in Google Chrome. Windows version requires Visual C++ Redistributable for Visual Studio 2015.

Good news! The version based on vite4 + vue3 + ts5 + ant-design-vue7 is coming soon. Click here to view more details.

image image image image image image image

  • Name: Shadow Editor
  • Version: v0.6.1 (Coming Soon)
  • Description: Cross-platform 3D scene editor based on three.js, golang and mongodb.
  • Source: GitHub Gitee | Document: 超腾开源 | Demo: 超腾开源 | Video: Weibo Bilibili | Assets: BaiduNetdisk(rfja)
  • Technology Stack: html, css, javascript, rollup, react.js, webgl, three.js, golang, mongodb, nodejs, electron, protocol buffers.
  • If helpful to you, please DOnate to support us. thank you!

Open Source Version

Pro Version

v0.6.1 is Coming Soon

Starting from v0.6.1, ShadowEditor only provides core features and extended APIs, and other features will be provided in the extensions, just like VSCode. We will develop in the dev branch.

  1. Fix the bug that some versions of go typeface management list report errors.
  2. Hide the model history version tab.
  3. When the sprite is selected, the border is no longer displayed.
  4. Fix searchfield dropdown style bug.

v0.6.0 has Released

  • Release Date: July 24, 2021
  • Update Logs:
  1. Fix the bug that creates a new mongo connection when request.
  2. Check VR in the status bar to enable VR.
  3. Set scene transform.
  4. How to popup a window when click an object: https://gitee.com/tengge1/ShadowEditor/issues/I3APGI
  5. You can enable https in the config.toml.
  6. Add event in the mobile browser to the script: onTouchStart, onTouchEnd, onTouchMove.
  7. Upgrade three.js to r130.
  8. Add VR event to the script: onVRConnected, onVRDisconnected, onVRSelectStart, onVRSelectEnd.
  9. VR all-in-one handle controller supports, for example: htc vive.
  10. Fix the bug of deleting script.
  11. Fix a bug that Geometry can not be serialized due to the upgrade of three.js.
  12. Add material polygonOffset, polygonOffsetFactor, polygonOffsetUnits parameter visualization settings to solve the problem of depth conflict.
  13. Fix a bug that component in mesh cannot save the visible attribute.
  14. Bin type model is no longer supported.
  15. Fix cube texture bug.
  16. Rewrite all the prototype to es6 class in the source code.
  17. Remove the visual module.
  18. Fix a bug that not copy the skyball texture when export a scene.
  19. Fix rain and snow bug.
  20. Modify the background color and lighting, so as not to add the same color as the background and make it difficult to see clearly.
  21. Fix particle emitter bug.
  22. Fix cloth bug.
  23. Fix the bug of dynamic setting shadow.

Feature List

  • General
    • Cross-platform
      • Windows, Linux, Mac
      • Desktop, Web
    • Multi-language support
      • English、中文、繁體中文、日本語、한국어、русский、Le français
    • Assets management
      • scene, mesh, texture, material, audio, animation, screenshot, video, typeface
    • Authority management
      • organization, user
      • role, authority
      • registration, login, password modification
    • Version management
      • Scene history and logs
      • undo, redo, auto saving
    • Player
      • play animations in the scene in real time, and can play full screen and in new window
    • Settings
      • Display, renderer, helpers, filter, weather, control mode, select mode, add mode, language
  • Small scene editing
    • Add mesh
      • 3ds, 3mf, amf, assimp, awd, babylon, bvh, collada, ctm
      • draco, fbx, gcode, gltf, glb, js, kmz, lmesh, md2, pmd, pmx
      • nrrd, obj, pcd, pdb, ply, prwm, sea3d, stl, vrm, vrml, vtk, X
    • Built-in objects
      • group
      • plane, cube, circle, cylinder, sphere, icosahedron, torus, torus knot, teapot, lathe
      • unscaled text, 3D text
      • line segments, CatmullRom curve, quadratic Bezier curve, cubic Bezier curve, ellipse curve
      • point marks
      • arrow helper, axes helper
      • sprite
    • Built-in lights
      • ambient light, directional light, point light, spotlight, hemispherical light, rect area light
      • point light, hemispherical light, rect area light helper
    • Built-in components
      • background music, particle emitter
      • sky, fire, water, smoke, cloth
      • berlin terrain, sky sphere
    • Materials editing
      • LineBasicMaterial, LineDashedMaterial, MeshBasicMaterial, MeshDepthMaterial, MeshNormalMaterial
      • MeshLambertMaterial, MeshPhongMaterial, PointsMaterial, MeshStandardMaterial, MeshPhysicalMaterial
      • SpriteMaterial, ShaderMaterial, RawShaderMaterial
    • Post-processing
      • After-image, bokeh, dot screen, FXAA, glitch
      • halftone, pixel, RGB shift, SAO
      • SMAA, SSAA
      • SSAO, TAA
    • Text editing
      • javascript editing with intelligence
      • shader editing
      • json file editing
    • Mesh export
      • gltf、obj、ply、stl、Collada、DRACO
    • Scene publishment
      • Publish scene as static resources, and can be embedded in iframe
    • Examples
      • Arkanoid, camera, particle, ping pong, shader
    • General tools
      • Select, pan, rotate, zoom
      • Perspective view, front view, side view, top view, wireframe mode
      • Screenshot, record
      • Draw point, draw line, draw polygon, spray
      • Measure distance
    • Others
      • VR:cardboard, htc vive, chrome, firefox
      • Bullet physics engine
  • UI Controls
    • Canvas
    • Form: Button, CheckBox, Form, FormControls, IconButton, IconMenuButton, ImageButton, Input, Label, LinkButton, Radio, SearchField, Select, TextArea, Toggle
    • Icon
    • Image: Image, ImageList, ImageSelector, ImageUploader
    • Layout: AbsoluteLayout, AccordionLayout, BorderLayout, HBoxLayout, TableLayout, VBoxLayout
    • Menu: ContextMenu, MenuBar, MenuBarFiller, MenuItem, MenuItemSeparator, MenuTab.
    • Panel
    • Progress: LoadMask
    • Property: ButtonProperty, ButtonsProperty, CheckBoxProperty, ColorProperty, DisplayProperty, IntegerProperty, NumberProperty, PropertyGrid, PropertyGroup, SelectProperty, TextProperty, TextureProperty
    • SVG
    • Table: DataGrid, Table, TableBody, TableCell, TableHead, TableRow
    • Timeline
    • Toolbar: Toolbar, ToolbarFiller, ToolbarSeparator
    • Tree
    • Window: Alert, Confirm, Message, Photo, Prompt, Toast, Video, Window

Requirements

  1. MongoDB v3.6.8+
  2. Chrome 81.0+ or ​​Firefox 75.0+

The following is only required when you want to build from source.

  1. Golang 1.14.2+
  2. NodeJS 14.1+
  3. gcc 9.3.0+ (tdm-gcc, MinGW-w64 or MinGW on Windows, and make sure gcc can be accessed through the command line)
  4. git 2.25.1+

Note: The version number is for reference only.

Download and Compile

You can use git to download the source code.

git clone https://github.com/tengge1/ShadowEditor.git

In China, github is really slow, you can use gitee instead.

git clone https://gitee.com/tengge1/ShadowEditor.git

Build on both Windows and Ubuntu

Web Version:

  1. If you are in China, run npm run set-proxy to set golang and nodejs proxy.
  2. Run npm install to install nodejs dependencies.
  3. Run npm run build to build the server and web.
  4. Edit build/config.toml, and modify the mongodb host and port.
  5. Run npm start to launch the server. You can now visit: http://localhost:2020.
  6. If you enable https in the config file. Please visit: https://localhost:2020.

Desktop Version:

  1. Download MongoDB and unzip it in the utils/mongodb folder.
  2. Build web version.
  3. Run npm run build-desktop to build a desktop app in the folder build/desktop.

Install as Windows Service

  1. Open PowerShell or cmd in the build folder as administrator.
  2. Run .\ShadowEditor install to install ShadowEditor as a service.
  3. Run .\ShadowEditor start to start ShadowEditor service.
  4. Now you can visit: http://localhost:2020.
  5. You can also manage this service in the Windows Services Manager.

Install as Ubuntu Service

  1. Edit ./scripts/service_linux/shadoweditor.service, set the right path.
  2. Run sudo cp ./scripts/service_linux/shadoweditor.service /etc/systemd/system/.
  3. Run sudo systemctl daemon-reload to reload the service daemon.
  4. Run sudo systemctl start shadoweditor to start service.
  5. Run sudo systemctl enable shadoweditor to auto start service.

Command Line Usage

PS E:\github\ShadowEditor\build\> .\ShadowEditor
ShadowEditor is a 3D scene editor based on three.js, golang and mongodb.
This application uses mongodb to store data.

Usage:
  ShadowEditor [command]

Available Commands:
  debug       Debug service on Windows
  help        Help about any command
  install     Install service on Windows
  serve       Start server
  start       Start service on Windows
  stop        Stop service on Windows
  version     Print the version number

Flags:
      --config string   config file (default "./config.toml")
  -h, --help            help for ShadowEditor

Use "ShadowEditor [command] --help" for more information about a command.

Development Guide

  1. Download and install NodeJs, golang, MongoDB and Visual Studio Code.
  2. It is recommended to install the following VSCode extensions which may be helpful.
ESLint, Go, Shader languages support for VS Code, TOML Language Support.

npm scripts usage:

npm install:            install nodejs dependencies.
npm run build:          build the server and web client.
npm run build-server:   build only the server. (For development)
npm run build-web:      build only the web client. (For development)
npm run build-desktop:  build the desktoop version.
npm run dev:            build the web client automatically when files changes.(For development)
npm run copy:           Copy assets from web folder to build folder.
npm run start:          start the web server.
npm run set-proxy:      set golang and nodejs proxy. (In China only)
npm run unset-proxy:    unset golang and nodejs proxy.
npm run install-dev:    install golang development tools.
npm run eslint:         check js files and fix errors automatically.
npm run clean:          delete the web and desktop builds.
npm run clear:          delete useless nodejs packages.

Contributing

Expand to view details

ShadowEditor is a project for both users and developers. You can contribute and try your idea on this project. No pension, but a lot of fun. To contribute, you should:

  1. Fork the repository.
  2. Create Feat_xxx branch.
  3. Commit your code.
  4. Create Pull Request.

Note: DO NOT submit large binaries, or the Pull Request may be rejected. If required, you can add the files or directories to be ignored to the .gitignore file.

Frequently Asked Questions

Expand to view details
  1. Failed when upload models.

You need to compress the model assets into a zip file, and the entry file cannot be nested in a folder. The server will decompress and put it in the ./build/public/Upload/Model folder, and add a record in the MongoDB _Mesh collection.

  1. How to combine multiple models together?

Basic geometry supports multiple levels of nesting. You can add a group (in the geometry menu), and then drag multiple models onto the group in the Hierachy Panel.

  1. How to enable authority?

Edit config.toml and set authority.enabled to true. The default administrator username is admin and the password is 123456.

  1. The brower report asm.js has been disabled because the script debugger is connected. Please disconnect the debugger to enable asm.js. Error.

Complete error: asm.js has been disabled because the script debugger is connected. Please disconnect the debugger to enable asm.js. ammo.js (1,1) SCRIPT1028: SCRIPT1028: Expected identifier, string or number ShadowEditor.js (3948,8) SCRIPT5009: 'Shadow' is not defined.

Solution: Tencent browser does not support ammo.js (WebAssembly) compiled with Emscripten, it is recommended to use Chrome or Firebox instead.

  1. How can I upgrade from C# to golang version?

The data structure and web client is not changed, just copy ./ShadowEditor.Web/Upload/ folder to build/public/Upload/.

  1. The desktop version cannot be opened.

Windows requires Visual C++ Redistributable for Visual Studio 2015. You can install from: https://www.microsoft.com/en-us/download/details.aspx?id=48145
If the desktop version cannot be opened, you can view logs.txt; if the port conflicts, you can modify the MongoDB and website ports in resources/app/config.toml.

  1. How can I create a https certificate?

Install openssl, and git client already contains one; Open cmd, Powershell or shell, and run the following commands:

openssl genrsa -out privatekey.pem 1024
openssl req -new -key privatekey.pem -out certrequest.csr
openssl x509 -req -in certrequest.csr -signkey privatekey.pem -out certificate.pem

Among the generated files, certificate.pem is the certificate, and privatekey.pem is the key.

License

MIT License

Open Source Projects

Expand to view details

Thanks to the following open source projects.

https://github.com/golang/go
https://github.com/BurntSushi/toml
https://github.com/dgrijalva/jwt-go
https://github.com/dimfeld/httptreemux
https://github.com/inconshreveable/mousetrap
https://github.com/json-iterator/go
https://github.com/mozillazg/go-pinyin
https://github.com/otiai10/copy
https://github.com/sirupsen/logrus
https://github.com/spf13/cobra
https://github.com/spf13/viper
https://github.com/urfave/negroni
https://go.mongodb.org/mongo-driver

https://github.com/facebook/react
https://github.com/mrdoob/three.js
https://github.com/rollup/rollup
https://github.com/babel/babel
https://github.com/eslint/eslint
https://github.com/rollup/rollup-plugin-babel
https://github.com/rollup/rollup-plugin-commonjs
https://github.com/rollup/rollup-plugin-json
https://github.com/rollup/rollup-plugin-node-resolve
https://github.com/egoist/rollup-plugin-postcss
https://github.com/rollup/rollup-plugin-replace
https://github.com/mjeanroy/rollup-plugin-strip-banner
https://github.com/andyearnshaw/rollup-plugin-bundle-worker

https://github.com/tweenjs/tween.js
https://github.com/JedWatson/classnames
https://github.com/d3/d3-dispatch
https://github.com/i18next/i18next
https://github.com/js-cookie/js-cookie
https://github.com/facebook/prop-types
https://github.com/codemirror/CodeMirror
https://github.com/jquery/esprima
https://github.com/tschw/glslprep.js
https://github.com/zaach/jsonlint
https://github.com/acornjs/acorn
https://github.com/kripken/ammo.js
https://github.com/dataarts/dat.gui
https://github.com/toji/gl-matrix
https://github.com/squarefeet/ShaderParticleEngine
https://github.com/mrdoob/stats.js
https://github.com/mrdoob/texgen.js
https://github.com/yomotsu/VolumetricFire
https://github.com/jonbretman/amd-to-as6
https://github.com/chandlerprall/ThreeCSG

Frequently asked questions

Is ShadowEditor free to use?

ShadowEditor is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does ShadowEditor do?

Cross-platform 3D scene editor based on three.js, golang and mongodb for desktop and web.

What is ShadowEditor written in?

ShadowEditor is primarily written in JavaScript. Its source is publicly available at https://github.com/tengge1/ShadowEditor, and it has 1,716 GitHub stars.