![]() ![]() use ViewRotation instead of RotateView, so that all macros related to View will be together when sorting alphabetically. Macro name specificsĪlso, if possible, start the macro name with the type of object it's working on, e.g. ![]() Please don't start your macro name with Macro or FC or similar (we already know it's a macro for FreeCAD). Please follow the CamelCase.FCMacro convention for the macro name (other associated files except the macro icon don't need to follow this convention). It's a good habit to write a changelog, especially when bringing API breaking changes, from latest to oldest. Ideally write a Wiki page explaining what your macro does and how to use it by following the instructions on the Wiki. Please add a complete description how to use the macro near the top of your macro as normal Python comments. Guidelines for submitting a macro Macro description When you're ready to push your changes: git push -u origin your_branchĬreate a PR (pull request) against upstream Setup the upstream git remote add upstream Ĭreate a branch to work in git checkout -b your_branchįollow our guidelines below on how to add a macro Go to the newly-created local repository cd FreeCAD-macros The best way to submit a macro is to post it to the FreeCAD Python Scripting and Macros subforum for review. This repository hosts FreeCAD macros that volunteers have vetted and added for use to the whole community in general available through the FreeCAD Addon Manager. You can manually install extensions, however, it is much simpler to just use the Addon Manager.A repository of peer-reviewed FreeCAD macros. Macros from both repositories can be installed via the Addon Manager directly from FreeCAD. The second one is the Macros recipes page from which you can pick some useful macros to add to your FreeCAD installation. The first one is the official peer-reviewed macro repository on GitHub. See How to install macros for a more detailed description. Next time you start FreeCAD, the macro will appear under the "Installed Macros" item of the Macro menu. You can then save your macro the same way as you save a FreeCAD document. Simply create a new macro, edit it, and paste your code. You can also directly copy/paste python code into a macro, without recording GUI action. ![]() See Customize Toolbars for a more detailed description. This, added to the power of python scripting within FreeCAD, makes it possible to easily add your own tools to the interface. This way you can make your macro become a real tool, just like any standard FreeCAD tool. Once your macro is created, all this can be done via the Tools → Customize menu. FreeCAD provides much better ways to use your macro, such as assigning a keyboard shortcut to it or putting an entry in the menu. Of course it is not practical to load a macro in the editor in order to use it. You macro is always saved to disk, so any change you make, or any new macro you create, will always be available next time you start FreeCAD. To execute your macro, simply press the execute button on the toolbar while your macro is in the editor. In the edit macros dialog, you can see the python code that has been recorded, and, if you want, make alterations to it. Press the record button, give a name, let's say "cylinder 10x10", then, in the Part Workbench, create a cylinder with radius = 10 and height = 10. button, which links to the Addon Manager. New macros can be installed using the Addons. If you edit a macro, it will be opened in an editor window where you can make changes to its code. There you can manage your macros, delete, edit, duplicate, install or create new ones from scratch. You can now access the macro dialog with the edit button. When you are done, click the stop recording button, and your actions will be saved. It is very simple to use: Press the record button, you will be asked to give a name to your macro, then perform some actions. On it you have 4 buttons: Record, stop recording, edit and play the current macro. The main tool for making macros is the macros toolbar. Those commands are what can be recorded in a macro. You will see that in FreeCAD, every action you do, such as pressing a button, outputs a Python command. In particular, you should start with these pages:Įnable the console output in the menu Edit → Preferences → General → Macro → Show scripts commands in python console. See the Power users hub to learn more about the Python programming language, and about writing macros. A collection of macros written by experienced users is found in the macros recipes page. py extension, FreeCAD macros should have the. Since macros are in reality a list of Python commands, you can also edit them, and create very complex scripts. You simply record actions as you do them, then save those actions under a name, and replay them whenever you want. ![]() Macros are a convenient way to reproduce complex actions in FreeCAD. ![]()
0 Comments
Leave a Reply. |