Shadow Editor

English / 中文

• Name: Shadow Editor
• Version: v0.5.4(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
• Technology Stack: html, css, javascript, rollup, react.js, webgl, three.js, golang, mongodb.
• If helpful to you, please DOnate to support us. thank you!

v0.5.4 is Coming Soon

1. Create Windows desktop application with Electron, Click to see detail.

Download URL: https://github.com/tengge1/ShadowEditor/releases/download/v0.5.3/ShadowEditor-win32-x64.zip

Note: MongoDB requires Visual C++ Redistributable for Visual Studio 2015. If it's not working, install from: https://www.microsoft.com/en-us/download/details.aspx?id=48145

2. Using command line to install and start ShadowEditor service on Windows.

.\ShadowEditor install: install service on Windows.
.\ShadowEditor remove: remove service on Windows.
.\ShadowEditor start: start service on Windows.
.\ShadowEditor stop: stop service on Windows.

You can also manage this service in the Windows Services Manager.

3. Use nodejs to rewrite the scripts, and you can now use npm to manage this project.

v0.5.3 has Released

• Release Date: June 14, 2020
• Update Logs:

1. Fix bugs of uploading models and publishing scenes on windows.
2. Add links to open source projects.
3. THREE.js math module has translated into golang, Click for detail.
4. Use Travis CI as a continuous integration tool.
5. Comment out ServiceWorker in the index.html file because it caused a lot of trouble.

Features

1. Cross-platform: Windows, Linux, Mac; and supports desktop and web versions.
2. It supports many 3D formats: 3ds, 3mf, amf, assimp(anim), awd, babylon, binary, bvh(anim), collada, ctm, draco , fbx(anim), gcode, gltf(gltf and glb, anim), js(anim), kmz, lmesh(anim), md2, mmd(pmd and pmx, anim), nrrd, obj, pcd, pdb, ply, prwm, sea3d(anim), stl, vrm, vrml, vtk, X. (anim) means it supports animation.
3. 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.
4. Built-in lights: ambient light, directional light, point light, spotlight, hemispherical light, rect area light.
5. Built-in components: background music, particle emitter, sky, fire, water, smoke, cloth, berlin terrain, sky sphere.
6. Support materials: LineBasicMaterial, LineDashedMaterial, MeshBasicMaterial, MeshDepthMaterial, MeshNormalMaterial, MeshLambertMaterial, MeshPhongMaterial, PointsMaterial, MeshStandardMaterial, MeshPhysicalMaterial, SpriteMaterial, ShaderMaterial, RawShaderMaterial.
7. Edit javascript, shader program and json with intelligence.
8. Live player can play animations in the scene.
9. Exporting gltf, obj, ply, stl, Collada, DRACO models.
10. Publish scene as static resources, and can be embedded in iframe.
11. Support languages: English, 中文, 繁體中文, 日本語, 한국어, русский, Le français.
12. Scene version management: supporting history and logs, undo and redo, auto saving.
13. Authority management: organization, user, role, authority, registration, login, and password modification.
14. Resource management: scene, mesh, texture, material, audio, animation, screenshot, video, typeface.

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

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.

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.

Create Windows Desktop Application

Click to see how to create a Windows desktop application with Electron.

Command Line Usage

PS E:\github\ShadowEditor\server> .\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.

Contributing

ShadowEditor is a project for both users and developers. You can contribute and try you 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

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.

2. 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.

3. How to enable authority?

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

4. 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.

5. 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/.

License

MIT License

Open Source Projects

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/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