cocos-creator / docs-3d-deprecated

Cocos Creator 3D User Manual

NOTICE: This repository is no longer maintained because the dedicated Cocos Creator 3d engine have been fully merged into Cocos Creator mainstream version 3.0, so please submit any documentation PRs or issues to Cocos Creator docs repo.

Requirements

This documentation site is powered by GitBook.

You need Node.js and npm to be able to build the site.

To install gitbook:

npm install gitbook-cli -g

Install gulp and other modules:

npm install gulp -g

npm install

Install gitbook plugins:

gitbook install

Preview

To preview the doc, run the following command:

npm run preview
// or
npm run preview -- -o file1,file2...

The first command will build and launch web server to host the site. It will also enable live reload plugin, so your changes to the markdown source file will automatically triggers the rebuild of the docs.

The second command allows you to build the page that you assigned straightly. Please change the file1,file2... to your own file name, then execute preview command. And this command will help you rebuild the .bookignore file which can let you ignore the files that you didn't change when you rebuild the doc.

After generation finished, don't quit server process, run the following command in other terminal context:

gulp prune-left-bar

This will remove unused links from left bar.

Build

If you just want to build the markdown to html, use this command:

npm run build

You can also build the doc for ebook formats (PDF, ePub, mobi), please following this guide:

https://toolchain.gitbook.com/ebook.html

If you need to publish to the website, you'd better build it on Mac. If use Windows, some redundant .md file will also generated.

Content Editing

The markdown source of this book is in language specific folders /en and /zh. Language options are registered in the LANGS.md file.

Index

In each language folder there is an SUMMARY.md file, which contains all the pages to build and also this file serves as a sidebar navigation list. Any markdown source file that are not listed in this index will not be build.

In this index file, just write links to each markdown file in a list. Indented list is for chapters that contains expandable subs. For example:

- [Using Editor](getting-started/basics/editor-overview.md)
 - [Assets](getting-started/basics/editor-panels/assets.md)
 - [Scene](getting-started/basics/editor-panels/scene.md)
 - [Node Tree](getting-started/basics/editor-panels/node-tree.md)

Will create a toggleable chapter title Using Editor. Once clicked all its subs will show up.

Front page

index.md at each language folder is the front page of the doc.

Page content

To change the content of each page, just edit the markdown source files. There's no specific front matter format, just make sure each page has a h1 as the title.

Customize Style and Template

To customize styles, modify zh/styles/website.css and en/styles/website.css.

To change HTML templates, change the content in zh/_layouts and en/_layouts. Check out Templating Guide for gitbook.

Contribution

If you encounters any typo or content problem please report issue in this repo. Pull requests are welcome!

• Style Guide for documents

  • 中文文档书写规范

  • Contributions in English

  • markdownlint

docs-3d-deprecated's Issues

模型资源

sheji.zip

[Asset DB] Importer exec failed: {assetC:\Users\Administrator\Desktop\MoRi\assets\model\sheji.fbx}
at ImportTask.importAsset (D:\Software\cocos\resources\app.asar\node_modules@editor\asset-db\libs\task.js:1:1355)
at processTicksAndRejections (internal/process/task_queues.js:86:5)

[Asset DB] Error: FBX2glTF 进程以非 0 状态值 3221225477 退出， 意味着该进程可能未成功终止。 这通常是因为 FBX2glTF 在转换源 FBX 文件时发生了内部错误。 若允许，请向 Cocos 团队或 FBX2glTF 作者报告此错误并附上相关的 FBX 文件。进程输出:
at ChildProcess. (D:\Software\cocos\resources\app.asar\builtin\asset-db\dist\importer-3d\importers\utils\fbx2glTf.js:1:1749)
at ChildProcess.emit (events.js:194:13)
at maybeClose (internal/child_process.js:998:16)
at Process.onexit (internal/child_process.js:265:5)

RenderTexture相关接口变更未更新到文档中

URL: sprite-frame

1. creator 3D 版本： 1.2.0
2. 文档中未更新的内容：文档末尾出现的跟RenderTexture相关的接口

RenderTexture 是一个渲染纹理，它可以将摄像机上的内容直接渲染到一张纹理上而不是屏幕上。SpriteFrame 通过管理 RenderTexture 可以轻松的将 3D 相机内容显示在 UI 上。使用方法如下：

const cameraComp = this.getComponent(Camera);
const renderTexture = new RenderTexture();
const size = view.getVisibleSize();
renderTexture.reset({
   width: size.width,
   height: size.height,
   colorFormat: RenderTexture.PixelFormat.RGBA8888,
   depthStencilFormat: RenderTexture.DepthStencilFormat.DEPTH_24_STENCIL_8
});

cameraComp.targetTexture = renderTexture;
const spriteFrame = new SpriteFrame();
spriteFrame.texture = renderTexture;
const sprite = this.getComponent(Sprite);
sprite.spriteFrame = spriteFrame;

烘焙系统：Cocos网站上文档最后的参数描述表格显示不正常

URL : https://docs.cocos.com/creator3d/manual/zh/editor/lightmap/

文档最后的参数描述表格显示不正常

版本 1.1

射线检测：cocos文档中 射线的图解图片无法显示

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/physics/physics-raycast.md

Cocos文档：https://docs.cocos.com/creator3d/manual/zh/physics/physics-raycast.html
图片地址：https://docs.cocos.com/creator3d/manual/zh/physics/img/raycast.jpg
版本：1.1

