LDraw.org Wiki - User contributions [en]

User:Owen Burgoyne/POV-Ray Tutorial

2024-03-27T19:39:50Z

Steffen:

This tutorial is a <span style="color:#aa0000">'''WORK IN PROGRESS'''</span>.
<hr/>
[[File:Pyramid POV-Ray Radiosity Final.png|thumb|300px|James Jessiman's pyramid model, rendered in POV-Ray.]]
The purpose of this guide is to take an already-built [[LDraw]] model and then render it in [[POV-Ray]] to create a near-realistic image. The guide itself will not necessarily give you ''all'' the answers on how to create exactly what you want, but will hopefully get you started in the right direction and perhaps even lead you on to investigating and mastering certain rendering techniques.

For the purposes of this tutorial, I will be using James Jessiman's pyramid model included with LDraw.

==Requirements==
For the purposes of this guide I have used the following:

*The [[LDraw]] library
*[[MLCad]] 3.40
*[[LDView]] 4.2 beta 1
*[[LGEO]] parts library
*[http://www.povray.org/beta/ POV-Ray 3.7 RC7]
* A plain text editor, such as Notepad

The first four can all be obtained directly from the [[LDraw All-In-One Installer]] (AIOI), although my LGEO parts pack requires manual installation.

The LDraw AIOI currently contains POV-Ray 3.6, but I recommend uninstalling this if you already have it and installing POV-Ray 3.7. Although still currently in beta, I have had no issues using it and it contains the ability to use more than one CPU, allowing for much faster rendering when using a multi-core system.

The guide also assumes that you are running the above on Windows. (I have no Mac or Linux experience, so would not able to advise on the correct file paths for installation.)

==Setting up LDView==

[[LDView]], which is used to export the LDraw model to the POV-Ray format, automates a lot of things, although there are a few things worth taking into account.

===Image aspect ratio===

The first thing you may want to set is the aspect ratio of the final image. Once you have your model open within LDView, you can set LDView's display aspect ratio from the menu under '''View > Standard Sizes'''. Each view size shows the relevant aspect ratio that it conforms to in brackets. For the purposes of this tutorial, I'll be using '''1280 x 720 (16:9)''', the ratio used by a lot of modern monitors.

To ensure that this carries over to your render, you need to set a matching ratio in the LDView export window. You can do this by going to '''File > Export...''' and then the '''Options...''' button, and selecting the appropriate option under '''Aspect Ratio'''. You can also use '''Current LDView aspect ratio''', but need to ensure that you know what you used when selecting the image size within POV-Ray.

However, for this to work with a lot of wider aspect ratios you need the same aspect ratio available within POV-Ray, and this is explained under the "quickres.ini" entry below.

===Include files===

LDView gives you the ability to use "include" files within your POV-Ray file, in case there are settings you always use but are not default options within the file that LDView generates. This means you can set other values for things such as floor colour, background colour, etc.

An "include" can be saved to any location, and the file path can then be inserted into the relevant field.

Below is an example of the text that I use in the top include file:

<pre>// Floor settings
#declare LDXFloorR = 0.9; // Floor Red
#declare LDXFloorG = 0.9; // Floor Green
#declare LDXFloorB = 0.9; // Floor Blue
#declare LDXFloorAmb = 0; // Floor Ambient
#declare LDXFloorDif = 0.9; // Floor Diffuse

// Fog
#if (LDXFloor != 0)
fog {
distance LDXRadius*100
color rgb 1
}
#end</pre>

The '''Floor settings''' section automatically changes the floor variables to something I find works better, meaning I don't have to edit each file that LDView exports.

The '''Fog''' section creates a fogging effect in the background, which softens the horizon when the POV-Ray camera is pointing at a shallow angle.

==Setting up the LGEO library==

If you've installed the LGEO library from the AIOI to the default location, then it should be located at '''C:\Program Files\LDraw\LGEO'''.

Although updated by Lutz Uhlmann in 2008, there are still a few errors in the library, some of which are simply compatibility issues with any version of POV-Ray higher than 3.1. Where possible, I have fixed any files that I have come across, as well as create some new files, which can be found in the LGEO Parts Pack listed above.

The file itself mainly contains LGEO files (marked with '''lg_''' at the beginning of the file) which can simply be copied to LGEO's '''C:\Program Files\LDraw\LGEO\lg''' folder.

It also contains a file called '''LGEO.xml''' which must be copied to the LDView installation folder.

==Setting up POV-Ray==

===povray.ini===
To function properly with the LGEO library, POV-Ray needs to be told where to find the library files, and this is done via the '''povray.ini''' file. To edit this, within the POV-Ray menu go to '''Tools > Edit master POVRAY.INI'''. This will open the file as a text file, and give you some basic explanation on how to add or modify settings within this file.

You need to ensure that library paths are included in the file, pointing to the installation folder for LGEO. If using the AIOI, this is installed by default to the '''C:\Program Files\LDraw''' folder, so the following lines would need to be added to the end of the file:

<pre>Library_Path="C:\Program Files\LDraw\LGEO"
Library_Path="C:\Program Files\LDraw\LGEO\ar"
Library_Path="C:\Program Files\LDraw\LGEO\lg"</pre>

If you're using a 64-bit version of Windows, then you may need to change '''Program Files''' to '''Program Files (x86)'''.

===quickres.ini===
POV-Ray includes its own resolution definitions, stored in a file called '''quickres.ini''', which allows you to quickly set your desired image output size. These are accessed via a drop-down box shown at the top left of the POV-Ray window, but the available options are fairly limited.

To alter these settings, within the POV-Ray menu go to '''Tools > Edit resolution INI file''' and the file should then open up as a text file. You should see a number of different resolutions, mainly set to the 4:3 ratio (640x480, 800x600, etc.), along with [http://en.wikipedia.org/wiki/Spatial_anti-aliasing anti-alias] switches. For example:

<pre>[800x600, No AA]
Width=800
Height=600
Antialias=Off</pre>

or

<pre>[800x600, AA 0.3]
Width=800
Height=600
Antialias=On
Antialias_Threshold=0.3</pre>

This rather limits the available ratios, such as 16:9 (widescreen) or 2.35:1 (anamorphic widescreen). Therefore you need to specify your own. To make it easier to pick out which aspect ratio I need, I often specify this in the preset, as in the below example:

<pre>[800x340 2.35:1, No AA]
Width=800
Height=340
Antialias=Off

[800x450 16:9, No AA]
Width=800
Height=450
Antialias=Off</pre>

You can also specify further sizes by adding variations on the above, and add anti-aliasing to each resolution by changing '''Antialias=Off''' to:

<pre>Antialias=On
Antialias_Threshold=0.3</pre>

===Custom inserts===
POV-Ray includes the option to insert pre-defined parameters into a POV-Ray file, either from the main menu ('''Insert''') or by right-clicking the Editor window.

The purpose of setting these up for rendering LDraw models is to make it easier to insert often-used options, such as radiosity settings or HDRI lighting environments. By default, POV-Ray will store the "Inserts" folder here:

<pre>C:\Users\%USERNAME%\Documents\POV-Ray\v3.7\Insert Menu</pre>

==Exporting to POV-Ray==

==Rendering in POV-Ray==

==Gallery==
<gallery widths=300px heights=225px>
Pyramid LDView.png|James Jessiman's pyramid model, as shown in LDView.
Pyramid POV-Ray default.png|The pyramid rendered with POV-Ray's default settings.
Pyramid POV-Ray area lights.png|The pyramid rendered with POV-Ray's default settings, but with all lights set to area lights.
Pyramid POV-Ray Radiosity Fast.png|The pyramid rendered with POV-Ray using the Radiosity_Fast setting and one area light.
Pyramid POV-Ray Radiosity Normal.png|The pyramid rendered with POV-Ray using the Radiosity_Normal setting and one area light.
Pyramid POV-Ray Radiosity Final.png|The pyramid rendered in POV-Ray using a modified version of the Radiosity_Final setting and one area light.
</gallery>
<gallery widths=300px heights=225px caption="Supplemental images">
Pyramid POV-Ray with fog.png|The pyramid rendered in POV-Ray using a modified version of the Radiosity_Final setting and one area light. Fogging is used to soften the horizon.
Pyramid POV-Ray without fog.png|The pyramid rendered in POV-Ray using a modified version of the Radiosity_Final setting and one area light. No fogging is used, resulting in a sharp horizon.
Pyramid POV-Ray with reflective floor.png|The pyramid rendered in POV-Ray using a modified version of the Radiosity_Final setting and one area light. The floor here is given a reflective quality.
Pyramid POV-Ray transparency.png|The pyramid rendered in POV-Ray using a modified version of the Radiosity_Final setting and one area light. The floor has been switched off and background transparency has been enabled.
</gallery>

==See also==
*[[L3P]]

==Links==
*[http://www.digitalbricks.org/ Digitalbricks.org] - The official LGEO site

[[Category:POV-Ray]]

Tools

2024-03-27T19:38:53Z

Steffen: Redirected page to Category:Software

#redirect [[:Category:Software]]

Model

2024-03-27T19:38:45Z

Steffen:

A '''model''' within [[LDRAW]] context is something that you have built on your computer from the virtual [[LDRAW]] [[part]]s (bricks).

They usually are saved in [[LDR]] files.

You can do that with various available [[tools]].

Here for example is a model of a pyramid which then later has been rendered as a 3D image by [[POVRay]]:

[[Image:Pyramid POV-Ray Radiosity Final.png]]

[[Category:Terms]]

Model

2024-03-27T19:38:27Z

Steffen:

A '''model''' within [[LDRAW]] context is something that you have built on your computer from the virtual [[LDRAW]] [[part]]s (bricks).

They usually are saved in [[LDR]] files.

Here for example is a model of a pyramid which then later has been rendered as a 3D image by [[POVRay]]:

[[Image:Pyramid POV-Ray Radiosity Final.png]]

[[Category:Terms]]

LDRAW

2024-03-27T19:38:01Z

Steffen: Redirected page to Category:LDraw.org

#redirect [[:Category:LDraw.org]]

Model

2024-03-27T19:37:40Z

Steffen:

A '''model''' within [[LDRAW]] context is something that you have built on your computer from the virtual [[LDRAW]] parts.

They usually are saved in [[LDR]] files.

Here for example is a model of a pyramid which then later has been rendered as a 3D image by [[POVRay]]:

[[Image:Pyramid POV-Ray Radiosity Final.png]]

[[Category:Terms]]

Category:LDraw.org

2024-03-27T19:34:02Z

Steffen:

'''[[LDraw]]''' is an open standard for LEGO [[CAD]] programs that allow the user to create virtual LEGO models and scenes.

You can use it to
* document models you have physically built,
* create building instructions just like LEGO,
* render 3D photo realistic images of your virtual models
* and even make animations.

The possibilities are endless.

Unlike real LEGO bricks where you are limited by the number of parts and colors, in LDraw nothing is impossible.

'''LDraw.org''' is the volunteer's organization which takes care of LDraw by its
* [[Image:RoleIcon_Steering_Committee.png|link=LDraw.org Steering Committee]] (taking care of where ldraw.org moves as a whole)
* [[Image:RoleIcon_Standards_Board.png|link=LDraw.org Standards Committee]] (taking care of technical specifications)

It also runs the [[Parts Tracker]], which is the means to produce new [[official parts]].

== History ==

[[James Jessiman]], during his free time, developed [[LDraw (program)|LDraw]] and [[LEdit]], the 2 original LDraw programs.
He also defined the initial version of the [[LDraw file format]].
He received a lot of feedback and his system flourished. In late July 1997, James died of influenza after a short period of illness. The community was shocked of this. Instead of disappearing, however, LDraw began to be taken care of by the community.
In many volunteering hours, LDraw grew and grew. Many tools and parts were developed. Set inventories created. Colors researched. Images and videos created. Many things more.
At some point, [[LDraw.org]] was formed, the [[Steering Committee]] and [[Standards Board]] were elected, and the development of [[official part]]s was formalized a little more
to ensure a high quality and usability and consistency of those parts.
Today, [[LDraw.org]] takes care of LDraw.
Eventually, in the 21st century, it was decided to re-license the library under the
[[Creative Commons]] Attribution license, forming the [[Contributor Agreement]].
Nowadays, all official parts are released with this new license model.

== External Links ==

* [http://www.ldraw.org Official Homepage]
* {{Wikipedia|LDraw}}

[[Category:Main Index]]
[[Category:LDraw Servers]]

Category:LDraw Servers

2024-03-27T19:33:28Z

Steffen:

This category aims to collect '''all servers run by [[ldraw.org]]'''.

[[Category:LDraw.org]]
[[Category:Websites]]

LDInspector - Checking for OMR Compliance

2024-03-27T19:32:55Z

Steffen:

This page shows '''how to check a model for [[OMR]] compliance using [[LDInspector]]'''.

<gallery mode="slideshow">
File:LdihtOmrCheck00001.png|Add a reference to the file to be tested by clicking "File" in the "Items" section.
File:LdihtOmrCheck00002.png|After adding the file reference, the Item tab shows basic information about the file.
File:LdihtOmrCheck00003.png|The OMR-Check tab shows results of implemented tests. In this case, everything is ok.
File:LdihtOmrCheck00004.png|In this case, a part named "3004asdfghjk" is referenced. This is a "hard error", the file is not OMR compliant.
</gallery>

[[Category:LDInspector]]

LDInspector - Fixing OMR Compliance Issues

2024-03-27T19:32:38Z

Steffen:

This page shows '''how to automatically fix [[OMR]] compliance issues using [[LDInspector]]'''.

<gallery mode="slideshow">
File:LdihtOmrFix00001.png|After workspace configuration, add the file to check.
File:LdihtOmrFix00002.png|Basic information can be found on the Item pane.
File:LdihtOmrFix00003.png|All OMR checks report "ok".
File:LdihtOmrFix00004.png|The Render pane shows a preview - pay attention to the Color combo box: "Original" will use the colors given in the file.
File:LdihtOmrFix00005.png|Changing Color to "OMR-Checks", you will see parts that are not OMR-compliant in magenta (here: none).
File:LdihtOmrFix00006.png|Changing Color to "Collision" will show porentially (!) colliding parts. For example, in this case all wheels have rim and tire in touch. Marking them as colliding is too sensitive in this case (false-positive).
File:LdihtOmrFix00007.png|This prepared example contains a mirrored part, which is not allowed for OMR models and reported by the mirrored part check ("error"). You can get help, but there is not automatical solution.
File:LdihtOmrFix00008.png|The preview looks well, but...
File:LdihtOmrFix00009.png|...changing Color to "OMR-Checks" highlights the mirrored part.
File:LdihtOmrFix00010.png|There are no collisions, and this time the algorithm does not produce false-positives.
File:LdihtOmrFix00011.png|A prepared multi-fail could look like this: unofficial parts are used but not embedded (warn), author and license attributes are missing (errors). On the right there are red buttons to fix problems step by step.
File:LdihtOmrFix00012.png|After adding author and license attributes and adding unofficial parts, there are still unofficial parts: the embedded ones refer to other parts that need to be embedded and renamed to comply with OMR rules.
File:LdihtOmrFix00013.png|Some clicks later, the errors become less.
File:LdihtOmrFix00014.png|After all, the OMR check shows "ok".
File:LdihtOmrFix00015.png|Starting with version 0.2, there is a "Repeated-All" button to do all fixes repeatedly as long as there is something to fix.
File:LdihtOmrFix00016.png|So with one click all separate fixes in the previous example are done at once and the file becomes OMR compliant (as far as possible).
</gallery>

[[Category:LDInspector]]

LDInspector - Comparing Part Lists

2024-03-27T19:32:15Z

Steffen:

This page shows '''how to compare 1 or more part lists or models using [[LDInspector]]'''.

<gallery mode="slideshow">
File:LdihtPartlistCompare00001.png|Select first part list and do a right click on "CS" in the table header. In the appearing popup menu select "Copy row".
File:LdihtPartlistCompare00002.png|This will result in a copy of CS named C1.
File:LdihtPartlistCompare00003.png|Select the second part list, also right click on "CS" and select "Copy row".
File:LdihtPartlistCompare00004.png|Finally select the part list you want to compare with.
File:LdihtPartlistCompare00005.png|Changing "Show all" to "Show diff" will only show items that differ - here the Rebrickable PBG in C1 has several differences to Bricklink in C2, which is almost the same as the selected model in CS except for the "Tyre 6/50" color.
File:LdihtPartlistCompare00006.png|Skipping the Rebrickable list and thereby comparing the model with the Bricklink list, only the "Tyre 6/50" remains as difference.
</gallery>

[[Category:LDInspector]]

LDInspector - Checking for OMR Compliance

2024-03-27T19:31:46Z

Steffen:

This page shows '''how to check a model for [[ORM]] compliance using [[LDInspector]]'''.

<gallery mode="slideshow">
File:LdihtOmrCheck00001.png|Add a reference to the file to be tested by clicking "File" in the "Items" section.
File:LdihtOmrCheck00002.png|After adding the file reference, the Item tab shows basic information about the file.
File:LdihtOmrCheck00003.png|The OMR-Check tab shows results of implemented tests. In this case, everything is ok.
File:LdihtOmrCheck00004.png|In this case, a part named "3004asdfghjk" is referenced. This is a "hard error", the file is not OMR compliant.
</gallery>

[[Category:LDInspector]]

LDInspector - Bricklink Interoperation

2024-03-27T19:31:16Z

Steffen:

This page shows '''how to get a part list from [[BrickLink]] and then post-process it with [[LDInspector]]'''.

<gallery mode="slideshow">
File:LdihtBricklink00001.png|Ensure having web cache enabled, therefore select "Config.".
File:LdihtBricklink00002.png|Ensure "Use cache for web resources" is selected and the field afterwards has a valid file-prefix or points to a valid directory (notice the "/" at the end).
File:LdihtBricklink00003.png|Select Web pane and enter search key, afterwards press "Ass. BL search".
File:LdihtBricklink00004.png|The first result is what we were looking for, so we want to get "Product" of this and remove ("X") the other two.
File:LdihtBricklink00005.png|Next is to request the inventory of the set by clicking "Inv.Reg.". For details about the difference between "Inv.Reg." and "Inv.All." see the text description of LDInspector.
File:LdihtBricklink00006.png|We get a bunch of parts, most of them are marked with a green circle indicating they are official parts. For the unofficial (orange) and missing (red) parts that have sub-inventories, activate "Inv.Reg.".
File:LdihtBricklink00007.png|At the end, we get a structured list for 8c02 having green indicators at leaf items.
File:LdihtBricklink00008.png|Same for the missing part pln025 at the list bottom.
File:LdihtBricklink00009.png|In the pln025 inventory there is no sub-inventory for the missing part 193au, so we need to search ourself for a replacement, therefore click "S" for the 193au Headgear Helmet.
File:LdihtBricklink00010.png|In the search window the first result is just what we were looking for, so we select it and press "OK".
File:LdihtBricklink00011.png|The replacement part is added below 193au, the 973c02 has a inventory - take care of the 981982 with red "missing" indicator. For this example, we "forget" to resolve this and consider the search done.
File:LdihtBricklink00012.png|At the top of the list, "C.List" button will create a new part list item at the workspace item list.
File:LdihtBricklink00013.png|The created list is expanded here, and for some reasons we now observe that we forgot to resolve the 981982 part that is not a LDraw part.
File:LdihtBricklink00014.png|Therefore select the list and go to the bottom of the web search result and "Inv.Reg." the 981982.
File:LdihtBricklink00015.png|After selecting "+SLI" for 981982 all sub-elements of this item are added to the part list.
File:LdihtBricklink00016.png|To remove the wrong 981982, select it in the part list and active Item pane, where you can "Remove item".
File:LdihtBricklink00017.png|Looking at the part list in the PartList pane, some of the parts are ~Moved. To resolve this, right click "CS" and select "Resolve ~moved parts".
File:LdihtBricklink00018.png|Done: a list of official parts created from the Bricklink database. This list can be exported by right-clicking "CS" or on the Item pane. Or just save the workspace to have this list always there.
</gallery>

[[Category:LDInspector]]

LDInspector - Basic Configuration

2024-03-27T19:30:38Z

Steffen:

This page shows '''Basic Configuration of [[LDInspector]]'''.

<gallery mode="slideshow">
File:LdihtConfig00001.png|On first start, click "Yes", later select "Config." to open workpsace configuration.
File:LdihtConfig00002.png|On the first start, the configuration looks like this. Select for each part source: official or unofficial? files in a directory or in a zip? Most likely you will also want to configure a web resource cache directory.
File:LdihtConfig00003.png|In the end, your configuration will perhaps look like this. If unsure, leave colors unchanged. After "OK", save the configuration. If the filename is "LDInspector.ldi", this configuration will be used on future program starts.
</gallery>

[[Category:LDInspector]]

Category:LDInspector

2024-03-27T19:29:45Z

Steffen: /* Howtos */

'''LDInspector''' is an interactive and batch processing information retrieval software for LDraw models written by Stefan Frenz.

It was at first described at the [https://forums.ldraw.org/thread-23882.html LDraw forum], and
over time here will arise some kind of how-to and documentation of LDInspector. You may get it
[http://fam-frenz.de/stefan/ldi.html here].

== Installation ==

=== All systems ===

Get the [http://fam-frenz.de/stefan/ldi.html desired version] or the [http://fam-frenz.de/stefan/ldinsp.jar latest snapshot] of
LDInspector's jar file. Also get the [http://fam-frenz.de/stefan/ldiinst.zip installer] zip. Therein you will find a short
readme.txt as well as installer scripts for Linux (tested on XUbuntu and Mint) and Windows (tested on 8.1 and 10). If you already
have the ldinsp.jar file or like to get the latest one, just grab the installer and it will download the latest version of
ldinsp.jar during installation. Put the installer (and optionally the ldinsp.jar file) in a directory of your choice, start the
installer and after successful execution of the install script this directory will contain a portable version of LDInspector
(for the desired operating system only, of course).

Therefore the install script downloads an appropriate Java- and JavaFX-package from the web, extracts them and removes the original
package as well as some unneeded files.

=== Linux ===

After putting both ldinsp.jar and install_lin.sh (extracted from ldiinst.zip) in one directory, call install_lin.sh from the command
line to get the installation information, or just call it from your preferred file manager, if you don't need messages or have
notify-send installed (package notify-osd, installed by default). If so, all messages will additionally be shown on your UI, so you
really don't need a terminal.

=== Windows ===

After putting both ldinsp.jar and install_win.bat (extracted from ldiinst.zip) in one directory, start the install_win.bat file. If
you like to have it installed in "Program Files" or other access limited directories, you will have to have administrator privileges.
A terminal window will open up automatically and show progress messages. At the end the install scripts pauses until it is closed or
"Enter" is pressed.

=== MacOS ===

At the moment, the install script don't support MacOS directly. In the [https://forums.ldraw.org/thread-23882-post-36106.html#pid36106 forum]
it was reported to be possible to get it run.

== Basic Configuration ==

You may play with LDInspector without having [https://www.ldraw.org/parts/latest-parts.html LDraw libraries] installed. But typically
at the first start if LDInspector, you will want to configure LDraw paths. To do so, in the main window click "Config." (or click "yes" if LDInspector asks for configuration at startup). This opens a new window:

* Part sources may be configured by selecting an origin attribute (all parts of that source will be considered being official or unofficial), selecting a zip file or directory and then adding it. The part sources are used in an ordered way so that the first hit will be used - if you like to have official parts by default, move the corresponding entry to the top; if you like to have bleading edge unofficial parts by default, move this one to the top.
* Web cache is only important, if you use the Web tab or the Bricklink/Rebrickable image preview in PartList tab. But if you use those, ensure to have caching activated and to have a valid cache file prefix, usually a directory.
* Color definitions are integrated in LDInspector, but you may overwrite all colors and color-mappings.

After having configured everything and having pressed the OK button, save your configuration via "Save" button in the main window. This will contain the basic configuration as well as the current item list, so you may add some items and save again.

== Howtos ==

see the list of articles in this category at the bottom of this page

== UI Conception ==

Hopefully, you get the ui conception without reading this. ;) But just in case: the main window is divided in three sections:

On top contains some buttons
* to configure the workspace ("Load", "Config.", "Save"),
* to clear or add a new item to the item list ("Clear", "Part-List", "Part", "File", "Directory"), or
* to cause LDInspector to do something ("Refresh", "Info", "Exit").

On the left there is the item list. You may always select exactly one item, some of them like directory items may have sub-items. At the
moment there are four types of items:

* Part-List: use this to hold a set of parts which you maybe like to change ("editable"). You can add and remove parts, change their color and amount. Main use case: prepare a part list that can be used in other scenarios like LDCad construction or Bricklink shopping.
* Part: use this to reference a part. You can change the reference name, the color and amount. Main use case: inspect a single part you are interested in.
* File: use this to reference a file. You can not change anything, the content is loaded on demand from the file system. Main use case: do something with a ldr/mpd file like OMR-checking or reference a part list on disk.
* Directory: use this to reference a directory. You can not change anything, the directory content is loaded on demand from the file system and is recursively browsable. Main use case: point to a directory with all your models and access them fast and easily.

On the right there is a tabbed pane, at the top you select what you would like to do:

* Item: get basic information about the selected item. Here you may remove this single item from your item list ("Remove item"), refresh its content ("Refresh item", for example after changing a file in another program), change its name, and depending on the item type there are other actions available:
** Part-List: you can add a "new empty" part to an editable part list, trigger part sorting or export the list to PBG file (for example to build a model with those parts in LDCad) or to XML file (for example if you with to buy those parts at Bricklink).
** Part or file pointing to a part or model: you may export the part to Wavefront OBJ (for example for further processing or giving a 3D model to someone who has one of the free OBJ viewers but nothing in mind with LDraw), export the part with all transitively used parts to a zip file (for example if you wish to give a model to someone without the required parts).
** Directory: there is nothing more to do.
* OMR-Check: if you selected a model, LDInspector performs some checks and reports their results in the text area. At the moment there is no "quick-fix" feature available (planned in a future version).
* Render: get a preview of the model you selected. Note that there are several non-self-explanatory options:
** Displayed lines: you may select between several options how many lines should be drawn. As the rendering pipeline of JavaFX does not support lines unfortunately, each line results in 12 triangles to be rendered. For large models this is very expensive and usually not required.
** Color: you may override the color of the selected item to a fixed one (will only change "parent" color, so if there are defined colors in a part or model, they will not be replaced) or to select color depending on checks:
*** OMR-Checks: each part contributing to a OMR check message will be colored in blue (hint), orange (warn), red (solvable error) or magenta (hard error). All other parts are green (ok).
*** Collision: each part is colored in either green (ok) or magenta (colliding). Please note that this test is in pre-alpha state and very time consuming for large models.
** Show steps: you can select shown steps by entering "from" and "to" numbers; having the "from" number set to 1, the rendering shows the model up to the step entered in "to"; having both numbers identically set, the rendering shows only those parts added in this step.
* PartList: you get a list for all parts in the selected item - either a part list or a LDraw model. There are lots of use cases, see below.
* PartGrid: you get a very short and read-only overview of all parts in the selected item - either a part list or a LDraw model.
* UsedFiles: all transitively used parts are shown in the text area, for example if you want to check if there are "unwanted" parts or if you like to process them with another tool.
* Source: just print the source code of the selected item.
* Search: search a part by filename, description, author or origin. If you selected an editable part list in the item list and you found the part you were looking for, you may add this directly to your part list.
* Web: get information about sets from Bricklink and Rebrickable. See use cases below.
* Log: if something went wrong or if you are interested in statistics, take a look.

== Use cases ==

=== Check OMR compliance ===

# Ensure you have your LDraw paths configured correctly (see "Basic Configuration" above).
# Add a file reference or directory reference to your workspace.
# Select OMR-Check tab.
# You'll get a short overview of all checks done, each having one of the following states:
## ign: the check is started but did nothing, perhaps because this check is not available for the selected item.
## ok: the check didn't find anything to grump about.
## hint: maybe (!) there is something that could be optimized, but as per definition, it is ok. Maybe the hint is to be ignored with reason, like having a part in a specific color even if the part name contains "tyre".
## warn: there is something that should be optimized, for example the model contains a sub-file that is never used.
## error: there is something that has to be fixed because it violates the OMR rules, for example if a referenced part is not found.
# At the moment, you will have to edit your file with some other tool. There are plans enabling LDInspector to offer quick-fix options for problems that can be fixed automatically like missing license lines.

=== Get inventories from external sources ===

# Ensure you have your LDraw paths configured correctly (see "Basic Configuration" above).
# Most likely you will want to have web cache path cofigured (see "Basic Configuration" above).
# Select Web-Check tab.
# Enter your set number in the "key" field.
# Search Bricklink and/or Rebrickable with one of the following (or do all of them by clicking "All"):
## Ass. BL search: search Bricklink as if entered in the Bricklink search on the main page.
## Full BL product search: search Bricklink for products listed with the given key.
## Ass. RB search: search Rebrickable as if entered in the Rebrickable search on the main page.
## RB set search: at Rebrickable directly look for a set with the given key.
# Recursively dive into the results. If done, you can add single parts to an editable part list or create a complete new part list.

Handling and diving into results may be done with the following actions:
* "X": delete this item.
* "Img.": load an image for this item if available.
* "Product" (only Bricklink results): get product information about this item.
* "Un.Inv.": remove sub-items of this item.
* "Inv.Reg." (only Bricklink inventories): get regular items of this inventory item.
* "Inv.All." (only Bricklink inventories): get all items of this inventory item. Attention: this may contain duplicates, but simplifies searching alternate parts.
* "Set" (only Rebrickable results): get set information about this item.
* "PBG" (only Rebrickable sets): download the official PBG file from Rebrickable for this set.
* "Inventory" (only Rebrickable sets): get items of this inventory item.
* "S" (only part results): search in the LDraw library for a replacement part (similar to Search tab).
* "+WS" (only part results): add this part as part item to the workspace. The circle color in this button reports about
** green: official LDraw part found for this entry.
** orange: unofficial LDraw part found for this entry.
** red: no LDraw part found for this entry.
* "+LI" (only part results): add this entry as part to the selected editable part list.

If you like to have all images as soon as possible and all next to a description, select "Img.: integrated" and press "Load all images" if there are new items without image.

=== Handle a bunch of models ===

To your item list add a directory item pointing to the directory containing the models or sub-directories with models. Maybe save your workspace configuration if this directory is looked after more often. By clicking the triangle in front of the directory item's name, the sub-elements can be used directly for all other use cases.

[[Category:Software]]

LDInspector/HowtoPartlistCompare

2024-03-27T19:29:17Z

Steffen: Steffen moved page LDInspector/HowtoPartlistCompare to LDInspector - Comparing Part Lists

#REDIRECT [[LDInspector - Comparing Part Lists]]

LDInspector - Comparing Part Lists

2024-03-27T19:29:17Z

Steffen: Steffen moved page LDInspector/HowtoPartlistCompare to LDInspector - Comparing Part Lists

Back to [[LDInspector]] main page.

== Howto: Compare multiple part lists and/or models with each other ==

<gallery mode="slideshow">
File:LdihtPartlistCompare00001.png|Select first part list and do a right click on "CS" in the table header. In the appearing popup menu select "Copy row".
File:LdihtPartlistCompare00002.png|This will result in a copy of CS named C1.
File:LdihtPartlistCompare00003.png|Select the second part list, also right click on "CS" and select "Copy row".
File:LdihtPartlistCompare00004.png|Finally select the part list you want to compare with.
File:LdihtPartlistCompare00005.png|Changing "Show all" to "Show diff" will only show items that differ - here the Rebrickable PBG in C1 has several differences to Bricklink in C2, which is almost the same as the selected model in CS except for the "Tyre 6/50" color.
File:LdihtPartlistCompare00006.png|Skipping the Rebrickable list and thereby comparing the model with the Bricklink list, only the "Tyre 6/50" remains as difference.
</gallery>

[[Category:LDInspector]]

LDInspector/HowtoOmrFix

2024-03-27T19:29:01Z

Steffen: Steffen moved page LDInspector/HowtoOmrFix to LDInspector - Fixing OMR Compliance Issues

#REDIRECT [[LDInspector - Fixing OMR Compliance Issues]]

LDInspector - Fixing OMR Compliance Issues

2024-03-27T19:29:01Z

Steffen: Steffen moved page LDInspector/HowtoOmrFix to LDInspector - Fixing OMR Compliance Issues

Back to [[LDInspector]] main page.

== Howto: Automatically fix OMR compliance issues ==

<gallery mode="slideshow">
File:LdihtOmrFix00001.png|After workspace configuration, add the file to check.
File:LdihtOmrFix00002.png|Basic information can be found on the Item pane.
File:LdihtOmrFix00003.png|All OMR checks report "ok".
File:LdihtOmrFix00004.png|The Render pane shows a preview - pay attention to the Color combo box: "Original" will use the colors given in the file.
File:LdihtOmrFix00005.png|Changing Color to "OMR-Checks", you will see parts that are not OMR-compliant in magenta (here: none).
File:LdihtOmrFix00006.png|Changing Color to "Collision" will show porentially (!) colliding parts. For example, in this case all wheels have rim and tire in touch. Marking them as colliding is too sensitive in this case (false-positive).
File:LdihtOmrFix00007.png|This prepared example contains a mirrored part, which is not allowed for OMR models and reported by the mirrored part check ("error"). You can get help, but there is not automatical solution.
File:LdihtOmrFix00008.png|The preview looks well, but...
File:LdihtOmrFix00009.png|...changing Color to "OMR-Checks" highlights the mirrored part.
File:LdihtOmrFix00010.png|There are no collisions, and this time the algorithm does not produce false-positives.
File:LdihtOmrFix00011.png|A prepared multi-fail could look like this: unofficial parts are used but not embedded (warn), author and license attributes are missing (errors). On the right there are red buttons to fix problems step by step.
File:LdihtOmrFix00012.png|After adding author and license attributes and adding unofficial parts, there are still unofficial parts: the embedded ones refer to other parts that need to be embedded and renamed to comply with OMR rules.
File:LdihtOmrFix00013.png|Some clicks later, the errors become less.
File:LdihtOmrFix00014.png|After all, the OMR check shows "ok".
File:LdihtOmrFix00015.png|Starting with version 0.2, there is a "Repeated-All" button to do all fixes repeatedly as long as there is something to fix.
File:LdihtOmrFix00016.png|So with one click all separate fixes in the previous example are done at once and the file becomes OMR compliant (as far as possible).
</gallery>

[[Category:LDInspector]]

LDInspector/HowtoOmrCheck

2024-03-27T19:28:38Z

Steffen: Steffen moved page LDInspector/HowtoOmrCheck to LDInspector - Checking for OMR Compliance

#REDIRECT [[LDInspector - Checking for OMR Compliance]]

LDInspector - Checking for OMR Compliance

2024-03-27T19:28:38Z

Steffen: Steffen moved page LDInspector/HowtoOmrCheck to LDInspector - Checking for OMR Compliance

Back to [[LDInspector]] main page.

== Howto: Check models against OMR compliance ==

<gallery mode="slideshow">
File:LdihtOmrCheck00001.png|Add a reference to the file to be tested by clicking "File" in the "Items" section.
File:LdihtOmrCheck00002.png|After adding the file reference, the Item tab shows basic information about the file.
File:LdihtOmrCheck00003.png|The OMR-Check tab shows results of implemented tests. In this case, everything is ok.
File:LdihtOmrCheck00004.png|In this case, a part named "3004asdfghjk" is referenced. This is a "hard error", the file is not OMR compliant.
</gallery>

[[Category:LDInspector]]

LDInspector/HowtoBricklink

2024-03-27T19:28:21Z

Steffen: Steffen moved page LDInspector/HowtoBricklink to LDInspector - Bricklink Interoperation

#REDIRECT [[LDInspector - Bricklink Interoperation]]

LDInspector - Bricklink Interoperation

2024-03-27T19:28:21Z

Steffen: Steffen moved page LDInspector/HowtoBricklink to LDInspector - Bricklink Interoperation

Back to [[LDInspector]] main page.

== Howto: Get a part list from Bricklink and post-process it ==

<gallery mode="slideshow">
File:LdihtBricklink00001.png|Ensure having web cache enabled, therefore select "Config.".
File:LdihtBricklink00002.png|Ensure "Use cache for web resources" is selected and the field afterwards has a valid file-prefix or points to a valid directory (notice the "/" at the end).
File:LdihtBricklink00003.png|Select Web pane and enter search key, afterwards press "Ass. BL search".
File:LdihtBricklink00004.png|The first result is what we were looking for, so we want to get "Product" of this and remove ("X") the other two.
File:LdihtBricklink00005.png|Next is to request the inventory of the set by clicking "Inv.Reg.". For details about the difference between "Inv.Reg." and "Inv.All." see the text description of LDInspector.
File:LdihtBricklink00006.png|We get a bunch of parts, most of them are marked with a green circle indicating they are official parts. For the unofficial (orange) and missing (red) parts that have sub-inventories, activate "Inv.Reg.".
File:LdihtBricklink00007.png|At the end, we get a structured list for 8c02 having green indicators at leaf items.
File:LdihtBricklink00008.png|Same for the missing part pln025 at the list bottom.
File:LdihtBricklink00009.png|In the pln025 inventory there is no sub-inventory for the missing part 193au, so we need to search ourself for a replacement, therefore click "S" for the 193au Headgear Helmet.
File:LdihtBricklink00010.png|In the search window the first result is just what we were looking for, so we select it and press "OK".
File:LdihtBricklink00011.png|The replacement part is added below 193au, the 973c02 has a inventory - take care of the 981982 with red "missing" indicator. For this example, we "forget" to resolve this and consider the search done.
File:LdihtBricklink00012.png|At the top of the list, "C.List" button will create a new part list item at the workspace item list.
File:LdihtBricklink00013.png|The created list is expanded here, and for some reasons we now observe that we forgot to resolve the 981982 part that is not a LDraw part.
File:LdihtBricklink00014.png|Therefore select the list and go to the bottom of the web search result and "Inv.Reg." the 981982.
File:LdihtBricklink00015.png|After selecting "+SLI" for 981982 all sub-elements of this item are added to the part list.
File:LdihtBricklink00016.png|To remove the wrong 981982, select it in the part list and active Item pane, where you can "Remove item".
File:LdihtBricklink00017.png|Looking at the part list in the PartList pane, some of the parts are ~Moved. To resolve this, right click "CS" and select "Resolve ~moved parts".
File:LdihtBricklink00018.png|Done: a list of official parts created from the Bricklink database. This list can be exported by right-clicking "CS" or on the Item pane. Or just save the workspace to have this list always there.
</gallery>

[[Category:LDInspector]]

LDInspector/HowtoConfig

2024-03-27T19:27:59Z

Steffen: Steffen moved page LDInspector/HowtoConfig to LDInspector - Basic Configuration

#REDIRECT [[LDInspector - Basic Configuration]]

LDInspector - Basic Configuration

2024-03-27T19:27:59Z

Steffen: Steffen moved page LDInspector/HowtoConfig to LDInspector - Basic Configuration

Back to [[LDInspector]] main page.

== Howto: Do basic configuration ==

<gallery mode="slideshow">
File:LdihtConfig00001.png|On first start, click "Yes", later select "Config." to open workpsace configuration.
File:LdihtConfig00002.png|On the first start, the configuration looks like this. Select for each part source: official or unofficial? files in a directory or in a zip? Most likely you will also want to configure a web resource cache directory.
File:LdihtConfig00003.png|In the end, your configuration will perhaps look like this. If unsure, leave colors unchanged. After "OK", save the configuration. If the filename is "LDInspector.ldi", this configuration will be used on future program starts.
</gallery>

[[Category:LDInspector]]

Tutorial Landing Page

2024-03-27T19:26:26Z

Steffen: Steffen moved page Tutorial Landing Page to Tutorials on Other Servers

#REDIRECT [[Tutorials on Other Servers]]

Tutorials on Other Servers

2024-03-27T19:26:26Z

Steffen: Steffen moved page Tutorial Landing Page to Tutorials on Other Servers

<p>Welcome to the LDraw.org tutorials section. Here you can learn techniques to enhance your proficiency with various programs of the LDraw System Of Tools. Easy to follow step by step instructions teach you everything from using software programs to creating stunning renderings.</p>
<p>The tutorial section is constructed in a unique way to allow for easy expansion and addition of topics. We always have someone working on a new tutorial for LDraw.org. Courses are divided up into the following categories:</p>
<ul>
<li>{anchor anchor="modeling" text="Modeling"}</li>
<li>{anchor anchor="rendering" text="Rendering"}</li>
<li>{anchor anchor="building_instuctions" text="Building Instuctions"}</li>
<li>{anchor anchor="parts_authoring" text="Parts Authoring"}</li>
</ul>
<p>Within those categories there are levels - beginner, intermediate, and advanced. For more information on contributing to the tutorials section at LDraw.org, see the {anchor anchor="help out_write_tutorials_for_ldraw_org" text="bottom of the page"}.</p>
<h3 class="ui block header" id="modeling">Modeling</h3>
<p>Learn the essentials of putting your LEGO models into the LDraw format using a variety of LDraw-based editing programs.</p>
<h4>Beginner Modeling</h4>
<h5 id="ldraw_aioi"><a class="external" href="http://www.holly-wood.it/ldraw/aioi1-en.html" target="_blank">LDraw All-In-One-Installer tutorial</a></h5>
<p>Use the LDraw All-In-One-Installer, in short AIOI, if you want a quick and easy way to install the LDraw Parts Library and many of the popular 3rd party tools as well. In this tutorial written by Willy Tschager you'll get an overview on the differnent screens shown by the AIOI as well as some background information.</p>
<h5 id="omrize"><a href="omr_compliance">Preparing a MPD file for Official Model Repository compliance</a></h5>
<p>Preparing a model to follow the Official Model Repository specifications can be a daunting task, as there are many little details to take care of. Philippe "Philo"Hurbain guides you through the process.</p>
<h5 id="manuall_installation_advice"><a class="external" href="http://www.holly-wood.it/mlcad/install1-en.html" target="_blank">Manual installation advice for the LDraw Parts Library and MLCad</a></h5>
<p>This tutorial by Willy Tschager will teach you how to set up manually a simple LDraw system with the MLCad editor and the LDraw Parts Library.</p>
<h5 id="digital_building_with_mlcad"><a class="external" href="http://www.holly-wood.it/mlcad/basic1-en.html" target="_blank">Digital building with MLCad</a></h5>
<p>This tutorial will teach you the basics to build digital models in MLCad. Furthermore it will show you tips and tricks and help with troubleshooting problems you might encounter.</p>
<h5 id="changing_MLCads_language_interface"><a class="external" href="http://www.holly-wood.it/mlcad/language-en.html" target="_blank">Changing MLCad's language interface</a></h5>
<p>Tutorial on how to change the default language MLCad displays by Willy Tschager.</p>
<h5 id="mlcad_ini_file_for_the_minifig_generator"><a class="external" href="http://www.holly-wood.it/mlcad/mlcad_ini-en.html" target="_blank">MLCad.ini file for the Minifig Generator</a></h5>
<p>The MLCad.ini file tells the program - among other things - which parts are available in MLCad's and Bricksmith's minifigure generator.</p>
<h4>Intermediate Modeling</h4>
<h5 id="how_to_easily_rotate_a_group_of_parts_in_mlcad"><a class="external" href="http://www.holly-wood.it/mlcad/easyrotation-en.html" target="_blank">How to easily rotate a group of parts in MLCad</a></h5>
<p>Willy Tschager shows you an alternative, more visual approach to rotate a group of parts around a common self-defined rotation point using a helper part created for the purpose.</p>
<h5 id="using_lsynth_via_mlcad"><a class="external" href="http://www.holly-wood.it/lsynth/tutorial-en.html" target="_blank">Using LSynth via MLCad</a></h5>
<p>Tutorial on how setup and run LSynth through MLCad's interface by Willy Tschager.</p>
<h4>Advanced Modeling</h4>
<h5 id="advanced_digital_building"><a class="external" href="http://www.holly-wood.it/mlcad/advanced1-en.html" target="_blank">Advanced digital building with MLCad</a></h5>
<p>Everything you always wanted to know about Buffer-Exchange and MPD - Multipart Documents (but were afraid to ask). In this tutorial Willy Tschager teachs you advanced techniques to build digital models in MLCad. Furthermore he will show you tips and tricks and help with troubleshooting problems you might encounter. The tutorial is based on MLCad 3.4.</p>
<h5 id="unofficial_parts"><a class="external" href="http://www.holly-wood.it/mlcad/unofficial1-en.html" target="_blank">Adding unofficial LDraw parts to MLCad</a></h5>
<p>This tutorial will teach you how to add not yet certified LDraw parts to MLCad's parts library. It also covers other programs of the LDraw System of Tools and how they deal with unofficial parts. The tutorial is based on MLCad 3.4.</p>
<h5 id="how_to_build_a_formula_1_race_car_with_virtual_bricks"><a href="http://wiki.ldraw.org/index.php?title=Scaling_Down">How to build a Formula 1 race car with virtual bricks</a></h5>
<p>Luca Rusconi teaches you how to scale down a Formula 1 race car using official information about the chassis dimensions, the shape and geometry of the suspensions, the engine configuration, etc.</p>
<h3 class="ui block header" id="rendering">Rendering</h3>
<p>Orient yourself with the many complexities of creating high quality rendered models and scenes of your LDraw creations.</p>
<h4>Intermediate Rendering</h4>
<h5 id="quick_rendering_a_model_with_ldview_using_a_batch_file"><a class="external" href="http://www.holly-wood.it/ldview-en.html" target="_blank">Quick rendering a model with LDView using a batch file</a></h5>
<p>A tutorial on how to make a batch file to quick render a model in LDview by Willy Tschager.</p>
<h4>Advanced Rendering</h4>
<h5 id="building_an_army"><a href="article/440.html">Building an army</a></h5>
<p>Philip Heinrich teaches you how to create a winner for LDraw's Scene of the Month contest.</p>
<h3 class="ui block header" id="building_instuctions">Building Instructions</h3>
<p>Learning how to make building instructions so others can have fun with your models.</p>
<h4>Beginner Building Instuctions</h4>
<h5 id="helper_files_for_building_instruction_images"><a class="external" href="http://www.holly-wood.it/ldraw/helper-en.html" target="_blank">Helper files for building instruction images</a></h5>
<p>Ever wonder how to add "arrows", "dotted lines" and numbers to your building instructions? Obtain the tools from Willy Tschager's web site to build like the pros.</p>
<h5 id="working_with_lpub"><a class="external" href="https://sites.google.com/site/workingwithlpub/" target="_blank">Working with LPub</a></h5>
<p>A tutorial by Jaco van der Molen explaining how to work with LPub to make instructions</p>
<h5 id="creating_building_instructions_using_LPub"><a class="external" href="http://www.eurobricks.com/forum/index.php?showtopic=83642" target="_blank">Creating Building Instructions using LPub</a></h5>
<p>A step-by-step guide to creating your own instructions using LPub. It includes a short guide which walks through the basics of producing a set of instructions, as well as a full guide with more details on the main steps and features of LPub.</p>
<h3 class="ui block header" id="parts_authoring">Parts Authoring</h3>
<p>Learn how to create your own LDraw parts and how to submit them to the Parts Tracker for inclusion in our official updates.</p>
<h4>Beginner Parts Authoring</h4>
<h5 id="bits_and_pieces"><a class="external" href="http://www.holly-wood.it/ldraw/authoring-en.html" target="_blank">Bits and Pieces</a></h5>
<p>Here's a crash course by Willy Tschager in LDraw part authoring. Learn that you don't have to be a math guru or hack your way through a jungle of ones or zeros.</p>
<h5 id="reviewing_parts_for_ldraw"><a class="external" href="http://www.l3go.bugge.com/articles/Reviewing-parts-tutorial.shtml" target="_blank">Reviewing parts for LDraw</a></h5>
<p>Niels Bugge dives into the nuts'n'bolts of part reviewing and gives clues to ease the work of the reviewers.</p>
<h5 id="avoiding_tjunctions_in_ldraw_parts"><a href="http://wiki.ldraw.org/index.php?title=Avoiding_T-Junctions">Avoiding T-junctions in LDraw parts</a></h5>
<p>Travis Cobbs explains what T-Junctions in LDraw parts are and how you can avoid them.</p>
<h4>Intermediate Parts Authoring</h4>
<h5 id="edger_tutorial"><a class="external" href="http://philohome.com/isecalc/edger.htm" target="_blank">Edger tutorial</a></h5>
<p>Tutorial describing the use of Lee Gaiteri's Edger, an optional lines calculator (tutorial written by J.C. Tchang)</p>
<h3 class="ui block header" id="help out_write_tutorials_for_ldraw_org">Help Out! Write tutorials for LDraw.org</h3>
<p>We're looking for more good tutorials for the site to help out our new users and users who want to learn more. If you enjoy using the LDraw System Of Tools, this would be a great way to give back to the community! Tutorials only take an evening or two to write, so you're not killing yourself with a time commitment. The other cool thing is, no web skills are needed to write. Write your tutorial in plain text format, spacing out paragraphs, and zip up any images you create when you send it in. If this sounds like something you would like to do, drop the webmasters a line and let them know. Thanks!</p>

[[Category:Tutorial Website]]

Tutorials on Other Servers

2024-03-27T19:26:14Z

Steffen:

Tutorials on Other Servers

2024-03-27T19:25:19Z

Steffen:

LDInspector - Bricklink Interoperation

2024-03-27T19:24:40Z

Steffen:

LDraw.org Wiki

2024-03-27T19:24:22Z

Steffen:

[[File:Main-home.png]]

'''Welcome to the LDraw.org Wiki!'''

This wiki exists to provide a user-editable resource for tutorials, articles etc.
related to the [[LDraw]] System of Tools.

It is not intended to replace the [https://www.ldraw.org/docs-main.html Documentation section on ldraw.org], but to supplement it in a more interactive manner.

If you want to discuss LDraw topics, please use the [[LDraw Forum]] instead.

== Where to Start Reading? ==

Different options exist to browse through this Wiki:
* The articles in this Wiki are organized in [[categories]]. You can browse them top-down by starting at the "mother of all categories", the [[Main Index]].
* Use the full-text search in the top right search box.
* Look at the [[Special:Allpages|list of all articles]].
* Start at one of the most interesting categories:

::::{|
|-
|style="font-size: 1.5em; padding: 20px;"| [[LDraw.org]]
|style="font-size: 1.5em; padding: 20px;"| [[Software]]
|-
|style="font-size: 1.5em; padding: 20px;"| [[LDraw Files Syntax]]
|style="font-size: 1.5em; padding: 20px;"| [[Terms]]
|-
|style="font-size: 1.5em; padding: 20px;"| [[Help]]
|style="font-size: 1.5em; padding: 20px;"| [[Tutorials]]
|-
|style="font-size: 1.5em; padding: 20px;"| [[Books]]
|style="font-size: 1.5em; padding: 20px;"| [[Part Collections]]
|-
|}

LDInspector - Comparing Part Lists

2024-03-27T19:23:45Z

Steffen:

LDInspector - Fixing OMR Compliance Issues

2024-03-27T19:23:39Z

Steffen:

LDInspector - Checking for OMR Compliance

2024-03-27T19:23:32Z

Steffen:

LDInspector

2024-03-27T19:23:18Z

Steffen: Steffen moved page LDInspector to Category:LDInspector

#REDIRECT [[:Category:LDInspector]]

Category:LDInspector

2024-03-27T19:23:18Z

Steffen: Steffen moved page LDInspector to Category:LDInspector

'''LDInspector''' is an interactive and batch processing information retrieval software for LDraw models written by Stefan Frenz.

It was at first described at the [https://forums.ldraw.org/thread-23882.html LDraw forum], and
over time here will arise some kind of how-to and documentation of LDInspector. You may get it
[http://fam-frenz.de/stefan/ldi.html here].

== Installation ==

=== All systems ===

Get the [http://fam-frenz.de/stefan/ldi.html desired version] or the [http://fam-frenz.de/stefan/ldinsp.jar latest snapshot] of
LDInspector's jar file. Also get the [http://fam-frenz.de/stefan/ldiinst.zip installer] zip. Therein you will find a short
readme.txt as well as installer scripts for Linux (tested on XUbuntu and Mint) and Windows (tested on 8.1 and 10). If you already
have the ldinsp.jar file or like to get the latest one, just grab the installer and it will download the latest version of
ldinsp.jar during installation. Put the installer (and optionally the ldinsp.jar file) in a directory of your choice, start the
installer and after successful execution of the install script this directory will contain a portable version of LDInspector
(for the desired operating system only, of course).

Therefore the install script downloads an appropriate Java- and JavaFX-package from the web, extracts them and removes the original
package as well as some unneeded files.

=== Linux ===

After putting both ldinsp.jar and install_lin.sh (extracted from ldiinst.zip) in one directory, call install_lin.sh from the command
line to get the installation information, or just call it from your preferred file manager, if you don't need messages or have
notify-send installed (package notify-osd, installed by default). If so, all messages will additionally be shown on your UI, so you
really don't need a terminal.

=== Windows ===

After putting both ldinsp.jar and install_win.bat (extracted from ldiinst.zip) in one directory, start the install_win.bat file. If
you like to have it installed in "Program Files" or other access limited directories, you will have to have administrator privileges.
A terminal window will open up automatically and show progress messages. At the end the install scripts pauses until it is closed or
"Enter" is pressed.

=== MacOS ===

At the moment, the install script don't support MacOS directly. In the [https://forums.ldraw.org/thread-23882-post-36106.html#pid36106 forum]
it was reported to be possible to get it run.

== Basic Configuration ==

You may play with LDInspector without having [https://www.ldraw.org/parts/latest-parts.html LDraw libraries] installed. But typically
at the first start if LDInspector, you will want to configure LDraw paths. To do so, in the main window click "Config." (or click "yes" if LDInspector asks for configuration at startup). This opens a new window:

* Part sources may be configured by selecting an origin attribute (all parts of that source will be considered being official or unofficial), selecting a zip file or directory and then adding it. The part sources are used in an ordered way so that the first hit will be used - if you like to have official parts by default, move the corresponding entry to the top; if you like to have bleading edge unofficial parts by default, move this one to the top.
* Web cache is only important, if you use the Web tab or the Bricklink/Rebrickable image preview in PartList tab. But if you use those, ensure to have caching activated and to have a valid cache file prefix, usually a directory.
* Color definitions are integrated in LDInspector, but you may overwrite all colors and color-mappings.

After having configured everything and having pressed the OK button, save your configuration via "Save" button in the main window. This will contain the basic configuration as well as the current item list, so you may add some items and save again.

== Howtos ==

* [[LDInspector/HowtoConfig]] How to do basic configuration.
* [[LDInspector/HowtoBricklink]] How to get a part list from Bricklink and post-process it.
* [[LDInspector/HowtoPartlistCompare]] How to compare multiple part lists and/or models with each other.
* [[LDInspector/HowtoOmrCheck]] How to check models against [https://omr.ldraw.org/ OMR] compliance.
* [[LDInspector/HowtoOmrFix]] How to automatically fix [https://omr.ldraw.org/ OMR] compliance issues.

== UI Conception ==

Hopefully, you get the ui conception without reading this. ;) But just in case: the main window is divided in three sections:

On top contains some buttons
* to configure the workspace ("Load", "Config.", "Save"),
* to clear or add a new item to the item list ("Clear", "Part-List", "Part", "File", "Directory"), or
* to cause LDInspector to do something ("Refresh", "Info", "Exit").

On the left there is the item list. You may always select exactly one item, some of them like directory items may have sub-items. At the
moment there are four types of items:

* Part-List: use this to hold a set of parts which you maybe like to change ("editable"). You can add and remove parts, change their color and amount. Main use case: prepare a part list that can be used in other scenarios like LDCad construction or Bricklink shopping.
* Part: use this to reference a part. You can change the reference name, the color and amount. Main use case: inspect a single part you are interested in.
* File: use this to reference a file. You can not change anything, the content is loaded on demand from the file system. Main use case: do something with a ldr/mpd file like OMR-checking or reference a part list on disk.
* Directory: use this to reference a directory. You can not change anything, the directory content is loaded on demand from the file system and is recursively browsable. Main use case: point to a directory with all your models and access them fast and easily.

On the right there is a tabbed pane, at the top you select what you would like to do:

* Item: get basic information about the selected item. Here you may remove this single item from your item list ("Remove item"), refresh its content ("Refresh item", for example after changing a file in another program), change its name, and depending on the item type there are other actions available:
** Part-List: you can add a "new empty" part to an editable part list, trigger part sorting or export the list to PBG file (for example to build a model with those parts in LDCad) or to XML file (for example if you with to buy those parts at Bricklink).
** Part or file pointing to a part or model: you may export the part to Wavefront OBJ (for example for further processing or giving a 3D model to someone who has one of the free OBJ viewers but nothing in mind with LDraw), export the part with all transitively used parts to a zip file (for example if you wish to give a model to someone without the required parts).
** Directory: there is nothing more to do.
* OMR-Check: if you selected a model, LDInspector performs some checks and reports their results in the text area. At the moment there is no "quick-fix" feature available (planned in a future version).
* Render: get a preview of the model you selected. Note that there are several non-self-explanatory options:
** Displayed lines: you may select between several options how many lines should be drawn. As the rendering pipeline of JavaFX does not support lines unfortunately, each line results in 12 triangles to be rendered. For large models this is very expensive and usually not required.
** Color: you may override the color of the selected item to a fixed one (will only change "parent" color, so if there are defined colors in a part or model, they will not be replaced) or to select color depending on checks:
*** OMR-Checks: each part contributing to a OMR check message will be colored in blue (hint), orange (warn), red (solvable error) or magenta (hard error). All other parts are green (ok).
*** Collision: each part is colored in either green (ok) or magenta (colliding). Please note that this test is in pre-alpha state and very time consuming for large models.
** Show steps: you can select shown steps by entering "from" and "to" numbers; having the "from" number set to 1, the rendering shows the model up to the step entered in "to"; having both numbers identically set, the rendering shows only those parts added in this step.
* PartList: you get a list for all parts in the selected item - either a part list or a LDraw model. There are lots of use cases, see below.
* PartGrid: you get a very short and read-only overview of all parts in the selected item - either a part list or a LDraw model.
* UsedFiles: all transitively used parts are shown in the text area, for example if you want to check if there are "unwanted" parts or if you like to process them with another tool.
* Source: just print the source code of the selected item.
* Search: search a part by filename, description, author or origin. If you selected an editable part list in the item list and you found the part you were looking for, you may add this directly to your part list.
* Web: get information about sets from Bricklink and Rebrickable. See use cases below.
* Log: if something went wrong or if you are interested in statistics, take a look.

== Use cases ==

=== Check OMR compliance ===

# Ensure you have your LDraw paths configured correctly (see "Basic Configuration" above).
# Add a file reference or directory reference to your workspace.
# Select OMR-Check tab.
# You'll get a short overview of all checks done, each having one of the following states:
## ign: the check is started but did nothing, perhaps because this check is not available for the selected item.
## ok: the check didn't find anything to grump about.
## hint: maybe (!) there is something that could be optimized, but as per definition, it is ok. Maybe the hint is to be ignored with reason, like having a part in a specific color even if the part name contains "tyre".
## warn: there is something that should be optimized, for example the model contains a sub-file that is never used.
## error: there is something that has to be fixed because it violates the OMR rules, for example if a referenced part is not found.
# At the moment, you will have to edit your file with some other tool. There are plans enabling LDInspector to offer quick-fix options for problems that can be fixed automatically like missing license lines.

=== Get inventories from external sources ===

# Ensure you have your LDraw paths configured correctly (see "Basic Configuration" above).
# Most likely you will want to have web cache path cofigured (see "Basic Configuration" above).
# Select Web-Check tab.
# Enter your set number in the "key" field.
# Search Bricklink and/or Rebrickable with one of the following (or do all of them by clicking "All"):
## Ass. BL search: search Bricklink as if entered in the Bricklink search on the main page.
## Full BL product search: search Bricklink for products listed with the given key.
## Ass. RB search: search Rebrickable as if entered in the Rebrickable search on the main page.
## RB set search: at Rebrickable directly look for a set with the given key.
# Recursively dive into the results. If done, you can add single parts to an editable part list or create a complete new part list.

Handling and diving into results may be done with the following actions:
* "X": delete this item.
* "Img.": load an image for this item if available.
* "Product" (only Bricklink results): get product information about this item.
* "Un.Inv.": remove sub-items of this item.
* "Inv.Reg." (only Bricklink inventories): get regular items of this inventory item.
* "Inv.All." (only Bricklink inventories): get all items of this inventory item. Attention: this may contain duplicates, but simplifies searching alternate parts.
* "Set" (only Rebrickable results): get set information about this item.
* "PBG" (only Rebrickable sets): download the official PBG file from Rebrickable for this set.
* "Inventory" (only Rebrickable sets): get items of this inventory item.
* "S" (only part results): search in the LDraw library for a replacement part (similar to Search tab).
* "+WS" (only part results): add this part as part item to the workspace. The circle color in this button reports about
** green: official LDraw part found for this entry.
** orange: unofficial LDraw part found for this entry.
** red: no LDraw part found for this entry.
* "+LI" (only part results): add this entry as part to the selected editable part list.

If you like to have all images as soon as possible and all next to a description, select "Img.: integrated" and press "Load all images" if there are new items without image.

=== Handle a bunch of models ===

To your item list add a directory item pointing to the directory containing the models or sub-directories with models. Maybe save your workspace configuration if this directory is looked after more often. By clicking the triangle in front of the directory item's name, the sub-elements can be used directly for all other use cases.

[[Category:Software]]

LDInspector - Basic Configuration

2024-03-27T19:23:09Z

Steffen:

Web sites

2024-03-27T19:20:47Z

Steffen: Changed redirect target from Category:Website to Category:Websites

#redirect [[:Category:Websites]]

Websites

2024-03-27T19:20:42Z

Steffen: Changed redirect target from Category:Website to Category:Websites

#redirect [[:Category:Websites]]

Web site

2024-03-27T19:20:38Z

Steffen: Changed redirect target from Category:Website to Category:Websites

#redirect [[:Category:Websites]]

Website

2024-03-27T19:20:34Z

Steffen: Changed redirect target from Category:Website to Category:Websites

#redirect [[:Category:Websites]]

GitHub

2024-03-27T19:20:14Z

Steffen:

'''GitHub''' is an online service for hosting revision-controlled [[Git]] repositories.
For more details, see {{Wikipedia|GitHub}}.

Several LDRAW software stores its source code there,
and some people even uploaded the [[Parts Library]] there.

[[Category:Websites]]

BrickLink

2024-03-27T19:20:07Z

Steffen:

'''BrickLink''' (originally named '''BrickBay''') is an online platform originally founded in 2000 by [[Dan Jezek]] to connect LEGO fans worldwide.
The site became the largest fan-run marketplace of LEGO parts, sets, minifigures from then.

== History ==

* 2000: Originally named BrickBay, the site starts operation on 2000-06-19<ref>https://www.bricklink.com/help.asp?helpID=232</ref>.
* 2002: After eBay issued a cease-and-desist letter over the use of "Bay" in the name, it is renamed to "BrickLink"<ref>https://www.danjezek.com/bricklink.html</ref>.
* 2010: Dan Jezek dies in an accident, the site is continued by his family<ref>https://brickipedia.fandom.com/wiki/BrickLink</ref>.
* 2013: NXMH (owned by Korean entrepreneur Jung-Ju “Jay” Kim) buys the site<ref name=bl>https://lan.lego.com/news/overview/the-lego-group-acquires-bricklink</ref>.
* 2019: LEGO announces on 2019-11-26 that it has acquired the site<ref name=bl /><ref>https://brickset.com/article/47293/the-lego-group-acquires-bricklink</ref><ref>https://www.brothers-brick.com/2019/11/26/news-the-lego-group-acquires-bricklink-from-nexon-founder-jay-kim-for-undisclosed-sum-interview-with-lego-cmo-julia-goldin/</ref>.

== See Also ==

* [https://bricklink.com bricklink.com ]
* [https://www.bricklink.com/v3/about.page bricklink.com History]

== References ==

<references />

[[Category:Websites]]

Category:Tutorial Website

2024-03-27T19:20:01Z

Steffen:

[[Category:Tutorials]]
[[Category:Websites]]

Category:LDraw.org

2024-03-27T19:19:55Z

Steffen:

Category:Websites

2024-03-27T19:19:34Z

Steffen: Steffen moved page Category:Website to Category:Websites

This category collects '''important LDRAW-related websites'''.

[[Category:Main Index]]

LDraw.org Wiki

2024-03-27T19:14:29Z

Steffen:

Eyesight

2024-03-27T17:04:54Z

Steffen:

[[Image:eyesight.png]]

'''Eyesight''' is the 3D renderer integrated into [[BrickLink Studio]] for creating photorealistic images.

(Another renderer integrated in that tool is [[POV-Ray]].)

Eyesight is a command-line tool spawned by Studio when you are triggering a rendering from its user interface.
It can be run standalone manually if you specify the correct options.

To see a list of all available options, invoke it from the command line with this parameter:
eyesight.exe --help

Note that that executable can be found in a subfolder e.g. <code>PhotoRealisticRenderer\win\64</code>.

== What is Eyesight? ==

You can learn from the <code>COPYING.txt</code> file delivered with BrickLink Studio that
Eyesight is based on the open source "Cycles" renderer
* https://www.cycles-renderer.org

The version integrated in BrickLink Studio 2.24.2_4 is Eyesight 2.2.5.0 which claims to be derived from Cycles 1.9.0.

It has been adapted for BrickLink Studio by KOG Corporation.

Cycles is a renderer which is part of [[Blender]]. Its source code can be found at
* https://projects.blender.org/blender/cycles

== See Also ==

* [[POV-Ray]]
* [[Blender]]

[[Category:Software]]

Eyesight

2024-03-27T16:59:39Z

Steffen: /* What is Eyesight? */

[[Image:eyesight.png]]

'''Eyesight''' is the 3D renderer integrated into [[BrickLink Studio]] for creating photorealistic images.

(Another renderer integrated in that tool is [[POV-Ray]].)

Eyesight is a command-line tool spawned by Studio when you are triggering a rendering from its user interface.
It can be run standalone manually if you specify the correct options.

To see a list of all available options, invoke it from the command line with this parameter:
eyesight.exe --help

Note that that executable can be found in a subfolder e.g. <code>PhotoRealisticRenderer\win\64</code>.

== What is Eyesight? ==

You can learn from the <code>COPYING.txt</code> file delivered with BrickLink Studio that
Eyesight is based on the open source "Cycles" renderer
* https://www.cycles-renderer.org

The version integrated in BrickLink Studio 2.24.2_4 is Cycles 1.9.0.

It has been adapted for BrickLink Studio by KOG Corporation.

Cycles is a renderer which is part of [[Blender]]. Its source code can be found at
* https://projects.blender.org/blender/cycles

== See Also ==

* [[POV-Ray]]
* [[Blender]]

[[Category:Software]]

Eyesight

2024-03-27T16:58:32Z

Steffen:

[[Image:eyesight.png]]

'''Eyesight''' is the 3D renderer integrated into [[BrickLink Studio]] for creating photorealistic images.

(Another renderer integrated in that tool is [[POV-Ray]].)

Eyesight is a command-line tool spawned by Studio when you are triggering a rendering from its user interface.
It can be run standalone manually if you specify the correct options.

To see a list of all available options, invoke it from the command line with this parameter:
eyesight.exe --help

Note that that executable can be found in a subfolder e.g. <code>PhotoRealisticRenderer\win\64</code>.

== What is Eyesight? ==

You can learn from the <code>COPYING.txt</code> file delivered with BrickLink Studio that
Eyesight is based on the open source "Cycles" renderer
* https://www.cycles-renderer.org

The version integrated in BrickLink Studio 2.24.2_4 is Cycles 1.9.0.

It has been adapted for BrickLink Studio by KOG Corporation.

== See Also ==

* [[POV-Ray]]
* [[Blender]]

[[Category:Software]]