Anata Documentation Tasks

• Anata Documentation Tasks
  • Summary
  • Action Items
  • Outline
  • Notes

Summary

The transcript discusses the documentation requirements for a program called Anata. It mentions the need to improve readmes and add documentation on how to add custom assets. The speaker also plans to provide links to CCO assets for use with Character Studio. The program's repository is separate from the assets, which are located in Character Assets. Installing the program involves running NPM install and then run dev. The speaker demonstrates various traits and features of Anata, such as debugging options and calling distances for different layers of clothing. They mention that exporting avatars merges everything together into one draw call but may result in heavy file sizes. The main focus is on creating comprehensive documentation, including step-by-step instructions on adding assets, generating thumbnails, and reskinning. The README needs improvement with more context, screenshots, visuals, and possibly a video tutorial on customizing assets and understanding Manifest JSON files that dictate avatar settings and available options. Additionally, there should be documentation about optimizing meshes through calling layers and their order of appearance.

Action Items

1. Improve the readmes and add documentation on how to add your own assets.
2. Provide links to CCO assets to be released with Character Studio.
3. Document the structure and organization of the program repository.
4. Document the location of assets that plug into the program.
5. Provide instructions for installing the program.
6. Document the user interface and its functionality.
7. Explain the purpose of the different traits and how to use them.
8. Document the culling layer and culling distance features.
9. Share a sample avatar to demonstrate the program's capabilities.
10. Explore ways to reduce file size and document them.
11. Provide step-by-step instructions on adding and rescanning assets.
12. Create a comprehensive README with clear instructions and visuals.
13. Improve the main repository documentation by adding more context, screenshots, and a documentation page.
14. Create a video tutorial on how to add assets, change backgrounds, and modify icons.
15. Explain how the Manifest JSON files work and their role in setting up profiles and default settings.
16. Document the available options and customization possibilities in the Manifest JSON file.
17. Clarify the concept of calling layers and provide documentation on how to optimize meshes and layering systems.

These follow-ups and action items cover a wide range of documentation and improvements needed for the program, including instructions, organization, functionality, customization options, and clarity of information.

Outline

• Chapter 1: Introduction to Documentation Requirements
  • Discussion about the need to improve readmes and add documentation on adding assets.
  • Plan to provide links to CCO assets for release with Character Studio.
• Chapter 2: Program Structure and Installation
  • Explanation of the separation between the program repository and the assets repository.
  • Description of the VRM files in the Character Assets directory.
  • Instructions for installation using NPM and running the program.
• Chapter 3: Program Features and Traits
  • Introduction to the traits and their purpose for debugging.
  • Demonstration of the calling layer and calling distance features.
  • Example of using calling distance for clothing.
• Chapter 4: Avatar Export and Optimization
  • Explanation of how avatars are exported and merged into a single atlas.
  • Mention of file size reduction methods.
  • Focus on the need for documentation on adding custom assets and reskinning.
• Chapter 5: Documentation Requirements
  • Emphasis on the need for a detailed README.
  • Request for step-by-step instructions on adding assets and generating thumbnails.
  • Mention of the importance of documentation on reskinning.
  • Desire for a visually appealing README with screenshots and visuals.
  • Additional documentation on Manifest JSON files and their role in setting up profiles.
• Chapter 6: Manifest JSON and Layering Systems
  • Explanation of the Manifest JSON file and its role in setting up profiles.
  • Discussion on available options and randomization.
  • Need for documentation on limiting options and understanding layering systems.
  • Default settings and the need for customization.
• Chapter 7: Conclusion
  • Brief summary of the tasks discussed in the transcript.

Notes

• Documentation requirements for anata:
• Improve readmes
• Add documentation on adding own assets
• Provide links to CCO assets released with Character Studio
• The program's repo is in github.com/M3-org/characterstudio, separate from Character Assets
• Character Assets contains VRM files for program layers
• Installation: NPM install and run dev
• Program interface: Clicking on traits opens a pop-up window
• Features: Calling layer and calling distance for flexibility
• Exporting avatars merges everything into a single atlas
• File size reduction methods
• Documentation needed on adding own assets and rescanning program
• Open sourcing for creating own character creation apps
• Preview of one-draw call avatar
• Focus on improving README and overall context
• Documentation on reskinning, generating thumbnails, and requirements
• Manifest JSON file for setting up profiles and default settings
• Manifest JSON defines available options and randomization
• Documentation on calling layers and optimizing meshes
• Default settings for layer order
• Task overview: improve documentation.