Getting Started - Linux: Difference between revisions
(move disclaimer) |
(Tweak) |
||
(14 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
<!-- | |||
TODO: | |||
the information on this page needs to be split up into the several pieces, | |||
for example all documentation about LDView should go onto LDView's wiki page, not here! | |||
remove everything here which duplicates http://www.ldraw.org/help/getting-started.html | |||
--> | |||
==Download and Install the LDraw parts Library== | ==Download and Install the LDraw parts Library== | ||
Line 6: | Line 17: | ||
*Extract the <code>complete.zip</code> archive in the directory of your choice - your home directory is recommended for simplicity (<code>~/ldraw/</code>). | *Extract the <code>complete.zip</code> archive in the directory of your choice - your home directory is recommended for simplicity (<code>~/ldraw/</code>). | ||
====Updating your parts list==== | |||
If, for any reason you have decided to alter the original parts directory (<code>~/ldraw/parts.lst</code>), Nathanel Titane has made a Linux native 'mklist.exe' equivalent: 'make-list'. | If, for any reason you have decided to alter the original parts directory (<code>~/ldraw/parts.lst</code>), Nathanel Titane has made a Linux native 'mklist.exe' equivalent: 'make-list'. | ||
Line 16: | Line 27: | ||
'''Note:''' If present, the previous version of the 'parts.lst' file will be backed up. | '''Note:''' If present, the previous version of the 'parts.lst' file will be backed up. | ||
=== | ==Install an editor== | ||
===LeoCAD (recommended)=== | |||
Leonardo Zide's LeoCAD is readily available for install for both Debian and Red Hat based distributions. You can download a no-install AppImage from https://www.leocad.org/download.html (recommended), alternatively, you can install the editor by looking for and installing the <code>leocad</code> package using your preferred package manager or command package management tool. | |||
*Install LeoCAD: | |||
**All systems (AppImage method, recommended): Go to https://www.leocad.org/download.html, select "Download LeoCAD for Linux", make the AppImage executable (<code>chmod +x</code>), and double-click to run. | |||
* | **APT-based systems (e.g. Ubuntu, Mint): <code>sudo apt-get install leocad</code> | ||
* | **YUM-based systems (e.g. Fedora): <code>sudo yum install leocad</code> | ||
*Run LeoCAD and point it to the LDraw parts library: | |||
* | |||
**Go to View > Preferences... and set your library directory by either typing it in the field or browsing to it via '...'. Make sure to select the topmost directory (normally 'ldraw') that contains the 'parts' directory. | **Go to View > Preferences... and set your library directory by either typing it in the field or browsing to it via '...'. Make sure to select the topmost directory (normally 'ldraw') that contains the 'parts' directory. | ||
'''Notes:''' | |||
*LeoCAD can use either a zip file or a regular folder as its parts library directory. | |||
*You can start Leocad with a different library setup using: <code>$ leocad -l <library directory path></code> | |||
*LeoCAD also supports setting the library path as a system environment variable like so: <code>$ set LEOCAD_LIB=<library directory path></code> | |||
*LeoCAD supports redirection to the official LDraw parts library. If you have downloaded and/or set up the LDraw parts directory on your system, you can modify LeoCAD's preferences to use your library directory as its parts database. To do so, navigate to View > Preferences and browse to the corresponding directory under the 'Custom parts library' field. | |||
''' | |||
===LDCad=== | ===LDCad=== | ||
Line 71: | Line 54: | ||
*Run LDCad, follow the prompts and point it to the LDraw parts library. Make sure to select the topmost directory (normally 'ldraw') that contains the 'parts' directory. | *Run LDCad, follow the prompts and point it to the LDraw parts library. Make sure to select the topmost directory (normally 'ldraw') that contains the 'parts' directory. | ||
'''Note: | '''Note:''' LDCad assumes you have GTK2 installed (just about any distro should have it). Make sure you have installed the required packages and libraries to avoid any issues. | ||
'''LDCad assumes you have GTK2 installed (just about any distro should have it). Make sure you have installed the required packages and libraries to avoid any issues. | |||
===LDGLite=== | ===LDGLite=== | ||
Line 82: | Line 64: | ||
*Run LDGlite, right click on its background to get started. | *Run LDGlite, right click on its background to get started. | ||
''' | '''Notes:''' | ||
*Make sure that the binary is set as executable before attempting to run it: <code>$ sudo chmod +x ldglite</code> | |||
*This specific standalone requires libraries such as the DRI-accelerated OpenGL libraries, glut, glu, libpng and zlib to be installed. | |||
*If, for whatever reason LDGlite fails to start by clicking on the binary, you may run it via a terminal and verify its output, like so: <code>./ldglite</code> | |||
===MLCAD (Hybrid setup)=== | ===MLCAD (Hybrid setup)=== | ||
*Install [http://www.winehq.org/ Wine] via your distribution's package manager or application repository. | *Install [http://www.winehq.org/ Wine] via your distribution's package manager or application repository. | ||
** | **APT-based systems (e.g. Ubuntu, Mint): <code>sudo apt-get install wine</code> | ||
** | **YUM-based systems (e.g. Fedora): <code>sudo yum-install wine</code> | ||
*Download the [http://mlcad.lm-software.com/MLCad_V3.40.zip MLCad archive]. | *Download the [http://mlcad.lm-software.com/MLCad_V3.40.zip MLCad archive]. | ||
*Extract the <code>MLCad_V3.40.zip</code> archive in the directory of your choice - your home directory is recommended to avoid any file permission conflict or having to tamper with your system as 'root'. | *Extract the <code>MLCad_V3.40.zip</code> archive in the directory of your choice - your home directory is recommended to avoid any file permission conflict or having to tamper with your system as 'root'. | ||
Line 109: | Line 79: | ||
**Select Wine as the default method to open an executable on your system and proceed with the previously mentioned steps. | **Select Wine as the default method to open an executable on your system and proceed with the previously mentioned steps. | ||
'''Note: | '''Note:''' MLCad runs exceptionally well ([http://appdb.winehq.org/objectManager.php?sClass=application&iId=1354 Platinum status on Wine's AppDB scale]). Any encountered problem, whatever it may be, should be troubleshooted or reported to the Wine developers as they are responsible for maintaining Wine's underlying code base that makes running Windows executables on Linux distributions possible. | ||
'''MLCad runs exceptionally well ( | |||
==Additional applications== | |||
== | ===LPub3D=== | ||
LPub3D is Trevor Sandy's continuation and modernization of Kevin Clague's LDraw building instruction editor. This tool is extremely powerful as it enables the creation of highly detailed, professional looking instructions. It uses external rendering applications to generate the model's step thumbnails to be included in the document. Both LDView and LDGlite are supported. | |||
The latest version can be found as a no-installation-required AppImage at https://github.com/trevorsandy/lpub3d/releases; download <code>LPub3D-<version>-x86_64.AppImage</code>, set it as executable (<code>chmod +x</code>), and double click to open. | |||
===LDView=== | ===LDView=== | ||
Line 120: | Line 93: | ||
LDView, by Travis Cobbs, is a real-time 3D viewer for displaying LDraw models using hardware-accelerated 3D graphics. It is an essential tool in the creation of a model as it can be used to view and debug, in real-time and with full 3D graphics capacity, the model currently being edited (using the auto-update polling preference). It can also generate snapshots of the displayed content or of specific selected views of the given model. LDView is native to the Linux platform and is readily available for install for both Debian and Red Hat based distributions. | LDView, by Travis Cobbs, is a real-time 3D viewer for displaying LDraw models using hardware-accelerated 3D graphics. It is an essential tool in the creation of a model as it can be used to view and debug, in real-time and with full 3D graphics capacity, the model currently being edited (using the auto-update polling preference). It can also generate snapshots of the displayed content or of specific selected views of the given model. LDView is native to the Linux platform and is readily available for install for both Debian and Red Hat based distributions. | ||
*Download the latest installer package from LDView's [http://ldview.sourceforge.net/Downloads.html#Linux4200B1 | *Download the latest installer package from LDView's [http://ldview.sourceforge.net/Downloads.html#Linux4200B1 downloads page]. | ||
*Install LDView by using your preferred package manager or command package management tool | *Install LDView by using your preferred package manager or command package management tool. | ||
''' | '''Notes:''' | ||
''' | |||
''' | '''APT-based systems (e.g. Ubuntu, Mint):''' Your system may complain about either missing packages or unresolved dependencies. You may resolve these by running a "fix install" fix like so: <code>$ sudo apt-get -f install</code> | ||
'''YUM-based systems (e.g. Fedora):''' LDView's Linux maintainer, Peter Bartfai, has an [http://download.opensuse.org/repositories/home:/pbartfai/ LDView repository] set up using the OpenSuse build server system, from which you can get the latest LDView version, provided you add the yum repository information as follows: | |||
<code> $ sudo cat > /etc/yum.repos.d/ldview.repo << FILE<br> | <code> $ sudo cat > /etc/yum.repos.d/ldview.repo << FILE<br> | ||
Line 134: | Line 109: | ||
enabled=1<br> | enabled=1<br> | ||
gpgcheck=0<br> | gpgcheck=0<br> | ||
FILE | FILE</code> | ||
</code> | |||
'''Tip: | '''Tip:''' The variable <code>"$(rpm -E %fedora)"</code> refers to RPM's way (on the Fedora distribution) of finding the current version and attributing the proper number to the URL. | ||
'''The variable <code>"$(rpm -E %fedora)"</code> refers to | |||
'''Note:''' The OpenSUSE build server team automatically generates the configurations for upcoming or newer versions of any supported Red Hat distribution, ONLY when those distribution versions are finalized, stable and made available to the public. | |||
'''Note:''' | |||
===LDraw Linux Command Line Utilities (L2CU)=== | ===LDraw Linux Command Line Utilities (L2CU)=== | ||
Line 165: | Line 121: | ||
These tools are especially suited for bulk model file updates, upgrades or modifications: you can attend to deprecated or modified parts in an especially effective manner by: | These tools are especially suited for bulk model file updates, upgrades or modifications: you can attend to deprecated or modified parts in an especially effective manner by: | ||
* replacing | * replacing an old part entry by a newer one | ||
* replacing a specified color by a | * replacing a specified color by a different one | ||
* replacing a specific part's color with a new color | * replacing a specific part's color with a new color | ||
''' | '''Notes:''' | ||
*The use of these utilities assumes that the user has previously tested the part/color replacement option manually before parsing all files in bulk.''' | |||
*This application assumes that the model files to be edited abide by the LDraw ldr/mpd file specification.''' | |||
To get the utilities, please visit the dedicated | To get the utilities, please visit the dedicated Github page: [http://github.com/nathaneltitane/ldraw LDraw Utilities Github repository] | ||
<!-- | |||
Not really directly applicable to this page | |||
===Buf3D/Buf3D+ (Android)=== | ===Buf3D/Buf3D+ (Android)=== | ||
Buf3D is an application aimed at bringing the most actual developments of OpenGL technology for model viewing purposes to the Android mobile platform. | Buf3D is an application aimed at bringing the most actual developments of OpenGL technology for model viewing purposes to the Android mobile platform. Among many of its supported file formats and model viewing features it includes the ability to view LDraw models. It will prompt you to make use (online) or download of the official LDraw parts library. | ||
The newly released Buf3D+ is a bugfix and ad-free version of the initial Buf3D application. Purchasing this version of the application would be of great help in enticing the developer to optimize the current state of the application, updating the framework to the latest Android standards and possibly adding requested features to make it even more formidable. | The newly released Buf3D+ is a bugfix and ad-free version of the initial Buf3D application. Purchasing this version of the application would be of great help in enticing the developer to optimize the current state of the application, updating the framework to the latest Android standards and possibly adding requested features to make it even more formidable. | ||
Line 184: | Line 144: | ||
* Buf3D+ on the [https://play.google.com/store/apps/details?id=com.cimplus.buf3dp Google Play Store] | * Buf3D+ on the [https://play.google.com/store/apps/details?id=com.cimplus.buf3dp Google Play Store] | ||
'''Note:''' | '''Note:''' | ||
'''The author of this wiki, Nathanel Titane, has contacted the application developer to help enhance the application and bring it to the latest Android and LDraw compatibility standards. The current version is highly efficient in displaying models, though it can still benefit much improvement in the likes of parts database updating and OpenGL shader display functions. Stay tuned!''' | '''The author of this wiki, Nathanel Titane, has contacted the application developer to help enhance the application and bring it to the latest Android and LDraw compatibility standards. The current version is highly efficient in displaying models, though it can still benefit much improvement in the likes of parts database updating and OpenGL shader display functions. Stay tuned!''' | ||
--> | |||
==Dive in== | ==Dive in== | ||
Line 196: | Line 157: | ||
==Disclaimer== | ==Disclaimer== | ||
The author(s) of this Wiki hereby releases himself/themselfs of any responsibility consequent of the actions taken by any user inside or outside of the specified information and steps listed within this Wiki. | The author(s) of this Wiki hereby releases himself/themselfs of any responsibility consequent of the actions taken by any user inside or outside of the specified information and steps listed within this Wiki. | ||
[[Category:Linux]] | [[Category:Linux]] | ||
[[Category:Tutorials]] | [[Category:Tutorials]] |
Latest revision as of 22:05, 28 April 2018
Download and Install the LDraw parts Library
Basic setup (applies to any Linux distribution or operating system - Recommended approach)
- Download the latest
complete.zip
from LDraw.org download page. - Extract the
complete.zip
archive in the directory of your choice - your home directory is recommended for simplicity (~/ldraw/
).
Updating your parts list
If, for any reason you have decided to alter the original parts directory (~/ldraw/parts.lst
), Nathanel Titane has made a Linux native 'mklist.exe' equivalent: 'make-list'.
The make-list utility operates exactly like its Windows counterpart, and generates a 'parts.lst' file that can be either sorted by part number or part description.
- Download the utility here (right click: 'Save link as...')
- Save the utility as 'make-list' to your LDraw parts library directory (
~/ldraw/
). - Run the utility in the terminal:
chmod +x make-list && ./make-list
and follow the prompts.
Note: If present, the previous version of the 'parts.lst' file will be backed up.
Install an editor
LeoCAD (recommended)
Leonardo Zide's LeoCAD is readily available for install for both Debian and Red Hat based distributions. You can download a no-install AppImage from https://www.leocad.org/download.html (recommended), alternatively, you can install the editor by looking for and installing the leocad
package using your preferred package manager or command package management tool.
- Install LeoCAD:
- All systems (AppImage method, recommended): Go to https://www.leocad.org/download.html, select "Download LeoCAD for Linux", make the AppImage executable (
chmod +x
), and double-click to run. - APT-based systems (e.g. Ubuntu, Mint):
sudo apt-get install leocad
- YUM-based systems (e.g. Fedora):
sudo yum install leocad
- All systems (AppImage method, recommended): Go to https://www.leocad.org/download.html, select "Download LeoCAD for Linux", make the AppImage executable (
- Run LeoCAD and point it to the LDraw parts library:
- Go to View > Preferences... and set your library directory by either typing it in the field or browsing to it via '...'. Make sure to select the topmost directory (normally 'ldraw') that contains the 'parts' directory.
Notes:
- LeoCAD can use either a zip file or a regular folder as its parts library directory.
- You can start Leocad with a different library setup using:
$ leocad -l <library directory path>
- LeoCAD also supports setting the library path as a system environment variable like so:
$ set LEOCAD_LIB=<library directory path>
- LeoCAD supports redirection to the official LDraw parts library. If you have downloaded and/or set up the LDraw parts directory on your system, you can modify LeoCAD's preferences to use your library directory as its parts database. To do so, navigate to View > Preferences and browse to the corresponding directory under the 'Custom parts library' field.
LDCad
- Go to LDCad's download page
- Select and download the latest generic archive of the LDCad editor.
- Extract the archive in the directory of your choice - your home directory (or a subfolder of it) is recommended for simplicity.
- Run LDCad, follow the prompts and point it to the LDraw parts library. Make sure to select the topmost directory (normally 'ldraw') that contains the 'parts' directory.
Note: LDCad assumes you have GTK2 installed (just about any distro should have it). Make sure you have installed the required packages and libraries to avoid any issues.
LDGLite
LDglite is only available as a standalone 64bit binary for Linux. Compared to the other editors, it does pale in comparison to the amount of features present on the more modern ones. If for curiosity's sake you still want to install it, proceed as follows:
- Download the LDGLite binary archive
- Extract the archive in the directory of your choice - your home directory is recommended to avoid any file permission conflict or having to tamper with your system as 'root'.
- Run LDGlite, right click on its background to get started.
Notes:
- Make sure that the binary is set as executable before attempting to run it:
$ sudo chmod +x ldglite
- This specific standalone requires libraries such as the DRI-accelerated OpenGL libraries, glut, glu, libpng and zlib to be installed.
- If, for whatever reason LDGlite fails to start by clicking on the binary, you may run it via a terminal and verify its output, like so:
./ldglite
MLCAD (Hybrid setup)
- Install Wine via your distribution's package manager or application repository.
- APT-based systems (e.g. Ubuntu, Mint):
sudo apt-get install wine
- YUM-based systems (e.g. Fedora):
sudo yum-install wine
- APT-based systems (e.g. Ubuntu, Mint):
- Download the MLCad archive.
- Extract the
MLCad_V3.40.zip
archive in the directory of your choice - your home directory is recommended to avoid any file permission conflict or having to tamper with your system as 'root'.- Run MLCad by selecting
MLCAD.exe
and follow the usual prompts (LDraw parts library directory location and file type registration setup) - Select Wine as the default method to open an executable on your system and proceed with the previously mentioned steps.
- Run MLCad by selecting
Note: MLCad runs exceptionally well (Platinum status on Wine's AppDB scale). Any encountered problem, whatever it may be, should be troubleshooted or reported to the Wine developers as they are responsible for maintaining Wine's underlying code base that makes running Windows executables on Linux distributions possible.
Additional applications
LPub3D
LPub3D is Trevor Sandy's continuation and modernization of Kevin Clague's LDraw building instruction editor. This tool is extremely powerful as it enables the creation of highly detailed, professional looking instructions. It uses external rendering applications to generate the model's step thumbnails to be included in the document. Both LDView and LDGlite are supported.
The latest version can be found as a no-installation-required AppImage at https://github.com/trevorsandy/lpub3d/releases; download LPub3D-<version>-x86_64.AppImage
, set it as executable (chmod +x
), and double click to open.
LDView
LDView, by Travis Cobbs, is a real-time 3D viewer for displaying LDraw models using hardware-accelerated 3D graphics. It is an essential tool in the creation of a model as it can be used to view and debug, in real-time and with full 3D graphics capacity, the model currently being edited (using the auto-update polling preference). It can also generate snapshots of the displayed content or of specific selected views of the given model. LDView is native to the Linux platform and is readily available for install for both Debian and Red Hat based distributions.
- Download the latest installer package from LDView's downloads page.
- Install LDView by using your preferred package manager or command package management tool.
Notes:
APT-based systems (e.g. Ubuntu, Mint): Your system may complain about either missing packages or unresolved dependencies. You may resolve these by running a "fix install" fix like so: $ sudo apt-get -f install
YUM-based systems (e.g. Fedora): LDView's Linux maintainer, Peter Bartfai, has an LDView repository set up using the OpenSuse build server system, from which you can get the latest LDView version, provided you add the yum repository information as follows:
$ sudo cat > /etc/yum.repos.d/ldview.repo << FILE
[ldview]
name=LDView Repository
baseurl=http://download.opensuse.org/repositories/home:/pbartfai/Fedora_$(rpm -E %fedora)/
gpgkey=http://download.opensuse.org/repositories/home:/pbartfai/Fedora_$(rpm -E %fedora)/repodata/repomd.xml.key
enabled=1
gpgcheck=0
FILE
Tip: The variable "$(rpm -E %fedora)"
refers to RPM's way (on the Fedora distribution) of finding the current version and attributing the proper number to the URL.
Note: The OpenSUSE build server team automatically generates the configurations for upcoming or newer versions of any supported Red Hat distribution, ONLY when those distribution versions are finalized, stable and made available to the public.
LDraw Linux Command Line Utilities (L2CU)
L2CU is a set of command line utilities developed By Nathanel Titane to enable bulk LDraw model file parsing, editing, exporting, conversion and upload (to Sketchfab.com) without the direct need to use an LDraw CAD editor (though it needs to be installed to enable certain application features). Amongst certain modification options, the user can have parts, colors and/or part's colors, for any ldr and/or mpd file modified to his/her choice, within a selected directory.
These tools are especially suited for bulk model file updates, upgrades or modifications: you can attend to deprecated or modified parts in an especially effective manner by:
- replacing an old part entry by a newer one
- replacing a specified color by a different one
- replacing a specific part's color with a new color
Notes:
- The use of these utilities assumes that the user has previously tested the part/color replacement option manually before parsing all files in bulk.
- This application assumes that the model files to be edited abide by the LDraw ldr/mpd file specification.
To get the utilities, please visit the dedicated Github page: LDraw Utilities Github repository
Dive in
Learning how to use your new editor or understanding the LDraw file format may be a challenge, but with a little practice you will get the hang of it. Take a look at the tutorials on the wiki or on the main website for further help.
Help
Forums are also a great way to discuss techniques, issues or features of editors or applications used to create or edit your LDraw model files. If you require any further help with any of this content, please visit the LDraw.org Forums, sign up, and ask a large group of users for help.
Disclaimer
The author(s) of this Wiki hereby releases himself/themselfs of any responsibility consequent of the actions taken by any user inside or outside of the specified information and steps listed within this Wiki.