[SniffEmu] v1.0.0

SniffEmu/dist/SniffEmu.readme

@@ -0,0 +1,52 @@
+Short:        CLI tool to "detect" if the system is running in emulator
+Author:       Tomek W<>jcik <contact@bthlabs.pl>
+Uploader:     Tomek W<>jcik <contact@bthlabs.pl>
+Type:         util/sys
+Version:      1.0.0
+Architecture: m68k-amigaos
+Requires:     AmigaOS 3.1+, MC68020+
+
+SniffEmu by BTHLabs
+
+SniffEmu is a small CLI tool to "detect" if the system is running in
+emulation-like environment, e.g. UAE. I use it to conditionally execute parts
+of Startup-Sequence, e.g. to can skip FBlit when the OS is booting on PiStorm.
+
+Usage: SniffEmu HELP/S RTG/S MODE
+
+MODE is one of EMU68, UAE or MUSASHI. RTG/S allows you to specifically look
+for the emulator's RTG card, so you can e.g. set up the proper screen mode.
+
+Example:
+
+> SniffEmu EMU68
+SniffEmu: Looking for board: 28019:-1... NOT FOUND
+
+> SniffEmu RTG UAE
+SniffEmu: Looking for board: 2011:96... FOUND
+
+If the emulator (or RTG) was detected, the program will set the returncode to
+WARN. Otherwise, it'll be OK.
+
+Example script:
+
+C:SniffEmu RTG UAE >NIL:
+If WARN
+  Echo "Found UAE RTG!"
+EndIf
+
+Note: MUSASHI support is currently untested. If anybody uses it, let me know
+about the results ;).
+
+Requirements: AmigaOS 3.1+, MC68020+
+
+SniffEmu is developed by Tomek W<>jcik
+
+SniffEmu is licensed under the MIT License.
+
+Changelog
+---------
+
+Version 1.0.0 (16.02.2023)
+
+  * Initial release.