New OMR File Spec
2011-08-08, 18:26 (This post was last modified: 2011-08-19, 13:51 by Orion Pobursky.)
2011-08-08, 18:26 (This post was last modified: 2011-08-19, 13:51 by Orion Pobursky.)
Here's the first draft. Discuss!!
----
The Offical Model Repository Specification
Version: 0.1 (will turn 1.0.0 upon ratification by the LSC)
Author: Orion Pobursky
Purpose:
--------
The Official Model Repository (OMR) is a database of file in the LDraw File Format describing models that are released as sets by Lego®. For consistency between models and ease of indexing by software, a standard for the file headers, names, and hierarchy in the OMR is needed. This document will outline the extra requirements (in addition to those set forth in the current LDraw File Format specification) for a model to be included in the OMR
Base Requirements:
------------------
All files in the model will conform to the current LDraw File Format
Base File Naming:
-----------------
Each model in the OMR will consist of several files that are packaged together into a single MPD file. For sets that include instructions for multiple models, each model will have its own MPD file. Each MPD for the set will be named in the following manner:
<Set Number>(<Optional Specifier>)-[main or alt<Number>]
Where:
<Set Number>: the number assigned on the container of the set
<Optional Specifier>: Sometimes different set with the same number are released, the specifier will be a single digit number, in parentheses, that is different between different sets, to distinguish these sets from one another.
[main or alt<Number>]: The main model of the instructions (i.e. the model featured on the cover of the container) will have the word "main". For sets that feature more than one model on the front of the container (e.g. the Creator line), the largest or most prominent model is the main model. For alternate models that are detailed in instructions, the word "alt" and a single digit number starting at 1 will be used. For playsets or other sets where there are multiple models that are part of an integral whole, all of the submodels will be contained in the main model MPD.
Example:
Set 4896 - Roaring Roadsters. This creator set has 3 models in the instructions. The roadster is featured prominently on the box. 4896 is the only set with that number. Therefore:
Roadster MPD: 4896-main.mpd
Dragster MPD: 4896-alt1.mpd
etc...
MPD File Structure:
-------------------
The MPD will conform to the MPD File Specification.
The individual files inside the MPD shall be named using the following convention:
<MPD Filename>-1.ldr - First model in main instructions
<MPD Filename>-1a.ldr - First submodel of first model
<MPD Filename>-1aa.ldr - First component of first submodel of first model
<MPD Filename>-1ab.ldr - Second component of first submodel of first model
<MPD Filename>-2.ldr - Second model of main instructions
<MPD Filename>-mf-<Number>.ldr - Minifig, numbered in order of its appearance in the instructions.
To use further levels of submodels, continue adding on letters to the appropriate depth.
The only unofficial parts allowed to be referenced in the model files are those currently residing on the LDraw.org Parts Tracker. No part files shall be contained in the MPD.
File Headers:
-------------
Each individual model file in the MPD must have a standard header format.
Standard Header:
0 FILE <Filename>.ldr
0 <Lego Set Number> <Lego Set Name>
0 Name: <Filename>.ldr
0 Author: <Author Name>
0 LDraw.org Official Model Repository
----
The Offical Model Repository Specification
Version: 0.1 (will turn 1.0.0 upon ratification by the LSC)
Author: Orion Pobursky
Purpose:
--------
The Official Model Repository (OMR) is a database of file in the LDraw File Format describing models that are released as sets by Lego®. For consistency between models and ease of indexing by software, a standard for the file headers, names, and hierarchy in the OMR is needed. This document will outline the extra requirements (in addition to those set forth in the current LDraw File Format specification) for a model to be included in the OMR
Base Requirements:
------------------
All files in the model will conform to the current LDraw File Format
Base File Naming:
-----------------
Each model in the OMR will consist of several files that are packaged together into a single MPD file. For sets that include instructions for multiple models, each model will have its own MPD file. Each MPD for the set will be named in the following manner:
<Set Number>(<Optional Specifier>)-[main or alt<Number>]
Where:
<Set Number>: the number assigned on the container of the set
<Optional Specifier>: Sometimes different set with the same number are released, the specifier will be a single digit number, in parentheses, that is different between different sets, to distinguish these sets from one another.
[main or alt<Number>]: The main model of the instructions (i.e. the model featured on the cover of the container) will have the word "main". For sets that feature more than one model on the front of the container (e.g. the Creator line), the largest or most prominent model is the main model. For alternate models that are detailed in instructions, the word "alt" and a single digit number starting at 1 will be used. For playsets or other sets where there are multiple models that are part of an integral whole, all of the submodels will be contained in the main model MPD.
Example:
Set 4896 - Roaring Roadsters. This creator set has 3 models in the instructions. The roadster is featured prominently on the box. 4896 is the only set with that number. Therefore:
Roadster MPD: 4896-main.mpd
Dragster MPD: 4896-alt1.mpd
etc...
MPD File Structure:
-------------------
The MPD will conform to the MPD File Specification.
The individual files inside the MPD shall be named using the following convention:
<MPD Filename>-1.ldr - First model in main instructions
<MPD Filename>-1a.ldr - First submodel of first model
<MPD Filename>-1aa.ldr - First component of first submodel of first model
<MPD Filename>-1ab.ldr - Second component of first submodel of first model
<MPD Filename>-2.ldr - Second model of main instructions
<MPD Filename>-mf-<Number>.ldr - Minifig, numbered in order of its appearance in the instructions.
To use further levels of submodels, continue adding on letters to the appropriate depth.
The only unofficial parts allowed to be referenced in the model files are those currently residing on the LDraw.org Parts Tracker. No part files shall be contained in the MPD.
File Headers:
-------------
Each individual model file in the MPD must have a standard header format.
Standard Header:
0 FILE <Filename>.ldr
0 <Lego Set Number> <Lego Set Name>
0 Name: <Filename>.ldr
0 Author: <Author Name>
0 LDraw.org Official Model Repository