diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..a001be5 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,41 @@ + +GameEngine and Editor +by John Ryland +Copyright (c) 2023 + +Binary format to describe data structures + + +Can convert from XML to binary +Can convert from binary to XML + +Can edit data in the given format using description data + + +this data is to form the Component types + + +A Component Type is a description of the layout of a fixed sized block of data + +A Component instance is a fixed sized block of plain data associated with an entity + +A level is a list of Entities, Component Types, Components and assets + +Assets are typically files that contain data, such as mesh data, texture data, audio data. + + + +A level will have an asset table that can map asset names to ids. + +The level can then be baked where all the assets the level uses are combined in to a single file +and the components can refer to the assets by id instead of name. + + +The level will also contain the binary/xml of the component type descriptions. + +There will be both the editable level, and the baked level. The editable level will contain multiple files in a directory. +The baked level will be a single file. + + + +