Updated HELP.md and default IP address

Author: JeffreyDavidsz

HELP.md

@@ -1,6 +1,38 @@
-# companion-module-propresenter6
+# Companion-module: ProPresenter6
+
+Module for using ProPresenter 6 with the Elgato Stream Deck and Companion. Requires a network connection to ProPresenter via it's Remote network port.
+
+*Optionally, you can also configure a connection to the Stage Display App port if you want to track the Video CountDown Timer for any video that is playing.*
+
+# Setup Guide.
+## Enable networking in ProPresenter if you haven't already done so...
+1. Open ProPresenter and then open the "ProPresenter 6" Menu.
+2. Select "Preferences..." to open the ProPresenter Preferences window.
+3. Select the Network tab to configure ProPresenter network preferences.
+4. Check the "Enable Network" option (if it is not already enabled).
+5. Check the "Enable ProPresenter Remote" option (if it is not already enabled).
+6. Check the "Controller" option (if it is not already enabled).
+7. Enter a controller password (or take note of the existing controller password).
+8. Take a note of the Port number (to the right of the Network Name) - this is typically 4-5 digits.
+9. If you would like your StreamDeck to be able to display "Video CountDown" timers, then you will also need to check the option for "Enable Stage Display App" and enter a new password (or take note of the existing password).
+9. Close ProPresenter preferences window.
+
+## Get the IP address of the computer running ProPresenter
+You can control ProPresenter on any computer within the same network, you just need to know the ProPresenter computer IP address. Use your knowledge of networking (or Google how) to get the IP address of the *computer running ProPresenter*.
+
+### Networking Tips:
+
+If you want to connect to ProPresenter on the *same* computer that you are running Companion on, you can use the special looback IP address of 127.0.0.1 (which is the default setting)
+
+If the computers running ProPresenter and Companion are separate computers and they have the option of using either a wireless or a wired network connection, then it is recommended to use a wired network connection whenever possible. This is because a wired network connection is *typically* more reliable and has better latency - which is good for remote control.
+
+## Configure the ProPresenter module in Companion
+Now you have all the info you need to go to the ProPresenter Companion module configuration and enter the IP address of the computer running ProPresenter as well as the ProPresenter port number and controller password that you took note of from ProPresenter network preferences.
+
+If you chose to also enable the stage display app option in ProPresenter preferences (so your StreamDeck can display "Video Countdown" timers) then you can also select "Yes" for the configuration field "Connect to StageDisplay (Only required for video countdown timer)" and enter the stage display password.
+
+N.B. At the time of writing this module, there is a bug in ProPresenter 6 where if you choose to enter a Port number for the stage display app - it will actually ingore it and use the "main" network port you recorded in step 8 above.
 
-Module for using ProPresenter with the Elgato Stream Deck and Companion. Requires a connection to the ProPresenter Remote network port.  Optionally, you can also configure a connection to the Stage Display App port if you want to track the Video CountDown Timer for any video that is playing.
 
 # Commands
 ## Slides
@@ -19,14 +51,14 @@ A whole number greater than 0 will move the presentation to that slide number.
 
 A slide number of `0` will trigger the current slide, which can be used to bring back a slide that was cleared using `Clear All` or `Clear Slide`.
 
-A relative number (prefixed with `+` or `-`) will move the presentation +/- that many slides. `+3` will jump ahead three slides, and `-2` will jump back two slides. Try to avoid using `-1` or `+1` relative numbers; use the `Next Slide` and `Previous Slide` actions instead, as they perform better. 
+A relative number (prefixed with `+` or `-`) will move the presentation +/- that many slides. `+3` will jump ahead three slides, and `-2` will jump back two slides. Try to avoid using `-1` or `+1` relative numbers; use the `Next Slide` and `Previous Slide` actions instead, as they perform better.
 
 
 **Presentation Path**: Lets you trigger a slide in a different presentation, even from a different playlist.
 
 *Important: Presentation path numbering starts at 0, meaning `0` will trigger a slide in the first presentation in the playlist.*
 
-A single number, like `3`, will let you trigger a slide in the *fourth* presentation in the **current playlist**. 
+A single number, like `3`, will let you trigger a slide in the *fourth* presentation in the **current playlist**.
 
 A path like `1:3` will trigger presentation #4 in playlist #2.
 
@@ -76,7 +108,7 @@ Command | Description
 ------- | -----------
 Stage Display Message | Shows the message on the stage display output
 Stage Display Hide Message | Removes the stage display message
-Stage Display Layout | Sets the stage display layout. 
+Stage Display Layout | Sets the stage display layout.
 
 Stage Displays are indentified by index. Index is a 0-based number, where the first layout is 0 and then count up through the stage display layouts in the order shown in ProPresenters list of stage display layouts.
 

index.js

@@ -46,6 +46,7 @@ instance.prototype.config_fields = function () {
 			id: 'host',
 			label: 'ProPresenter IP',
 			width: 6,
+			default: '127.0.0.1',
 			regex: self.REGEX_IP
 		},
 		{
@@ -70,13 +71,14 @@ instance.prototype.config_fields = function () {
 			width: 2,
 			regex: self.REGEX_NUMBER
 		},
-	 	{
-		 	type: 'dropdown',
-		 	label: 'Connect to StageDisplay (Only required for video countdown timer)',
-		 	id: 'use_sd',
+		 {
+			type: 'dropdown',
+			label: 'Connect to StageDisplay (Only required for video countdown timer)',
+			id: 'use_sd',
 			default: 'no',
-		 	choices: [ { id: 'no', label: 'No' }, { id: 'yes', label: 'Yes' } ]
-	 	},
+			width: 8,
+			choices: [ { id: 'no', label: 'No' }, { id: 'yes', label: 'Yes' } ]
+		 },
 		{
 			type: 'textinput',
 			id: 'sdport',
@@ -1189,7 +1191,7 @@ instance.prototype.init_feedbacks = function() {
 			}
 		]
 	};
-	
+
 	self.setFeedbackDefinitions(feedbacks);
 }
 
@@ -1245,7 +1247,7 @@ instance.prototype.onWebSocketMessage = function(message) {
 			self.updateVariable('current_slide', slideIndex + 1);
 			if (objData.presentationPath == self.currentState.internal.presentationPath) {
 				// If the triggered slide is part of the current presentation (for which we have stored the total slides) then update the 'remaining_slides' dynamic variable
-				// Note that, if the triggered slide is NOT part of the current presentation, the 'remaining_slides' dynamic variable will be updated later when we call the presentationCurrent action to refresh current presentation info. 
+				// Note that, if the triggered slide is NOT part of the current presentation, the 'remaining_slides' dynamic variable will be updated later when we call the presentationCurrent action to refresh current presentation info.
 				self.updateVariable('remaining_slides', self.currentState.dynamicVariables['total_slides'] - slideIndex - 1);
 			}