.. toctree::

********************
Support
********************

Last Updated: 10.17.2020

There is an ever growing library of articles and tutorials at CG Monastery in the `MRS Team Documentation Section <https://www.cgmonastery.com/library/>`_ .

--------

Need immediate help?
====================

For those needing help `immediately`, you may contact us for paid hourly support. 

--------

Contact
=========

* `Discord <https://discordapp.com/invite/bwzg7aV>`_ | Our preferred chatting site

--------

Reporting issues
==================
* Before you start to log a bug, please do the following:
    * Turn on ``Script Editor>History>Show Stack Trace``. It will help you figure out where to start. Make note of any errors on the offending function. See if you can replicate the issue to provide the best bug report as possible
    * We need to know OS, Maya version and any other pertinent info
* Once you have the toolbox installed, you can go ``cgm>help>report>Enviornment Info`` if you're unsure on your data. That report looks like this:

.. code-block:: guess

    /// Enviornment Info ///----------------------------------------------------------------------------------------------------
    -- Maya product : Maya 2016 
    -- Maya operatingSystemVersion : Microsoft Windows 8 Business Edition, 64-bit  (Build 9200)
     
    -- Maya apiVersion : 201614 
    -- Maya buildDirectory : ECS-D4AE04A1:S:/Maya_2016_DI/build 
    -- Maya application : maya 
    -- Maya environmentFile : J:/Dropbox/My Documents/maya/2016/Maya.env 
    -- Maya version : 2016 
    -- Maya file : 2016ff07 
    -- Maya date : 2016 03 18 04 00 
    -- Maya cutIdentifier : 201603180400-990260-1 
    -- Maya operatingSystem : win64 
    
We'll also want to know what versino of our tools you're on. You can check that by going to `CGM>Help>About CGM`. If you don't see that option, you're in a pretty old version of our tools.

Once that opens you'll see the build you're on in the window.

.. figure::  _static/img/support/whatVersionAmIOn.PNG
    :width: 300
    :align: right
    :figclass: align-right

    Bracketed in Red
    
Once you know `you can report issues on gitHub <https://github.com/jjburton/cgmTools/issues/new>`_

--------

Known Issues
==================
You can track issues `on gitHub gitHub <https://github.com/jjburton/cgmTools/issues>`_ if you're interested in a feature or reporting bugs.

--------

Common Problems
------------------
* See the troubleshooting `article on the site for the latest issues users are seeing. <https://www.cgmonastery.com/2019/01/troubleshooting/>`_
* Please ensure you follow the install instructions, in whatever maya script folder you wanna put stuff, you should see: cgmToolbox.mel, cgmToolbox.py and cgm folder

* Before you start to log a bug, please do the following:

    * Turn on ``Script Editor>History>Show Stack Trace``. It will help you figure out where to start. Make note of any errors on the offending function. See if you can replicate the issue to provide the best bug report as possible
    * We need to know OS, Maya version and any other pertinent info
    

--------

Common Errors
---------------------
* ``...aimMatrix.outputRotate' cannot be found.``- This probably means your matrixNodes are loaded. Check your plugins for matrixNodes being loaded. 

* ``Maya simply won't load``- This should only ever happen in a testing build but this may be helpful for other times with other tools as well.

    * user file - Check your maya prefs folder for the version and delete or rename the ``userSetup`` file there
    * Nuke it - delete the entire prefs folder
* ``'module' object has no attribute 'createMetaNode'`` - This error means that you have an old install of red9 somewhere in your maya python pathing. We include up-to-date builds of red9's tools in our repos and that particular call is one we wrote that was rolled into red9 around September 2017. Find the old version of red9, remove it or clarify the pathing to it and you should be good to go.
* ``typeFactories Error`` - More than likely you have an old install of zooToolbox. We share some libraries so if you have a very old library it may be causing a conflict
* ``Don't see the form surfaces anymore``- Check viewpoint 2.0 setting for the transparency options. Alpha cut in particular culls them out.

--------

MRS
------------------
**Something wont work as expected**
This happens. Here's some stanard check lists.

#. Check that you're running latest tool release. If not, get latest and try again.
#. Reload core. Try again.
#. Close and reopen maya. Try again.
#. Report your bug.

Must users are resolved somewhere in there.


**My duplicated block won't mirror**

When you duplicate a block the ``blockMirror`` connection is mirrored as well so it thinks an existing mirrorBlock is it's as well. (Might change this but for now this is the case). On your duplicated blocks clear the block mirror to be able to mirror again.

* Duplicate the offending blocks
* In a python tab ``for mObj in cgmMeta.asMeta(sl=1):mObj.blockMirror = False``

**Maya stand alone fails**

* If the maya stand alone window closes immediately try to print screen to see what it's doing. Some users have found that certain old plugins cause this process to fail. One being Prism.

--------

Game Engines
---------------------

**Maya Compatibility**

.. list-table::
   :widths: 15 10 30
   :header-rows: 1

   * - Version
     - Max Influences
     - Notes
   * - ``Unreal``
     - 8
     - 
   * - ``Unreal Mobile``
     - 4
     - 
   * - ``Unity``
     - 4
     -