Shadow Editor

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

Name: Shadow Editor
Version: v0.5.7 (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, nodejs, electron, WebWorldWind.
If helpful to you, please DOnate to support us. thank you!

v0.5.7 is Coming Soon

3D GIS. (In development)

v0.5.6 has Released

Release Date: July 26, 2020
Update Logs:

3D GIS. (In development)
The v0.4.6-csharp branch will be deleted on August 1.
Fix the bug that it says "Only jpg, png, mp4 file is allowed to upload!" when uploading a mesh after uploading an image.
Fix the bug that it says "Only zip file is allowed!" when uploading an image after uploading a mesh.
The check box in front of the texture property is changed to enable and disable the texture, and add a delete button after the texture.

Feature List

Requirements

MongoDB v3.6.8+
Chrome 81.0+ or Firefox 75.0+

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

Golang 1.14.2+
NodeJS 14.1+
gcc 9.3.0+ (tdm-gcc, MinGW-w64 or MinGW on Windows, and make sure gcc can be accessed through the command line)
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:

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

Desktop Version:

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

Install as Windows Service

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

Install as Ubuntu Service

Edit ./scripts/service_linux/shadoweditor.service, set the right path.
Run sudo cp ./scripts/service_linux/shadoweditor.service /etc/systemd/system/.
Run sudo systemctl daemon-reload to reload the service daemon.
Run sudo systemctl start shadoweditor to start service.
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

Download and install NodeJs, golang, MongoDB and Visual Studio Code.
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 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 you idea on this project. No pension, but a lot of fun. To contribute, you should:

Fork the repository.
Create Feat_xxx branch.
Commit your code.
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

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.

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.

How to enable authority?

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

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.

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

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.

License

MIT License

Open Source Projects

Thanks to the following open source projects.

Expand to view details

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/NASAWorldWind/WebWorldWind
https://github.com/jonbretman/amd-to-as6

geektcp/ShadowEditor

Shadow Editor

v0.5.7 is Coming Soon

v0.5.6 has Released

Feature List

Requirements

Download and Compile

Build on both Windows and Ubuntu

Install as Windows Service

Install as Ubuntu Service

Command Line Usage

Development Guide

Contributing

Frequently Asked Questions

License

Open Source Projects