add release and help links

add forum link to docs
add release link to install scripts
fix failing test

README.md

@@ -89,8 +89,6 @@ Releases include a few media files to get started (see [acknowledgements](#ackno
 
 Follow these steps to install *dynquee* using the install script:
 
-<!-- **TODO**: check link -->
-
 1. Connect to your recalbox with `ssh` (the [Recalbox wiki][recalbox-ssh] explains how)
 1. Copy and paste this command and press enter:  
     ```sh
@@ -118,15 +116,13 @@ If things aren't working, first check the log files in the `logs/` directory:
 
 The logs should provide some clues as to what is wrong.
 
-**TODO**
-If you still can't get it working, post on forum **TODO: link needed**
-
-Please paste your config and debug log files on [pastebin][pastebin] and provide a link.
+If you still can't get it working, post on the [Recalbox forum] and I will try to help.
+Please paste your config file and debug log file on [pastebin][pastebin] and provide a link when reporting issues.
 
 ---
 
 ## Contributing
-Bug reports/fixes, improvements, documentation, & translations are welcome. When reporting bugs please include a copy of your config file `dynquee.ini` and the debug log file `logs/dynquee.debug.log`.
+Bug reports/fixes, improvements, documentation, & translations are welcome.
 
 
 ## Acknowledgements
@@ -165,6 +161,7 @@ This project is released under the [MIT Licence][licence].
 [pimarquee2]: https://github.com/losernator/PieMarquee2
 [project-image]: dynquee.png
 [recalbox]: https://www.recalbox.com
+[recalbox-forum-commproj]: https://forum.recalbox.com/category/13/community-projects
 [recalbox-mqtt]: https://wiki.recalbox.com/en/advanced-usage/scripts-on-emulationstation-events#mqtt
 [recalbox-ssh]: https://wiki.recalbox.com/en/tutorials/system/access/root-access-terminal-cli
 [retropie]: https://retropie.org.uk/

doc/Running_on_separate_device.md

@@ -30,8 +30,7 @@ While *dynquee* was originally intended to run on same computer as Recalbox, it
 
 - Software to show images and play video files. \
     By default *dynquee* uses [`fbi`][fbi] for still images and [`ffmpeg`][ffmpeg] for videos, but if you want to use something else you can configure it via the [config file](#configure).
-
-    **TODO**: Is fbi still available for bullseye? 
+    <!-- **TODO**: Is fbi still available for bullseye? -->
 
     **Note**: because `fbi` and `ffmpeg` write direct to the framebuffer device, dynquee needs to run as `root` (or possibly a member of the `video` group)
 
@@ -51,8 +50,6 @@ Follow these steps to install *dynquee* using the install script:
     ```sh
     sudo bash -c "$(wget -qO - https://github.com/poppadum/dynquee/raw/main/install/install-remote.sh)"
     ```
-
-    **TODO**: test this
 
 1. When prompted, type the hostname or IP address of your Recalbox (default hostname: `recalbox`)  
     **Note**: if you supply an IP address, make sure that IP address won't change
@@ -102,12 +99,12 @@ sudo apt install python3 python3-paho-mqtt fbi ffmpeg
 1. Decide where to locate *dynquee*: the default is `/opt/dynquee`
 
 1. Create the directory:  
-    ```
+    ```sh
     sudo mkdir -p /opt/dynquee
     ```
 
 1. Change to that directory:  
-    ```
+    ```sh
     cd /opt/dynquee
     ```
 
@@ -116,7 +113,6 @@ sudo apt install python3 python3-paho-mqtt fbi ffmpeg
      sudo wget https://github.com/poppadum/dynquee/releases/latest/download/dynquee.zip
      sudo unzip dynquee.zip
      ```
-<!-- TODO: check link -->
 
 ### Configure
 
@@ -128,7 +124,7 @@ sudo apt install python3 python3-paho-mqtt fbi ffmpeg
 
 1. Optional: make the `media/` directory world-writeable so you can copy files to it without `sudo`:  
     ```sh
-    chmod -R a+w ./media/
+    sudo chmod -R a+w ./media/
     ```
 
 
@@ -188,7 +184,7 @@ To test, reboot your marquee machine and check that *dynquee* starts automatical
 
 ## Help
 If you've checked the log files and still can't get it working,
-post on the Recalbox forum **TODO: link needed** or discuss on github?
+post on the [Recalbox forum][recalbox-forum-commproj] and I will try to help.
 
 Please paste your config file and debug log file on [pastebin][pastebin] and provide a link when reporting issues.
 
@@ -231,6 +227,7 @@ video_player_opts = --no-osd --no-keys
 [project-image]: ../dynquee.png
 [py-paho-mqtt]: https://pypi.org/project/paho-mqtt/
 [raspi-os]: https://www.raspberrypi.com/software/
+[recalbox-forum-commproj]: https://forum.recalbox.com/category/13/community-projects
 [recalbox-manager]: https://wiki.recalbox.com/en/tutorials/system/access/recalbox-manager-web-interface
 [recalbox-static-ip]: https://wiki.recalbox.com/en/tutorials/network/ip/static-manual-ip
 [systemd]: https://systemd.io/

doc/manual_install.md

@@ -21,7 +21,6 @@ If you prefer to install *dynquee* manually, follow these steps.
      wget https://github.com/poppadum/dynquee/releases/latest/download/dynquee.zip
      unzip dynquee.zip
      ```
-<!-- TODO: check link -->
 
 ## Test
 Try running the command `python3 dynquee.py`. If all goes well, you should see the startup image on your marquee display. Check that it responds to Recalbox actions by selecting a game system: the marquee should change to the logo or console image of that system.

install/install-remote.sh

@@ -4,7 +4,7 @@
 
 NAME=dynquee
 BASEDIR=/opt/dynquee
-RELEASE_URL='<dynquee-release>'
+RELEASE_URL=https://github.com/poppadum/dynquee/releases/latest/download/dynquee.zip
 SERVICE=dynquee.service
 
 APT_PACKAGES=(python3 python3-paho-mqtt fbi ffmpeg)
@@ -73,7 +73,7 @@ mkdir -p $BASEDIR && \
 cd $BASEDIR || error
 
 echo -e "\nDownloading and extracting latest dynquee release"
-/usr/bin/wget -o dynquee.zip "$RELEASE_URL" && \
+/usr/bin/wget --quiet --output-document=dynquee.zip "$RELEASE_URL" && \
 /usr/bin/unzip -q dynquee.zip && \
 rm dynquee.zip || error
 

install/install.sh

@@ -4,7 +4,7 @@
 
 NAME=dynquee
 BASEDIR=/recalbox/share/dynquee
-RELEASE_URL='<dynquee-release>'
+RELEASE_URL=https://github.com/poppadum/dynquee/releases/latest/download/dynquee.zip
 INIT_SCRIPT=S32dynquee
 ROMDIR=/recalbox/share/roms
 
@@ -26,7 +26,7 @@ mkdir -p $BASEDIR && \
 cd $BASEDIR || error
 
 echo -e "\nDownloading and extracting latest dynquee release"
-/usr/bin/wget -o dynquee.zip "$RELEASE_URL" && \
+/usr/bin/wget --quiet --output-document=dynquee.zip "$RELEASE_URL" && \
 /usr/bin/unzip -q dynquee.zip && \
 rm dynquee.zip || error
 

tests/test_dynquee.py

@@ -201,6 +201,7 @@ def test_getMedia(self):
 
     def test_getStartupMedia(self):
         startupMedia = self.mm.getStartupMedia()
+        startupMedia.sort()
         self.assertEqual(startupMedia, ['./tests/media/startup/startup01.png', './tests/media/startup/welcome.mp4'])