注意 github文档可以正常显示图片，可能是没有复制到cocos网站上。

Translate AppClip docs to English

Translate #350 and commit to branch v1.2.1

编辑器

不能看到模型网格，不能操作模型网格，不能向UNITY一样在编辑器里一边游玩一边修改/调摄像头

节点

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/concepts/scene/node.md

是跟随，不是更随

Introduction

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/index.md

我反馈一个小问题
cocos creator 3D:

声音：[声音系统总览/平台差异性] 最后一段中”auto play police“ 拼写错误

URL 1: https://github.com/cocos-creator/docs-3D/blob/master/zh/audio-system/overview.md
URL 2: https://docs.cocos.com/creator3d/manual/zh/audio-system/overview.html#%E5%B9%B3%E5%8F%B0%E5%B7%AE%E5%BC%82%E6%80%A7

目前大部分平台都已遵守最新的 auto play police，即使设置了 playOnAwake 也会在第一次接收到用户输入时才开始播放；

English doc translation

Module	Owner	Difficulty	Caution	Translator	Status
concepts	@pandamicro	Easy		@slackmoehrle	done
assets	@VisualSJ	Normal	Links need to be checked	@slackmoehrle	done
audio-system	@YunHsiao	Easy		@zhefengzhang	done
getting-started	@gameall3d	Hard		@slackmoehrle	testing
material-system	@YunHsiao	Hard		@YunHsiao	done
particle-system	@caryliu1999	Hard	Chinese doc need review	@slackmoehrle	done?
physics	@JayceLai	Normal		@gameall3d	done
render-pipeline	@caryliu1999	Hard		Ignore	ignore
scripting	@LinYunMo	Normal		@slackmoehrle	1/2 done
tween	@JayceLai	Easy		@slackmoehrle	done
ui-system	@JoneLau	Normal	Refer to 2D, massive work	@xunyi0	done
engine/animation	@shrinktofit	Normal		@slackmoehrle	done
engine/event	@LinYunMo	ItEasy		@slackmoehrle	done
engine/renderable	@YunHsiao	Normal		@slackmoehrle	done
editor/animation	@yanOO1497	Normal		@slackmoehrle	Done but i need to review again
editor/assets	@VisualSJ	Easy		@slackmoehrle	done
editor/component	@LinYunMo	Easy		@slackmoehrle	Done
editor/console	@VisualSJ	Easy		@zhefengzhang	done
editor/engine-cu...	@LinYunMo	Easy		@xunyi0
editor/hierarchy	@arsen2010	Easy		@slackmoehrle	done
editor/inspector	@VisualSJ	Easy		@slackmoehrle	done
editor/preferences	@VisualSJ	Easy	Chinese doc need polish	@yanOO1497	done
editor/preview	@yanOO1497	Easy		@yanOO1497	done
editor/project	@VisualSJ	Easy	Chinese doc need polish	@yanOO1497	starting
editor/publish	@yanOO1497	Hard	Chinese doc need update	@xunyi0	done
editor/scene	@gameall3d	Normal		@gameall3d	Done
editor/terrain	@GengineJS	Normal		@slackmoehrle	done

关于 Animation

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/editor/animation/animation.md

mac 平台下，Ctrl+E 进入动画编辑模式，编辑器就显示有改动，然后继续按 Ctrl + E 查看版本控制，却没有任何改动，这个非常不友好。

天空盒: cocos网站 1.1 文档中[制作与应用 CubeMap] 一节的图片未显示

github 地址 : https://github.com/cocos-creator/docs-3D/blob/master/zh/concepts/scene/skybox.md
Cocos 网站文档地址： https://docs.cocos.com/creator3d/manual/zh/concepts/scene/skybox.html#%E5%88%B6%E4%BD%9C%E4%B8%8E%E5%BA%94%E7%94%A8-cubemap

图片地址：https://docs.cocos.com/creator3d/manual/zh/concepts/scene/skybox/CubeMap.jpg

粒子系统Gizmo

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/editor/scene/particle-system-gizmo.md

ShapeModule
📝 https://github.com/cocos-creator/docs-3D/blob/master/zh/editor/scene/particle-system-gizmo.md#L2

链接 ShapeModule 无效

Package 插件系统 的链接 404

custom-build-plugin.md - 扩展构建流程 - Package 插件系统 的链接 404.

缓动

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/tween/index.md

tweenUtil
📝 https://github.com/cocos-creator/docs-3D/blob/master/zh/tween/index.md#L25

tweenUtil
📝 https://github.com/cocos-creator/docs-3D/blob/master/zh/tween/index.md#L33

tweenUtil 使用时提示已经过期了

动画剪辑：[循环模式] 一节中AnimationClip.wrapMode 表格中的WrapMode.PingPng 拼写错误

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/engine/animation/animation-clip.md

Cocos 文档：https://docs.cocos.com/creator3d/manual/zh/engine/animation/animation-clip.html#%E5%BE%AA%E7%8E%AF%E6%A8%A1%E5%BC%8F

WrapMode.PingPng	从动画开头播放到结尾后，从结尾开始反向播放到开头，如此循环

参考 API文档： https://docs.cocos.com/creator3d/api/zh/enums/animation.wrapmode.html#pingpong
WrapMode.PingPng 应为 WrapMode.PingPong

摄像机Gizmo

URL : https://github.com/cocos-creator/docs-3D/blob/master/zh/editor/scene/camera-gizmo.md

摄像机介绍，链接失效。