add config file comments, minor JS refactoring
[ppt-control.git] / ppt-control.ini
index a9b9bdda79f4132a972727728c4bdb0985853725..83b822e27a136da122b3c351d46aebae84417094 100644 (file)
@@ -1,14 +1,82 @@
 [Main]
-logging = debug
+
+# Logging level
+# Options: debug, info, warning, error, critical
+# (see https://docs.python.org/3/howto/logging.html#when-to-use-logging)
+logging = info
+
+# Cache location
+# Directory to store slide preview images for each presentation
 cache = C:\Windows\Temp\ppt-cache
+
+# Cache format
+# Can be set to any image filter set in the registry, but most commonly JPG or PNG
+# (see https://docs.microsoft.com/en-us/office/vba/api/powerpoint.slide.export)
 cache_format = JPG
+
+# Cache timeout
+# Time after which slides should be exported again to reflect any changes made in the
+# PowerPoint editor. Set to 0 to never consider the cache stale (not recommended). Value 
+# is in seconds.
 cache_timeout = 300
+
+# Cache initialisation
+# Whether to export all slides when a slideshow is started. Can be set to any falsy or
+# truthy value.
+cache_init = True
+
+# Black-white behaviour
+# Sets the behaviour when returning from black or white mode. Options: "both", "literal"
+# In PowerPoint's presenter view, if the slideshow is in black or white screen mode,
+# attempting to switch to the other mode (white/black) will result in the slideshow
+# returning to a normal (visible) state, rather than white/black. This behaviour is
+# also the default for ppt-control, and is invoked by setting "blackwhite" to "both"
+# (when the slideshow is in black or white mode, requesting either black or white mode 
+# will return the slideshow to normal). The more intuitive setting is "literal", whereby 
+# when the slideshow is in black or white mode, pressing the button corresponding to the 
+# mode that the slideshow is already in will return the slideshow to normal mode, and 
+# pressing the other button will put the slideshow into that mode explicitly.
 blackwhite = both
 
+# Refresh interval
+# Describes the number of seconds between backend updates, which consist of:
+# - synchronisation of PowerPoint's events with the internal state. 
+# - updating the interface (systray icon) status
+# - check for PowerPoint files that have been opened in protected view
+# You could set a shorter value here, but these updates don't have to be instant so
+# the default value of 2 seconds should work fine.
+refresh = 2
+
+# Disable protecte view
+# If set to a truthy value, ppt-control will attempt to disable protected view on files
+# which have been opened in protected view. Obviously this introduces some security risk,
+# so if you are uncomfortable with this, leave it off and you will have to disable 
+# protected view for each file manually to be able to control it will ppt-control.
+disable_protected = True
+
 [HTTP]
+
+# HTTP interface
+# The interface to listen for HTTP requests on. Change this if you want to restrict the
+# HTTP frontend to a specific network. A blank value means all interfaces.
 interface = 
+
+# HTTP port
+# The port to listen for HTTP requests on. The default value of 80 is the standard 
+# port for HTTP, so when set to this value you don't need to include the port number
+# in the URL when navigating to the frontend. For all other values you will need to 
+# specify the port number in the web browser (except 443, but that's a bad idea).
 port = 80
 
 [WebSocket]
+# WebSocket interface
+# The interface to listen for WebSocket requests on. Change this if you want to restrict
+# the WebSocket interface to a specific network. A value of 0.0.0.0 means all interfaces.
 interface = 0.0.0.0
+
+
+# WebSocket port
+# The port to listen for WebSocket requests on. This needs to match the port specified in
+# whatever frontend you are using (e.g. in the JS code for the HTTP frontend, or in the
+# script settings for the OBS frontend).
 port = 5678