Cocos2d-x Docs Checklist (What work is done and what needs to be done)

[minggo]

Cocos2d-x Documentation

Getting Started

英文	中文	Doc
[x]	[x]	About Cocos2d-x
[x]	[x]	Why Cocos2d-x
[x]	[x]	About
[x]	[x]	How to learn zh/To Do 补充
[x]	[x]	Where to get help
[x]	[x]	How to contribute

Basic Cocos2d-x Concepts

英文	中文	Doc
[x]	[x]	Main Components
[x]	[x]	Director
[x]	[x]	Scenes and the Scene Graph
[x]	[x]	Sprites
[x]	[x]	Actions
[x]	[x]	Sequences and Spawns
[x]	[x]	Parent Child Relationship
[x]	[x]	Logging

Sprites

英文	中文	Doc
[x]	[x]	What are Sprites
[x]	[x]	Creating Sprites
[x]	[x]	Using Sprites
[x]	[x]	SpriteFrame Cache
[x]	[x]	Sprite Manipulation
[x]	[x]	Polygon Sprite

Actions

英文	中文	Doc
[x]	[x]	What are Actions
[x]	[x]	Basic Actions
[x]	[x]	Sequences
[x]	[x]	Sequence Internals

Building and Transitioning Scenes

英文	中文	Doc
[x]	[x]	What is a Scene
[x]	[x]	Creating a Scene
[x]	[x]	Transitioning from Scene to Scene

UI Components

英文	中文	Doc
[x]	[x]	Widgets, oh, my!
[x]	[x]	Label
[x]	[x]	Menu
[x]	[x]	Buttons
[x]	[x]	Checkbox
[x]	[x]	Loading Bar
[x]	[x]	Slider
[x]	[x]	TextField

Other Node Types

英文	中文	Doc
[x]	[x]	More than just a Node
[x]	[x]	TileMap
[x]	[x]	Particle System
[x]	[x]	Parallax

Event Dispatcher

英文	中文	Doc
[x]	[x]	What is the EventDispatch mechanism
[x]	[x]	5 types of event listeners
[x]	[x]	FixedPriority vs SceneGraphPriority
[x]	[x]	Touch Events
[x]	[x]	Keyboard Events
[x]	[x]	Accelerometer Events
[x]	[x]	Mouse Events
[x]	[x]	Creating Custom Events
[x]	[x]	Registering Events with the Dispatcher

3D

英文	中文	Doc
[x]	[x]	Terminology
[x]	[x]	Sprite3D
[x]	[x]	Animation
[x]	[x]	Camera
[x]	[x]	Cubemap Texture
[x]	[x]	Skybox
[x]	[x]	Lighting
[x]	[x]	Terrain
[x]	[x]	Tools for creating 3D Sprites
[x]	[x]	Advanced 3D Topics

Scripting

英文	中文	Doc
[x]	[x]	Script component

Physics

英文	中文	Doc
[x]	[x]	Physics is scary, do I really need it?
[x]	[x]	Physics terminology and concepts
[x]	[x]	Collision
[x]	[x]	Queries
[x]	[x]	Debugging/Disabling

Audio

英文	中文	Doc
[x]	[x]	Getting Started]
[x]	[x]	Play background music and sounds]
[x]	[x]	Audio operations
[x]	[x]	Advanced Audio
[in-progress]	[in-progress]	SimpleAudio Engine vs Audio Engine

Advanced Topics

英文	中文	Doc
[x]	[x]	File System Access
[x]	[x]	Networking with HTTP
[x]	[x]	Shaders and Materials
[x]	[x]	Optimizing Graphics
[in-progress]	[in-progress]	SQLite
[in-progress]	[in-progress]	Multi-Resolution

VR (virtual reality)

英文	中文	Doc
[x]	[deprecated]	Getting Started

Installations

英文	中文	Doc
[x]	[x]	Prerequisites
[x]	[x]	Android - command-line
[x]	[deprecated]	Android - Visual Studio
[x]	[x]	Android - Studio
[x]	[x]	Android - Eclipse
[x]	[x]	IOS
[x]	[x]	Mac OS X
[x]	[x]]	Linux
[x]	[deprecated]	Tizen
[x]	[x]	Windows
[x]	[deprecated]	Windows Phone

Tools

英文	中文	Doc
[x]	[x]	Cocos Command-Line tool
[x]	[deprecated]	Cocos GUI
[x]	[x]	Pre-built libraries
[x]	[x]	Creator to Cocos2d-x

[slackmoehrle]

@minggo I tried to make a format that allows us to see both English and Chinese progress but I could not get the to-do functionality to work inside a table. Would you like me to re-do this?

[minggo]

but I could not get the to-do functionality to work inside a table. Would you like me to re-do this?

what does it mean?

[slackmoehrle]

it means I could not make check boxes like you had to just check off when complete.

[minggo]

Oh, not problem, this format works too.

[slackmoehrle]

for installation docs, I need to test 3.16 and install instructions on platforms right, just in case? OS X, Linux, Windows, etc? @drelaptop says he has tested Android already. 对不对？

[minggo]

I think these sections are not needed:

• VR: we don't maintain it now, not device to test too
• Tizen, Windows Phone: they are not supported now

[slackmoehrle]

Can we keep them and mark them deprecated? Just in case someone still uses them? We can mark the docs as 3.15 only?

[minggo]

yep, mark them as deprecated is a good idea, and Android - Eclipse should be deprecated too.

[slackmoehrle]

知道了

[minggo]

Tizen and Windows Phone are not supported in v3.16 too

[slackmoehrle]

yup. I will mark deprecated and only for v3.15 as last supported version for Tizen, Windows Phone and Eclipse.

[drelaptop]

@slackmoehrle For installation docs I have tested on Android Studio 2.3.3 , Visual Studio 2015, IOS on Xcode8.3.3, macOS on XCode8.3.3, cpp-tests project works well. can you tested it on Linux and Android-Command Line Tool ？

[slackmoehrle]

Priorities:

• [x] Creator To Cocos2d-x
• [ ] SQLite
• [ ] Multi-resolution
• [ ] Audio Engine
• [ ] Prebuilts
• [x] Test installation -> modify install docs as needed
  • [x] Windows 7
  • [x] Windows 10 32 bit
  • [x] Linux
  • [x] OS X/iOS
  • [x] Android command-line
• [x] create a good looking index page

[drelaptop]

3 Chapters be left for translation works

[drelaptop]

Now, the Chinese docs keep the same [in-progress] with English docs except [deprecated] contents. @minggo

[minggo]

@drelaptop thanks. @slackmoehrle when will you finish the 3 docs? I will deploy it to Chinese forum when they are ready.

[slackmoehrle]

I have 4 docs to complete. I updated the list above. I am busy for a few days this week, but I will try and work on them.