Locator Creator

This is a test repo for maya-python-project-template

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
   • Usage
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This is a sample project generated by MayaPythonProjectTemplate, and is intended to be used as a test repo (unless you need an over-engineered locator creator).

(back to top)

Getting Started

Welcome to the wonderful world of locators.

Development and contribution guidelines can be found on the contributing page.

(back to top)

Prerequisites

• Maya

(back to top)

Installation

1. Download the latest release zip from the releases page.
2. Extract the zip, then drag the locatorcreator_drag_and_drop_installer.py file into a Maya viewport.
3. Restart Maya.
4. Import the module and use the create_locator function.

   from locatorcreator.example import create_locator
   
   create_locator("foo")

5. Enjoy the locators!

(back to top)

Usage

Please refer to the Documentation.

(back to top)

Roadmap

• Utility function to change the colour of locators
  • Utility function to change the colour of locators to red
  • Utility function to change the colour of locators to green
  • Utility function to change the colour of locators to blue
  • ...profit?

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please open an issue from the request a feature or report a bug pages.

Development and contribution guidelines can be found on the CONTRIBUTING.md page

License

Distributed under the insert_license_name license. See LICENSE file for more information.

(back to top)

Contact

Please reach out via the request a feature or report a bug pages.

(back to top)

Acknowledgments

• Project template by matthewlee-dev.

(back to top)