RS3 Scripting Reference Manual
========================================================

**Version: 4.042.0**

Prerequisites
--------------------
Before you begin, ensure you have the RS3 program installed. You must have at minimum Version 4.042 in order to use this feature.


Python Environment
--------------------
There are two methods to run a script, which differ in the Python environment used:

1. Running on RocScript Editor
	* Comes pre-installed with RS3 and includes the **RS3 Python API library**
	* For all-level users
2. Running on your own Python environment
	* Requires downloading the **RS3 Python API library**
	* For advanced users

Install RS3 Python API Library
-----------------------------------
pip installation

.. code-block::
   
   pip install RS3Scripting

If you are not using the latest release of RS3, you need to specify a library version that matches your RS3 version. For example:

.. code-block::

	pip install "RS3Scripting==4.042.0"

Table of Contents
-------------------------
.. toctree::
   :titlesonly:
   :maxdepth: 2
   :caption: Contents:

   generatedAPIDocFiles/rs3
   examples