OMR Spec - Updated 8/22
2011-08-22, 12:51 (This post was last modified: 2011-08-24, 14:33 by Orion Pobursky.)
2011-08-22, 12:51 (This post was last modified: 2011-08-24, 14:33 by Orion Pobursky.)
Here's the latest draft. Discuss!! (Note: there is a quote bug that's removing the text between <>. Be aware of that and restore the text if needed)
--
The Offical Model Repository Specification
Version: 0.3 (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 sets 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 naming of the individual files in the MPD wis up to the discretion of the author with the following guidance:
- A logical nameing scheme is highly desired.
- Individual models in the set (e.g a vehicle or minifig) shall have thier own separate file inside the MPD.
- Minifig file name should have the name of the character, if known
- The <MPD Filename> is reqired to be prepended to the file name of each indiviual file in the MPD
The unofficial parts are allowed to be used. The filename of the unoffical part is subject to the naming rulles above (e.g. 33056.dat would be renamed to <MPD Filename> - 33956.dat). It is highly encouraged that any parts created for use in a OMR file be submitted to the LDraw.org Parts Tracker.
If a part is unavailable both officially or on the LDraw.org Parts Tracker. a suitible substitution may be made. If the unavailable part is a patterned part with an unpatterned version available use the unpatterned version. A comment should be inserted stating that a subtitution has been made or, if no substitution is available/suitable, that a piece has been omitted. Reference the step and page number of the instructions if possible.
Example:
0 // The next peice should have the Star Wars Hatch pattern per step X on page Y
or
0 // Bionicle piece X should ge here per step Y on page Z
File Headers:
-------------
Each individual model file in the MPD must have a standard header format.
Standard Header:
0 FILE <MPD Filename> - <Filename>.ldr
0 <MPD Filename> - <File Desciption>
0 Name: <MPD Filename> - <Filename>.ldr
0 Author: <Author Name>
0 !LDRAW_ORG Official Model Repository
0 !LICENSE Redistributable under CCAL version 3.0 : see CAreadme.txt
0 !THEME Theme name
0 !KEYWORDS words, more words,…,
0 !KEYWORDS words in second row, …, final words
0 !HISTORY YYYY-MM-DD [<Author Name>] Free text description of change. This can wrap to a
0 !HISTORY YYYY-MM-DD [<Author Name>e] second row with the same date if necessary. However authors should lean toward writing longer
0 !HISTORY YYYY-MM-DD [<Author Name>e] single !HISTORY lines(and not feel constrained to the historic 80-character limit on line length)
Where:
<MPD Filename>: The name of the containing MPD
<Filename>: The name of the file
<Author Name>: The name of the author. Real full name are highly desired but not required. If the full name is not provided, a first or last name, with or with out initials, is requested.
Optional commands are !THEME, !KEYWORDS, and !HISTORY
Example:
To Be Inserted Later
META commands:
--------------
All META commands are allowed in the model file but not specifically required except as specified for the header. If included, any META commands used should enable any instructions generated to be as close to the official instructions as possible.
--
The Offical Model Repository Specification
Version: 0.3 (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 sets 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 naming of the individual files in the MPD wis up to the discretion of the author with the following guidance:
- A logical nameing scheme is highly desired.
- Individual models in the set (e.g a vehicle or minifig) shall have thier own separate file inside the MPD.
- Minifig file name should have the name of the character, if known
- The <MPD Filename> is reqired to be prepended to the file name of each indiviual file in the MPD
The unofficial parts are allowed to be used. The filename of the unoffical part is subject to the naming rulles above (e.g. 33056.dat would be renamed to <MPD Filename> - 33956.dat). It is highly encouraged that any parts created for use in a OMR file be submitted to the LDraw.org Parts Tracker.
If a part is unavailable both officially or on the LDraw.org Parts Tracker. a suitible substitution may be made. If the unavailable part is a patterned part with an unpatterned version available use the unpatterned version. A comment should be inserted stating that a subtitution has been made or, if no substitution is available/suitable, that a piece has been omitted. Reference the step and page number of the instructions if possible.
Example:
0 // The next peice should have the Star Wars Hatch pattern per step X on page Y
or
0 // Bionicle piece X should ge here per step Y on page Z
File Headers:
-------------
Each individual model file in the MPD must have a standard header format.
Standard Header:
0 FILE <MPD Filename> - <Filename>.ldr
0 <MPD Filename> - <File Desciption>
0 Name: <MPD Filename> - <Filename>.ldr
0 Author: <Author Name>
0 !LDRAW_ORG Official Model Repository
0 !LICENSE Redistributable under CCAL version 3.0 : see CAreadme.txt
0 !THEME Theme name
0 !KEYWORDS words, more words,…,
0 !KEYWORDS words in second row, …, final words
0 !HISTORY YYYY-MM-DD [<Author Name>] Free text description of change. This can wrap to a
0 !HISTORY YYYY-MM-DD [<Author Name>e] second row with the same date if necessary. However authors should lean toward writing longer
0 !HISTORY YYYY-MM-DD [<Author Name>e] single !HISTORY lines(and not feel constrained to the historic 80-character limit on line length)
Where:
<MPD Filename>: The name of the containing MPD
<Filename>: The name of the file
<Author Name>: The name of the author. Real full name are highly desired but not required. If the full name is not provided, a first or last name, with or with out initials, is requested.
Optional commands are !THEME, !KEYWORDS, and !HISTORY
Example:
To Be Inserted Later
META commands:
--------------
All META commands are allowed in the model file but not specifically required except as specified for the header. If included, any META commands used should enable any instructions generated to be as close to the official instructions as possible.
