Difference between revisions of "Prj"

From Wiki.OSArch
(Add template and categories)
Line 7: Line 7:
 
| bugs      = [https://gitlab.com/marzof/prj/-/issues Issue page on gitlab]
 
| bugs      = [https://gitlab.com/marzof/prj/-/issues Issue page on gitlab]
 
| community  = ""
 
| community  = ""
| maturity  = At the very beginning
+
| maturity  = Promising
 
| donation  = ""
 
| donation  = ""
 
}}
 
}}
  
 +
''prj'' is a [[Category:Blender_Add-on]] for generating semantic technical drawings from 3d model. Its main purpose is to help architects and designer to make building and interior drawings automatically. ''prj'' generates linked data-rich SVG drawings.
 +
It has particular strengths:
  
=== What is prj ===
+
* Drawings are in the open file format [[Scalable_Vector_Graphics_(SVG)|Scalable Vector Graphics (SVG)]]. SVG is a non-binary and non-proprietary format that can be viewed by a simple browser on any device. Interactivity can be implemented in SVG files and their styles can be handled by [https://en.wikipedia.org/wiki/CSS web standard CSS]. Editing is easy and graphically powerful using free software like [[Inkscape]] and [[Krita]].
''prj'' is a Blender add-on for '''generating semantic technical drawings from 3d model.'''<br>
 
Its main purpose is to ''help architects and designer to make building and interior drawings automatically''.
 
  
=== Disclaimer ===
+
* Drawings are linked. Every 3D object is represented in a single dedicated SVG file and all those files are linked (as <use> element) to the main drawing. That allows to keep files size small and to limit redrawing to changed objects only.
''prj'' is currently '''under development and may be subject to changes''': using it on production is on your own responsibility.<br>
 
At the moment ''prj'' has been '''tested on Linux and Windows machines only''' and is not supposed to work on other OS
 
  
=== About prj ===
+
* Drawings are data-rich. Every object stores information about it directly inside the SVG. Hence text searches are possible over single and multiple drawings. ''prj'' is also able to produce drawings in the less free [[Drawing_Exchange_Format_(DXF)|DXF]] or [[Drawing_(DWG)|DWG]] file formats.
''prj'' generates '''''linked data-rich SVG''''' drawings.<br>
 
In particular:
 
* '''drawings are in SVG format'''
 
:''Scalable Vector Graphics'' is a '''non-binary''' and '''non-proprietary format''' that can be viewed by a simple browser on any device. '''Interactivity''' can be implemented on it and its style can be '''handled by CSS'''. Editing is easy and graphically powerful using both open source source and proprietary softwares.
 
  
* '''drawings are linked'''
+
''prj'' uses [https://docs.blender.org/manual/en/latest/scene_layout/object/properties/line_art.html Blender Line Art] feature and SVG grease pencil exporter.
:Every 3D object is represented in a single dedicated SVG file and all those files are linked (as <use> element) to the main drawing. That allows to '''keep files size small''' and to limit redrawing to changed objects only.
 
  
* '''drawings are data-rich'''
+
== Why use prj? ==
:Every object '''stores information''' about it directly inside the SVG. Hence '''text searches''' are possible over single and multiple drawings.
+
''prj'' isn't trying to be a simple drawing tool. Its main aim is to be a tool to manage projects information by generating data-rich drawings (a kind of BIM drawing tool).
 
 
''prj'' is able to produce drawings in ''DXF'' or ''DWG'' file format as well.<br>
 
 
 
''prj'' uses Blender ''Line Art'' feature and ''SVG grease pencil exporter''.
 
 
 
=== Why using prj? ===
 
''prj'' '''doesn't mean to be a simple drawing tool''': its main aim is to be '''a tool to manage projects information by generating data-rich drawings''' (a kind of BIM drawing tool).
 
  
 
This is why it generates drawings in SVG format with a linked structure: this way every object in the drawing can return informations about it (product id, size, weight, physical properties, cost, typology, family belonging, etc…)* and allow user to get, for example, bill of quantities or interactive drawing you can query.
 
This is why it generates drawings in SVG format with a linked structure: this way every object in the drawing can return informations about it (product id, size, weight, physical properties, cost, typology, family belonging, etc…)* and allow user to get, for example, bill of quantities or interactive drawing you can query.
  
For these reasons it's recommended to complete the drawing process (composing, styling with css, adding annotations and dimensions) using an SVG editor (like the open source [[Inkscape]]).<br>
+
For these reasons it's recommended to complete the drawing process (composing, styling with css, adding annotations and dimensions) using an SVG editor (like the open source [[Inkscape]]). There are plans for prj SVG exports to store many other types of data in the future (such as quantities).
Anyway, if you don't care to keep these information inside your drawings, you can produce ''DXF'' or ''DWG'' files.
 
  
''* It's important to point out that, at the moment, the add-on is not capable to store some data yet (like quantities) but in future it should be able to do it.''
+
= See also =
 +
* [[Inkscape]]
 +
* [[Blender]]
 +
* [[Krita]]
 +
* [[Category:Blender_Add-on]]
 +
* [[Scalable_Vector_Graphics_(SVG)]]
 +
* The [https://community.osarch.org/discussions/tagged/prj prj tag] on the OSArch forum
  
=== Documentation ===
+
= External Resources =
At the moment a proper documentation is missing.<br>
+
* [https://gitlab.com/marzof/prj#getting-started ''Getting started''] guide
However, a [https://gitlab.com/marzof/prj#getting-started ''Getting started'' guide] is present on the main page of the add-on repo.
 
  
=== External Resources ===
 
 
{{Template:Software}}
 
{{Template:Software}}
 
[[Category:Blender Add-on]]
 
[[Category:Blender Add-on]]
 
[[Category:Blender]]
 
[[Category:Blender]]

Revision as of 11:28, 9 June 2022

64x64px
244px
Website: gitlab.com/marzof/prj
Source: Repo on gitlab
License: GNU GPLv2
Bugs: Issue page on gitlab
Community: ""
Maturity: Category:Promising
Donate: ""
Red curve on white disc 128px.png Software Directory


prj is a for generating semantic technical drawings from 3d model. Its main purpose is to help architects and designer to make building and interior drawings automatically. prj generates linked data-rich SVG drawings. It has particular strengths:

  • Drawings are in the open file format Scalable Vector Graphics (SVG). SVG is a non-binary and non-proprietary format that can be viewed by a simple browser on any device. Interactivity can be implemented in SVG files and their styles can be handled by web standard CSS. Editing is easy and graphically powerful using free software like Inkscape and Krita.
  • Drawings are linked. Every 3D object is represented in a single dedicated SVG file and all those files are linked (as <use> element) to the main drawing. That allows to keep files size small and to limit redrawing to changed objects only.
  • Drawings are data-rich. Every object stores information about it directly inside the SVG. Hence text searches are possible over single and multiple drawings. prj is also able to produce drawings in the less free DXF or DWG file formats.

prj uses Blender Line Art feature and SVG grease pencil exporter.

Why use prj?

prj isn't trying to be a simple drawing tool. Its main aim is to be a tool to manage projects information by generating data-rich drawings (a kind of BIM drawing tool).

This is why it generates drawings in SVG format with a linked structure: this way every object in the drawing can return informations about it (product id, size, weight, physical properties, cost, typology, family belonging, etc…)* and allow user to get, for example, bill of quantities or interactive drawing you can query.

For these reasons it's recommended to complete the drawing process (composing, styling with css, adding annotations and dimensions) using an SVG editor (like the open source Inkscape). There are plans for prj SVG exports to store many other types of data in the future (such as quantities).

See also

External Resources

This page describes a software project from our AEC Free Software directory