Browse Source

Document why these plug-ins are required

For the SimulationView, MirrorTool, RotateTool, ScaleTool and TranslateTool I couldn't really find a reason why this is required, so I can't document it.
Ghostkeeper 6 years ago
parent
commit
8a52fd2c2c
1 changed files with 17 additions and 17 deletions
  1. 17 17
      cura/CuraApplication.py

+ 17 - 17
cura/CuraApplication.py

@@ -429,33 +429,33 @@ class CuraApplication(QtApplication):
 
         self.setRequiredPlugins([
             # Misc.:
-            "ConsoleLogger",
-            "CuraEngineBackend",
-            "UserAgreement",
-            "FileLogger",
-            "XmlMaterialProfile",
-            "Toolbox",
-            "PrepareStage",
-            "MonitorStage",
-            "LocalFileOutputDevice",
-            "LocalContainerProvider",
+            "ConsoleLogger", #You want to be able to read the log if something goes wrong.
+            "CuraEngineBackend", #Cura is useless without this one since you can't slice.
+            "UserAgreement", #Our lawyers want every user to see this at least once.
+            "FileLogger", #You want to be able to read the log if something goes wrong.
+            "XmlMaterialProfile", #Cura crashes without this one.
+            "Toolbox", #This contains the interface to enable/disable plug-ins, so if you disable it you can't enable it back.
+            "PrepareStage", #Cura is useless without this one since you can't load models.
+            "MonitorStage", #Major part of Cura's functionality.
+            "LocalFileOutputDevice", #Major part of Cura's functionality.
+            "LocalContainerProvider", #Cura is useless without any profiles or setting definitions.
 
             # Views:
-            "SimpleView",
+            "SimpleView", #Dependency of SolidView.
             "SimulationView",
-            "SolidView",
+            "SolidView", #Displays models. Cura is useless without it.
 
             # Readers & Writers:
-            "GCodeWriter",
-            "STLReader",
-            "3MFWriter",
+            "GCodeWriter", #Cura is useless if it can't write its output.
+            "STLReader", #Most common model format, so disabling this makes Cura 90% useless.
+            "3MFWriter", #Required for writing project files.
 
             # Tools:
-            "CameraTool",
+            "CameraTool", #Needed to see the scene. Cura is useless without it.
             "MirrorTool",
             "RotateTool",
             "ScaleTool",
-            "SelectionTool",
+            "SelectionTool", #Dependency of the rest of the tools.
             "TranslateTool",
         ])
         self._i18n_catalog = i18nCatalog("cura")