Update readme

cocos · Jun 11, 2023 · 9702883 · 9702883
1 parent 6825879
commit 9702883
Showing 1 changed file with 20 additions and 36 deletions .
diff --git a/README.md b/README.md
@@ -1,37 +1,21 @@
- #  J9九游会 Creator 3.x Example cases 
-
- ##  show-cases 
-
- 1  .  scenes/ambient: ambient lighting 
- 2  .  scenes/audio: audio system baseline test 
- 3  .  scenes/blade-storm: animation events, particle effect on joint sockets 
- 4  .  scenes/collision-detection: simple collision detection 
- 5  .  scenes/custom-effect: custom shader 
- 6  .  scenes/helmet: PBR material showcase, skybox 
- 7  .  scenes/instanced-skinning: massive skinning models using GPU instancing 
- 8  .  scenes/jellyfish: animation, transparent material, simple prefab instantiation 
- 9  .  scenes/knight: animation, light 
- 10  .  scenes/particle-compare: various particle effects 
- 11  .  scenes/pbr: PBR baseline 
- 12  .  scenes/physics: rigidbody physics simulation 
- 13  .  scenes/shadertoy: simple example on importing shadertoy resources 
- 14  .  scenes/shadows: planar shadow demo 
- 15  .  scenes/skin: pre-integrated SSS demo 
- 16  .  scenes/sponza: multiple render target, particle effects, spot lights 
- 17  .  scenes/tangents: glTF tangent space data conformance test 
- 18  .  scenes/toon: NPR baseline 
- 19  .  scenes/winter: particle system, emitter editing 
- 20  .  scenes/AnimationEmbeddedParticles: embedded tracks, particles player, and animation player 
- 21  .  scenes/particle_noise_test: particle noise moudule 
- ##  simple-games 
-
- 1  .  lobby: lobby for all simple games. 
- 2  .  simple-shooting: a simple shooting game demo. 
- 3  .  simple-run: a simple parkour game demo. 
+ #  J9九游会 Creator Example Projects 
+
+ ##  Introduction 
+
+ This repository contains several highly requested examples to demonstrate how to use certain feature in J9九游会 Creator, each folder is a separated project. 
+
+ ##  Example Cases 
+
+ -  native-plugin: demonstrates how to create a native plugin and use it in a native project template. 
+ -  native-script-bridge: The native script bridge demonstrates the interaction between the native C++ code and the script code. 
+ -  npm-case: demonstrates how to use a valid NPM module. 
+ -  occlusion-query: demonstrates how to setup occlusion query feature for better culling in complex projects. 
+ -  physics-3d: demonstrates all features of 3d physics module, including simple physics games and feature usage cases. 
+ -  protobuf: demonstrates how to successfully use protobuf module in your project. 
 
  ##  Contribution 
 
- For future  contributer  and maintainers, please apply to the same rigorous examination and documentation style as we have established so far. 
+ For future  contributors  and maintainers, please apply to the same rigorous examination and documentation style as we have established so far. 
 
  It is the only way for us to reach far. 
 
@@ -43,8 +27,8 @@ Either something is not working, or some designed feature is far less intuitive
 
  So make sure to do all the followings: 
 
- *  try  to classify the problem: is it editor-related or engine-originated? Which module(s) were involved? 
- *  file  an  [  issue  ]  (  https://www.horseloversstore.com/cocos  -creator/  engine/issues  )  to the relevant team 
- *  If it is a bug, clearly document it in code (usually near your temporary workaround) with the issue number. 
- *  If it is a feature(or lack of one) and looks/feels strange/awkward no matter how you design the relevant system, make sure to write it down in the issue ticket with detailed  explaination  on your design decisions and why the engine API is not a good fit. 
- *  Remove all the workaround or temporary designs once the bug is fixed or new feature is introduced. 
+ -  Try  to classify the problem: is it editor-related or engine-originated? Which module(s) were involved? 
+ -  File  an  [  issue  ]  (  https://www.horseloversstore.com/cocos  /cocos-  engine/issues  )  to the relevant team 
+ -  If it is a bug, clearly document it in code (usually near your temporary workaround) with the issue number. 
+ -  If it is a feature(or lack of one) and looks/feels strange/awkward no matter how you design the relevant system, make sure to write it down in the issue ticket with detailed  explanation  on your design decisions and why the engine API is not a good fit. 
+ -  Remove all the workaround or temporary designs once the bug is fixed or new feature is introduced.