resources Documentation

resources provides a suite of tools to manage/manipulate and deliver resources for Carbon titles.

See Installation section for further installation information.

Key term cheatsheet

Term	Description
Resource Group	A text data file which contains information regarding a group of resources.
Bundle Resource Group	An extended Resource Group containing extra information related to bundling.
Patch Resource Group	An extended Resource Group containing extra information related to patching.
Bundle	A collection of resources split into binary chunks and accompanied with a Bundle Resource Group containing related meta data.
Chunk	A single binary file made up of split resources. Many chunks together make a bundle.
Patch	A collection of patch binaries and accompanied with a Patch Resource Group containing related meta data.

Contents

• Installation
  • Building
• Tools
  • resources library API
  • resources CLI
• Overview Documents
  • Patching Process Overview
• QuickStart
  • Example Patch Creation Procedure
• Guides
  • How To Create A Resource Group
  • How To Create A Bundle
  • How To Create A Patch
  • How To Apply A Patch
  • How To Unpack A Bundle
• Design Documents
  • Filesystem Design - Local/Remote
  • Resource Group File Format

Note

This project is under active development.