archive-gh-me/ShadowEditor
1
0
Fork 0
mirror of https://github.com/tengge1/ShadowEditor.git synced 2026-01-18 15:02:09 +00:00
Code Issues Projects Releases Wiki Activity
ShadowEditor/README.md
tengge d416226d72 update readme
2020-05-17 19:26:47 +08:00

8.0 KiB
Raw Blame History

Shadow Editor

English / 中文

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

image

v0.5.2 is Coming Soon

  1. MongoDB user and password configuration.
  2. Documentation changed from gitbook to gitee wiki.

v0.5.1 has Released

  • Release Date: May 17, 2020
  • Update Logs:
  1. Fix a bug that an error occurs when the scene plays which contains a smoke comopnent.
  2. Fix the bug of renderer size error. (It causes smoke shrink when the scene plays which contains a smoke component)
  3. Fix the bug of water component error, due to the upgrade of three.js.
  4. Fix a bug that the category filter on the assets panel lists all the categories on Ubuntu.
  5. Fix bugs of listing fonts, uploading fonts and creating 3D text.
  6. Fix the bug of backing up mongodb.
  7. Update Windows build guide. See Detail
  8. Install as Windows service. See Detail
  9. When the ports conflict or config.toml is missing, the program will not crash immediately.
  10. Install as Ubuntu service. See Detail
  11. Fix the total num of assets displayed incorrectly when authority is enabled.
  12. Fix the bug of saving config.
  13. Fix the bug of exporting examples.
  14. Fix the bug of the wrong area of point marker when selected.

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+
  5. make 4.2.1+ (Linux only)

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

If you need a C# version, you can checkout the v0.4.6-csharp branch which is no longer maintained. Click to see the install guide.

git checkout -b csharp origin/v0.4.6-csharp

Build on Ubuntu

  1. If you are in China, run make proxy to set golang and nodejs proxy.
  2. Run make to build the server and web.
  3. Edit build/config.toml, and modify the database host and port.
  4. Run make run to launch the server. You can now visit: http://localhost:2020.

Build on Windows

  1. If you are in China, double click set_proxy.bat in the scripts folder.
  2. Double click build.bat in the scripts folder.
  3. Edit config.toml in the build folder, and modify the database host and port.
  4. Double click ShadowEditor.exe in the build folder. You can now visit: http://localhost:2020.

Install as Ubuntu Service

  1. Edit ./scripts/service_linux/shadoweditor.service, set the right path.
  2. Run make service to install service.
  3. Run sudo systemctl start shadoweditor to start service.
  4. Run sudo systemctl enable shadoweditor to auto start service.

Install as Windows Service

  1. Run install.bat in the scripts/service_win folder as administrator.
  2. Edit service.reg in the scripts/service_win folder, set AppDirectory to the absolute path of the build folder.
  3. Double click service.reg in the scripts/service_win folder.
  4. Open Windows Services Manager, start ShadowEditor service.

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.

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

License

MIT License

Related Links