# OpenZIEditor
**Repository Path**: openziproject/OpenZIEditor
## Basic Information
- **Project Name**: OpenZIEditor
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: 5.0
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 6
- **Forks**: 3
- **Created**: 2024-03-11
- **Last Updated**: 2025-03-10
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# OpenZIEditor
**Language: [English](README.en.md), [Chinese](README.md)**
### Project introduction
**"OPENZI" series products, including the various functional platform frameworks needed to build digital twins, is also the best implementation verification scheme created in the experience and projects of digital twins and visualization applications. Provide digital twin business application general interface functions, digital twin editing, project configuration and release functions, self-developed stable cloud rendering related technology comprehensive industry solutions, to help customers build their own digital twin application platform. **
**OpenZIEditor is industry editing software of "OpenZI"，cross OpenZIAPI to finish API functional additive to Editor，Complete separation of industry function and platform technology。**
**OpenZIEditor's main features include asset library building tools to build business-relevant assets for next generation rendering; Digital twin object construction tool, according to the business to build digital twin industry scene; Scenario building tools, adding industry resources and building industry scenarios; Interface access and export tools, according to the business needs of the industry functional interface; 3D data visualization tools, display tools through reports or 3D visual interfaces as needed; BIM data application display: Directly access and display BIM data related content. Project configuration and release tool, project creation and release through the industry engine.**
### Install
* Pull the main repository, `5.0`stands for Unreal Engine version branch, you can select the branch you need from the branch list
```
Git clone - b 5.0 https://gitee.com/openziproject/OpenZIEditor.git
```
* Then initialize and update dependent submodules
Right-click a blank area in Explorer
Type `./gitupdate.bat` and press Enter
In the current project directory, install the node dependency package and run the following command in the terminal command line window
```
npm install typescript -g
npm install
```
### Run
* Right-click `.uproject `to execute`Generate Visual Studio project files`to generate `.sln `project project and compile C++ code(`VS2019 is recommended`)
* Click the button to generate the project's `.d.ts`declaration file
* Enter cmd in the address bar of the project, and then enter
* In the popped-up command line window, type 'tsc' and press Enter to start compiling TypeScript code into JavaScript.
* When you're done, go back to the Unreal Engine Editor and click the `Play`button to run
> **Important:** It is recommended to run in `New Editor Window` and `Standalone Game` mode, followed by `Selected Viewport` (in-product editor and Unreal Editor shortcuts conflict, so in-product shortcuts are disabled). Do not use other modes to play, it may cause a series of unpredictable problems
### Run with cloud render mode
For details, please view the ` Plugins/OpenZIAPI/Documents/CloudRender/README.en.md `
### Pack
For details, please view the ` Build/BatchFiles/README.en.md `
### System functions
**OpenZIAPI function list**
- Terrain loading
- Image loading
- 3DTileset Load load
- Customize the web page
- Modify the scene coordinate system
- Manage UE scene levels
- Management controller (custom, editor, observer)
- Axis management (translation, rotation, scaling, etc.)
- Weather regulation (climate, time, clouds, fog, etc.)
- Plotting system (points, lines, surfaces)
- Dot (custom style)
- Alarm/warning point
- Planting (single, line, brush)
- Geofencing
- 3D stack
- Arrow line
- Light flow line
- OD Cable
- Measuring system (point, line, surface)
- Console instruction
- Camera Roam
- Visual field analysis
- The skyline
- Thermal map
- Numerical bar chart
- Single value bar chart
- Thermal line
**OpenZIEditor function list**
- resource library tool User-defined resource types
- broswer open source version
- model asset input fbx、datasmith
- resource library build tool
- The digital twin resource type create
- The prefab twin resource type create
- scene editor tool
- Material creation and management, custom material addition
- Basic 3D Engine Component panel
- Scripting editor panel create
- API add on，support API function show on panel without coding
**OpenZI plugin function list**
- OpenZIWebSocket
- OpenZISKY
- OpenZIModelTool
- OpenZIPackAssetLibrary
- OpenZIMaterialSystem
- OpenZIAPIExtend
- OpenZIWebBroswer(inside OpenZIAPI)
### Technical lines
Related technologies: UnrealEngine,Puerts，CesiumForUnreal (Please follow the relevant product-related agreement rules)
Development tools: WebStorm，Visual Studio Code，VisualStudio
### Project directory
```shell
├─Binaries\
├─Build\
│ ├─BatchFiles [BatchFiles](Build/BatchFiles/README.md)\
├─Content\
│ ├─JavaScript\
│ │ ├─Scripts`Output directory of JS scripts compiled by TS `\
├─DerivedDataCache\
├─Documents\
│ └─ApiDoc `automatic output directory for documents`\
├─Intermediate\
├─node_modules`node dependency module `\
├─Packages`home directory for all packaged files`\
│ ├─Assets`Resource Library Package Output directory` \
│ ├─Linux `Linux Platform packaging Output Directory`\
│ ├─Windows`Windows Platform Packaging Output Directory `\
├─Plugins`Unreal Project Project Plugin Folder `\
├─ProjectLab \
│ └─DefaultProject [DefaultProject](ProjectLab/README.md)\
├─Projects`general directory of cproject projects created in the editor `\
├─TSProject\
│ ├─APITsBase [APITsBase](TSProject/APITsBase/README.md)\
│ ├─DeveloperTools [DeveloperTools](TSProject/DeveloperTools/README.md)\
│ └─EditorTS [EditorTS](TSProject/EditorTS/README.md)
```
### Commercial license
**This note relates to your rights and obligations with respect to the use of the OpenZIAPI, OpenZIEditor source code, programs, plug-ins and documentation of the product family of Chengdu Zengzi Technology Co., LTD.**
**1, this product USES the Epic related technology, please visit https://www.epicgames.com/privacypolicy and refer to the privacy policy of the Epic (it is also suitable for you) to use the software, in order to understand the specific practices. You use the software situation is bound by the terms of service of Epic, these terms and conditions at https://www.epicgames.com/tos. By downloading or using the software, you also agree to Epic's Terms of Service and acknowledge that you have read Epic's Privacy Policy.**
**2, OpenZIAPI and OpenZIEditor open source versions are based on the use of Apache2.0 protocol for open source. By downloading or using the software, or otherwise indicating your acceptance of this Agreement, you agree to be bound by the terms of the Apache2.0 Agreement for the open source version (source code, programs, plug-ins, and documentation) of the Company. If you do not or cannot agree to the terms of this Agreement, please do not download or use the Software.**
### Contribute code
**JJCoder、xLin、goderyu、behiever**
### Other
**1. Intellectual property: OpenZIAPI and OpenZIEditor are open source with Apache2.0. In commercial use, it is necessary to mark "adopting" OpenZI digitalization software related technologies.**
**2, welcome business cooperation and project cooperation, joint promotion and investment negotiation contact information refer to the official website [OpenZI Website](http://www.cengzi.com)**