.. currentmodule:: <index>

########################################
Installation, Shelf, Hotkeys and Updates
########################################

Installation Steps
==================

.. warning:: Only **Windows** version is **fully supported**. **Mac** version is currently in **beta test** and may have some bugs. **Linux** was not tested and currently **not supported**. **Maya LT** was not tested and currently **not supported**.

#. Unpack and copy **gs_toolbox** folder to:

    - **Windows:** Documents/Maya/{Maya_Version}/scripts/
    - **Mac:** {Your_Mac_Name}/⁨Users⁩/{User_Name}/⁨Library/⁨Preferences⁩/⁨Autodesk⁩/⁨maya/{Maya_Version}/scripts/⁩

    .. figure:: images/windows_folder_structure_example.png
        :alt: Windows Folder Structure Example
        :width: 600px
        :align: center

        Windows Folder Structure Example

    .. figure:: images/mac_folder_structure_example.png
        :alt: Mac Folder Structure Example
        :width: 600px
        :align: center

        Mac Folder Structure Example

#. Run **Maya**

#. Copy and Paste this code to **Python Command Field** at the bottom (switch from MEL by clicking on it) or to the script editor:

    .. code-block:: python

        import gs_toolbox.init as tb_init;tb_init.Init();


#. **Run the code** (Press Enter for the Command Field or press on triangle for script editor). Installation is complete.

.. figure:: images/script_editor_paste.png
    :alt: Script Editor Example
    :width: 300px
    :align: center

|

Main Menu, Resetting and Stopping
=================================

.. figure:: images/shelf_icons.png
    :alt: Maya Shelf
    :class: float-right
    :width: 200px

After `Installation Steps`_ **GS** tab will appear on **Maya Shelf**.

.. figure:: images/shelf_ui_button.png
    :alt: Main Menu
    :class: float-left
    :width: 50px

--- TB UI button will open/close GS Toolbox User Interface.

.. figure:: images/shelf_reset_button.png
    :alt: Main Menu
    :class: float-left
    :width: 50px

--- TB Reset will reset GS Toolbox to its default state.

.. figure:: images/shelf_del_button.png
    :alt: Main Menu
    :class: float-left
    :width: 50px

--- TB Del will close GS Toolbox UI and stop any background scripts.

.. note:: You can use middle mouse drag to drag these buttons to any tab on the shelf.

Hotkeys
=======

After you Initialize_ the plug-in you can find all the hotkeys in::

    Hotkey Editor -> Custom Scripts -> GS -> GS_Toolbox

.. _Initialize: `Installation Steps`_

Updating the Plug-in
====================

To update the plug-in to a new version just **delete** the old **gs_toolbox** folder and repeat the `Installation Steps`_.

Troubleshooting
===============

*Installation issues on Windows:*

Most of the problems with the installation happen when the user copies the gs_toolbox folder to the wrong folder.

Use **only** the **version specific** scripts folder, and **NOT** the shared scripts folder.

For example - **correct** folder for me:

*C:\\Users\\George\\Documents\\maya\\2022\\scripts*

**Incorrect** folder:

*C:\\Users\\George\\Documents\\maya\\scripts*

P.S. If you are using OneDrive, your documents folder might be in the OneDrive folder.