6. Configuring the Script

This page is to guide you through the configuration of the script.

Where is the config file?

• The config file is located in /home/<username>/.config/MultiInstanceLinux/config/config.py.

Before starting configuration

• The config file is programmatically created on the first run of the script.
• Since the script was launched with elevated privileges, the directory /home/<username>/.config/MultiInstanceLinux will not have edit rights for the current user.
• So you can't edit the config file before performing this command.

sudo chown -R <your_username> /home/<username>/.config/MultiInstanceLinux/

Configuring the script

• Open the config file in your favorite text editor.
• The configuration variables and their descriptions are below:
  • USING_WALL - Option to use Wall for multi instancing.
  • USING_PROJECTOR - Option to use OBS Projector while using wall.
  • WEBSOCKET_HOST - The hostname of the websocket server. (Do not change this if you don't know what you are doing)
  • WEBSOCKET_PORT - The port on the host where the server is hosted. (Do not change this if you don't know what you are doing)
  • WEBSOCKET_PASSWORD - The password that is set to connect to the websocket server.
  • WALL_SCENE_NAME - The name of the wall scene on OBS.
  • SWITCH_TO_WALL - The keybind to switch to the wall scene on OBS.
  • INSTANCE_SCENE_NAMES - The list of scene names (in order of instance number) on OBS.
  • SWITCH_INSTANCES - The list of keybinds (in order of instance number) to switch to that respective instance.
  • SWITCH_AND_RESET_INSTANCES - The list of keybinds (in order of instance number) to reset all other instances and switch to an instance.
  • INSTANCE_DIRECTORIES - The list of absolute paths to the instance directories.
  • RESET_ALL_INSTANCES - The list of keybinds to reset all instances.
  • RESET_CURRENT_INSTANCE - The list of keybinds to reset the current instance.
• For more info on each variable, you can check the comments that are above each variable. They are quite verbose and will explain most of what you should know.
• If you have no previous experience in Python3, refer to any previous variable that is configured by default. It should cover many if not all the data types used. If you need any help in doing so, a discussion can be opened in that respect here.
• The variable INSTANCE_DIRECTORIES should be set after you start the macro for the first time.
• Fill it in with the directories that you noted down in the Initial Setup section of the wiki.
• Note: Make sure to change the WEBSOCKET_PASSWORD variable to equal to the password that you set after installing OBS websocket and launching OBS after that. It is just a good practice to change it from the default value.

Congratulations! You are now all set-up to use the macro! Enjoy!!

Back to Home