4dstudio-localserver 中文文档教程
4dstudio-localserver
这实现了 4dstudio 的本地服务器，由 DAQRI。 它为 4dstudio 提供附加功能，例如本机编辑器。
本机编辑器允许您使用本机编辑脚本 编辑器（例如 sublime text）。 它可能比在浏览器中编辑更舒服。 它旨在为高级用户提供支持，并且必须在用户计算机上运行。 请注意，它是可选的，并不是使用 4dStudio 所必需的。
这是操作中的本机编辑器功能。
Getting Started
照常发布在 npm 上。 所以你首先安装它
$ npm install -g 4dstudio-localserver
然后通过启动它
$ 4dstudio-localserver
来调整你自己的编辑器，你需要有一个阻塞命令行来启动它。 通过 EDITOR_4DSTUDIO 环境变量将其传递给服务器。
- For atom, use
export $EDITOR_4DSTUDIO='atom --wait'. - For sublime text, use
export $EDITOR_4DSTUDIO='subl --wait --new-window'
你可以自由地为你喜欢的编辑器定义它。
How to install from git
您只需将存储库克隆到
git clone https://github.com/DAQRI/4dstudio-localserver.git
目录中，然后在您的计算机上启动服务器
npm start
Internal Workflow
这是 4dstudio 在 4dstudio-localserver 中使用本机编辑器时遵循的步骤
- User click on 'native editor' button above the js editor in 4dstudio
- 4dstudio webpage get the content of the codemirror content via javascript
- 4dstudio contacts the local server with this content from codemirror, and a fake basename.
- This basename will be used to create a temporary file, which will be passed to the editor itself.
- Thus the user get a expected name (e.g. script.js)
- Based on the file extensions, the editor will provide contextual help, code colorisation, autocompletion etc…
- When the text is saved, the local server get the content of the provided files, and reply that to 4dstudio
- On reception of the new content, 4dstudio update the proper codemirror instance with the new content
Implementation Details
- the server will bind the port 5000 on 127.0.0.1
- it is implemented as a express server in node.js
4dstudio-localserver
This implements the local server for 4dstudio by DAQRI. It provide additional features to 4dstudio such as native editor.
Native editor allow you to edit scripts with a native editor (e.g. sublime text). It is likely more confortable than editing within the browser. It is intended to power user and has to be run on the user computer. Please note that it is optional and not at all required to use 4dStudio.
here is native editor feature in actions.
Getting Started
It is published on npm as usual. So you first install it
$ npm install -g 4dstudio-localserver
And then launch it via
$ 4dstudio-localserver
To tune your own editor, you need to have a blocking command line to launch it. Pass it to the server via EDITOR_4DSTUDIO environment variables.
- For atom, use
export $EDITOR_4DSTUDIO='atom --wait'. - For sublime text, use
export $EDITOR_4DSTUDIO='subl --wait --new-window'
You are free to define it for the editor you like.
How to install from git
You simply clone the repository
git clone https://github.com/DAQRI/4dstudio-localserver.git
Go in the directory, and start the server on your computer with
npm start
Internal Workflow
Here are the step followed when 4dstudio is using native editor in 4dstudio-localserver
- User click on 'native editor' button above the js editor in 4dstudio
- 4dstudio webpage get the content of the codemirror content via javascript
- 4dstudio contacts the local server with this content from codemirror, and a fake basename.
- This basename will be used to create a temporary file, which will be passed to the editor itself.
- Thus the user get a expected name (e.g. script.js)
- Based on the file extensions, the editor will provide contextual help, code colorisation, autocompletion etc…
- When the text is saved, the local server get the content of the provided files, and reply that to 4dstudio
- On reception of the new content, 4dstudio update the proper codemirror instance with the new content
Implementation Details
- the server will bind the port 5000 on 127.0.0.1
- it is implemented as a express server in node.js
