Shadow Editor

English / 中文    |
   <a href="https://github.com/tengge1/ShadowEditor/releases/download/v0.6.0/ShadowEditorServer-win32-x64.zip" title="Requires `Visual C++ Redistributable for Visual Studio 2015`">
Windows Server</a>    |
   <a href="https://github.com/tengge1/ShadowEditor/releases/download/v0.6.0/ShadowEditorServer-linux-x64.zip">
Ubuntu Server</a>    |    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.

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.

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

v0.6.0 has Released

Release Date: July 24, 2021
Update Logs:

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

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.

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

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

bash
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 start to launch the server. You can now visit: http://localhost:2020.
If you enable https in the config file. Please visit: https://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 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

<details> <summary>Expand to view details</summary>

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:

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.

</details>

Frequently Asked Questions

<details> <summary>Expand to view details</summary>

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.

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:

sh
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