FSDImages

• Automate image changes using custom data fields, datasets and asset lists
• Control 3rd party applications like OBS and Voicemeeter!
• Available websocket API is simple and allows for creating custom apps that manage your applications data and actions

Important

The primary directory FSDImages cannot be renamed. FSDImages does not use Apache and therefore has no hierarchical method to manage data paths. The directory named FSDImages is used for relative pathing.

Note

Launching the FSDImages application on your local ipv4 (php start.php external) does allow remote access to the application, but only supports a single "controller" at the API level. This will be the first client connected. There is currently no shared data between the two devices, so please control from one device at a time, although multi device controller support will be a future feature. Custom API apps allow many different devices to control separate or shared portions of the application that work in tandem with an active controller. External connections must have their IP whitelisted from the FILE menu's Whitelisted IP Addresses tab. This includes any API application with write permissions to the active controller. Please open the API README.md for more information.

Windows Download

• Download and extract from: https://firststepdesign.co/file/FSDImages.zip (28.6 MB)
• Launch FSDImages.hta
• Select Start Application from the application launcher. Choose Localhost then click APP: localhost:8000 to open the application in a browser!
  • If the application fails to launch, please check the output.log file. The most likely culprit is an outdated C++ windows library for running PHP Windows Latest C++ Redistributable.
• API server can be initialized from the launcher or within the application itself

The windows download includes an example project by default. Check it out to learn how the application works!

Note

For developers running on windows, launch parameter api_use_adapter= can be used to launch the API server (client and host) on a separate network for public / private interactions. (e.g.) on Windows the default launch will use the IPv4 address under section Ethernet adapter Ethernet:, but with a custom script launch of php start.php all external api_use_adapter="Wireless LAN adapter Wi-Fi:" ... the application can bridge the transfer gap of a private LAN and a public WIFI network. Built for public wifi interactions that influence a private network broadcast!

Linux / MacOS install

The base code does not include an example project by default, download and import it from: https://firststepdesign.co/file/Tutorial.fsdi (96 KB)

• Install PHP (will vary depending on your distro)

  sudo apt install php

• Update your php.ini config file to allow large image uploads and project imports.

  • Enter the following console command to locate your config file

  php --ini

  • (e.g. result): Loaded Configuration File: /etc/php/8.3/cli/php.ini
  • change the following configuration properties:
    • upload_max_filesize=8M -> upload_max_filesize=2G
    • post_max_size=8M -> post_max_size=2G
    • memory_limit=128M -> memory_limit=2G
    • max_input_vars=1000 -> max_input_vars=10000
    • ensure the php_zip extension is enabled extension=zip, no ; preceding it
    • ensure the php_sockets extension is enabled extension=sockets
    • ensure the php_fileinfo extension is enabled extension=file_info
    • ensure the php_curl extension is enabled extension=curl
    • ensure the php_openssl extension is enabled extension=openssl

• Clone or Download and extract the repository

• Rename the primary directory to FSDImages NOT FSDImages-main

• Navigate to the FSDImages primary directory and launch the application using:

  php start.php

  • or

  php start.php external all

  • to start the websocket API server during launch: all and start the application on your external ipv4 rather than localhost using: external

  php start.php api

  • to start the websocket API server only

• Close the application with

  php stop.php

  • or

  php stop.php all

  • to stop the application and websocket server

• Visit localhost:8000 (or external IPv4:8000) in your web browser to start using the application!

To-DO

• Overlay Editor
  • change UI to support an initial screen with all overlays and +create overlay, allowing single click into an overlay
  • ctrl + z, ctrl + y
  • ctrl + c, ctrl + v between overlays
  • clipping path transform with nested support
  • allow inside / outside path border
  • allow gradient
  • allow layer opacity rather than just fill / border and text opacity
• Fix "bug" where update of dataset call to parent dataset lookup / change can find and mark path forwarded values reliant on that dataset as changed