Shadow Editor

English / 中文    |    Windows Desktop    |    Ubuntu Desktop    |    Web Demo

• Name: Shadow Editor
• Version: v0.6.0 (Coming Soon)
• Description: Cross-platform 3D scene editor based on three.js, golang and mongodb.
• Source: GitHub Gitee | Document: Gitee | Demo: GitHub Gitee | 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!

v0.6.0 is Coming Soon

v0.5.10 has Released

• Release Date: October 17, 2020
• Update Logs:

1. Remove all GIS related features, and no longer provide GIS in the open source version in the future.

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, binary, 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
    • Bullet physics engine
    • Ray tracing rendering, voxel rendering
    • UV unwrap
    • Automatic pathfinding
    • Batch rendering
    • Occlusion culling
    • Split screen display
• Data visualization
  • UI
    • Panel, tab panel
    • Button, radio, checkbox, dropdown, slider
    • Data table
  • Charts
    • Histogram
    • Pie chart
    • Line chart
  • Visualization config
    • Layout management
    • data source config
  • Real-time data
    • WebSocket
    • Ajax

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 run start to launch the server. You can now visit: http://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

Frequently Asked Questions

License

MIT License

Open Source Projects