New OMR File Spec


New OMR File Spec
#1
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
Reply
Re: New OMR File Spec
#2
I know most of Europe's on holiday right now. I'll give this a week and then I'll formally submit it to the LSC. Scratch that, I think I'll just make this post sticky and let it brew a while.
Reply
Re: New OMR File Spec
#5
Should the model files contain "0 STEP" meta-statements corresponding to the steps in the building instructions from TLG?

If not, would it be a violation against the standard to add them anyway?
Reply
Re: New OMR File Spec
#7
I'm inclined to say yes 0 STEP commands should be included. Not sure how reviewable it would be since some instructions are pretty obscure.
Reply
Re: New OMR File Spec
#10
Orion Pobursky Wrote:
-------------------------------------------------------
> I'm inclined to say yes 0 STEP commands should be
> included. Not sure how reviewable it would be
> since some instructions are pretty obscure.

Ok, then let's leave to the LSC to decide whether 0 STEP be mandotory, recommended, not recommended, or prohibited. Smile

/Tore
Reply
Re: New OMR File Spec
#11
The more I think about it, the more I want to make this optional but highly desired. Basically don't want a model to be rejected because it doesn't have them. I'd rather have a complete and accurate model in the OMR over being able to recreate the instructions from the file.
Reply
Re: New OMR File Spec
#12
I'd go for a compact file with no STEP, BUFFEREXCHANGE or LPub metas, but would welcome them if they are in. Minimum requirements with just a standardized header would open the database to everyone but wouldn't prevent from LEGO-lookalike instructions if someone has to patients to tackle them.

I'm somewhat sceptical about the aa, ab, mf, ... looks to me as if we were still bound to 8.3 DOS conventions. In the era of 64 Bit OSes something like <MPD Filename>-Minifig-<Number>.ldr or <MPD Filename>-FirstModel.ldr would make much more sense.

w.
LEGO ergo sum
Reply
Re: New OMR File Spec
#15
I agree. I'm rewriting a portion of the spec to address this.
Reply
Re: New OMR File Spec
#3
Orion Pobursky Wrote:
-------------------------------------------------------
> Here's the first draft. Discuss!!
> -mf-.ldr - Minifig, numbered in order of its
> appearance in the instructions.
>

This will cause naming conflicts. If you have a model containing two (or more) MPD's from the OMR and they have minifigs, there will be at the very least two files named mf1.ldr. And so on...

/Tore
Reply
Re: New OMR File Spec
#4
Just a tiny little detail for an OMR novice: Where is that OMR? I can only find its header specs at http://www.ldraw.org/Article48.html and a broken link to ldraw.org / repository / official /
.

/Tore
Reply
Re: New OMR File Spec
#6
It doesn't exist (and never has) in any official capacity. This file spec in intended to remedy that. Mike Heidemann probably has the largest unofficial repository.
Reply
Re: New OMR File Spec
#8
I'm not sure how. The spec says they're named <MPD Filename>-mf-<Number>.ldr. The MPD filename should be unique in the OMR so the minifig name would be unique as well.
Reply
Re: New OMR File Spec
#9
Orion Pobursky Wrote:
-------------------------------------------------------
> I'm not sure how. The spec says they're named
> -mf-.ldr. The MPD filename should be unique in the
> OMR so the minifig name would be unique as well.

Oh sorry, now I can see that. It wasn't totally clear at Article48:
> 0 7140 X-Wing Fighter, Luke Skywalker Mini-figure
> 0 Name: mf-1.ldr (see below [1])

/Tore

(Edit: Also, some very crucial information drops away here in ldraw.org forum when quoted...)
Reply
Re: New OMR File Spec
#13
Tore Eriksson Wrote:
-------------------------------------------------------
> Orion Pobursky Wrote:
> --------------------------------------------------
> -----
> > I'm not sure how. The spec says they're named
> > -mf-.ldr. The MPD filename should be unique in
> the
> > OMR so the minifig name would be unique as
> well.
>
> Oh sorry, now I can see that. It wasn't totally
> clear at Article48:
> > 0 7140 X-Wing Fighter, Luke Skywalker
> Mini-figure
> > 0 Name: mf-1.ldr (see below [1])
>
> /Tore
>
> (Edit: Also, some very crucial information drops
> away here in ldraw.org forum when quoted...)

Just to clarify you mean the bits in <>? I assume they were auto culled rather than edited out.

Tim
Reply
Re: New OMR File Spec
#14
Tim Gould Wrote:

> Tore Eriksson Wrote:

> > (Edit: Also, some very crucial information
> drops
> > away here in ldraw.org forum when quoted...)
>
> Just to clarify you mean the bits in <>? I assume
> they were auto culled rather than edited out.
>
> Tim

Yes, that's what I mean.
Reply
Re: New OMR File Spec
#16
Orion Pobursky Wrote:
-------------------------------------------------------
> File Headers:
> -------------
> Each individual model file in the MPD must have a
> standard header format.
>
> Standard Header:
> 0 FILE .ldr
> 0
> 0 Name: .ldr
> 0 Author:
> 0 LDraw.org Official Model Repository

I'm a little surprised to see the exclaimation mark is not present in the last line.

Instead of
> 0 LDraw.org Official Model Repository
I suggest:
0 !LDRAW_ORG (Official | Unofficial) OMR Model
(Unofficial until certified by ldraw.org)

/Tore
Reply
Re: New OMR File Spec
#17
Typo on my part. I'll have a new rev up soon. In the mean time, keep the comments coming...
Reply
Re: New OMR File Spec
#18
Orion Pobursky Wrote:
-------------------------------------------------------
> In the mean time, keep the comments coming...

Are you sure you really want that? Wink
Reply
Re: New OMR File Spec
#19
Um, yes, as long as it constructive with a proposed solution (Tongue)
Reply
« Next Oldest | Next Newest »



Forum Jump:


Users browsing this thread: 1 Guest(s)