.. Reconsider after changing the design of the feature overview
.. :hide-toc:
.. note::
This documentation is a community-maintained update of the `original PME documentation `_.
.. image:: /_static/images/pme_logo.webp
:alt: Pie Menu Editor Logo
:align: center
----
Welcome to PME Documentation
============================
Pie Menu Editor (PME) empowers you to reshape Blender's interface to match your creative vision. Through intuitive menu creation and hotkey customization, PME turns your workflow ideas into reality.
.. include::
getting_started/feature_overview.rst
.. note::
Your perfect Blender setup is just a few clicks away - no coding required.
For those ready to explore Python, PME offers advanced options to extend Blender even further.
.. admonition:: Supporting Sustainable Development
:class: important
PME's development and maintenance relies primarily on volunteer contributions.
Your support through `GitHub Sponsors `_ (starting from $1/month)
helps make these activities sustainable:
- Compatibility updates for new Blender versions
- Bug fixes and stability improvements
- Documentation enhancement
- New feature development
- Fast and reliable support
Your support drives PME's evolution into an even better tool.
.. TODO: Get Support Section
----
Join the Community
------------------
PME's development and documentation thrive through community collaboration.
Here's how you can participate:
Share and Learn
^^^^^^^^^^^^^^^^
- `Blender Artists Forum`_: Ask questions and share customization examples
- `GitHub Discussions`_: Propose new features and exchange ideas
.. _Blender Artists Forum: http://blenderartists.org/forum/showthread.php?392910
.. _GitHub Discussions: https://github.com/Pluglug/pie-menu-editor-fork/discussions
Contribute to Development
^^^^^^^^^^^^^^^^^^^^^^^^^
- `Issue Tracker`_: Report bugs and request features
- `Pull Requests`_: Improve code and add new features
- :ref:`contribute-to-pme`: Development participation guidelines
.. _Issue Tracker: https://github.com/Pluglug/pie-menu-editor-fork/issues
.. _Pull Requests: https://github.com/Pluglug/pie-menu-editor-fork/pulls
Improve Documentation
^^^^^^^^^^^^^^^^^^^^^
The :ref:`contribute-to-docs` project welcomes:
- Content review and proofreading
- Documentation translation
- Contributions to Examples & Resources
.. admonition:: Related Links
:class: hint
.. hlist::
:columns: 2
* `Blender `_
* `Blender Development Fund `_
* `Blender Manual `_
* `Blender Python API `_
* `PME Original Documentation `_
* `PME Blender Artists Forum `_
* `PME Fork Repository `_
* `PME Docs Repository `_
* `PME Become a Sponsor `_
----
.. toctree::
:maxdepth: 2
:caption: Getting Started
:hidden:
getting_started/installation
getting_started/quick_tutorial
.. toctree::
:maxdepth: 2
:caption: Editors
:hidden:
editors/pie_menu_editor
editors/regular_menu_editor
editors/popup_dialog_editor
editors/sticky_key_editor
editors/stack_key_editor
editors/macro_operator_editor
editors/modal_operator_editor
editors/editor_common_elements
editors/ui_customization
editors/property_editor
editors/custom_icons
editors/settings
.. toctree::
:maxdepth: 2
:caption: Reference
:hidden:
reference/terminology
reference/scripting
reference/examples
.. toctree::
:maxdepth: 2
:caption: Support & Community
:hidden:
support_community/faq
support_community/get_support
support_community/contribute_to_pme
support_community/changelog