Skip to content

Installation

Mark Geurts edited this page Apr 5, 2018 · 1 revision

This repository is set up so that only one script, ScriptSelector.py, actually needs to be imported into RayStation. Once imported, you can change how scripts are loaded through two variables specified at the top of the script: local and module. If local is left empty, each time ScriptSelector.py is called from RayStation it will use the requests library to connect to this repository and prompt the user to select a branch to run scripts from (the master branch contains all validated Production versions, but other feature development branches can be selected to test new features). After selecting a branch, ScriptSelector.py will download all scripts and prompt the user with a list to select one to execute.

Alternatively, users can enter a local directory into the local variable in ScriptSelector.py that contains a local copy of this repository. Instead of downloading a fresh copy each time from GitHub, the local scripts will be displayed to the user for execution.

The module variable is used to only show scripts from a particular directory in this repository. For example, setting module = 'general' will only show the general scripts to the user. In this way, multiple copies of ScriptSelector.py can be loaded into RayStation with each pointing to a single focus of scripts.

Finally, the logs and token variables are used to enable additional features. If logs is specified with a file name, any logging function calls from within the scripts are written to the file. The token variable is used to provide higher frequency access to the GitHub API (see the Installation wiki page for more information).

Clone this wiki locally