factor out more FX routines

fixes https://github.com/a2-4am/4cade/issues/548

.gitattributes

@@ -0,0 +1,2 @@
+* text=false
+winmake.bat	text eol=crlf

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2021 4am
+Copyright (c) 2018-2023 4am
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -43,7 +43,6 @@ dsk: index asmproboot asmlauncher extract
 # create _FileInformation.txt files for subdirectories
 #
 	bin/buildfileinfo.sh res/ICONS "CA" "0000"
-	bin/buildfileinfo.sh build/FX "06" "6000"
 	cp src/prelaunch/_FileInformation.txt build/PRELAUNCH/
 #
 # add everything to the disk
@@ -58,21 +57,33 @@ dsk: index asmproboot asmlauncher extract
 	for f in \
 		res/TITLE.ANIMATED \
 		res/ICONS \
-		build/FX \
-		build/PRELAUNCH; do \
+		build/PRELAUNCH \
+		build/X; do \
             rm -f "$$f"/.DS_Store; \
             $(CADIUS) ADDFOLDER build/"$(DISK)" "/$(VOLUME)/$$(basename $$f)" "$$f" -C >>build/log; \
         done
-	$(CADIUS) CREATEFOLDER build/"$(DISK)" "/$(VOLUME)/X/" -C >>build/log
-	for f in build/X/*; do \
-	    $(CADIUS) ADDFOLDER build/"$(DISK)" "/$(VOLUME)/X/$$(basename $$f)" "$$f" -C >>build/log; \
-	done
 	bin/changebootloader.sh build/"$(DISK)" build/proboothd
 
-extract: preconditions md
+gamesconf: preconditions md
+#
+# create a version of GAMES.CONF without comments or blank lines or anything after display titles
+#
+	[ -f build/index ] || (awk '!/^$$|^#/' < res/GAMES.CONF | awk -F'/' '{ print $$1 }' > build/GAMES.CONF)
+#
+# create a list of all game filenames, without metadata or display names, sorted by game filename
+#
+	[ -f build/index ] || (awk -F, '/,/ { print $$2 }' < build/GAMES.CONF | awk -F= '{ print $$1 }' | sort > build/GAMES.SORTED)
+
+extract: preconditions md gamesconf
 	$(PARALLEL) '$(CADIUS) EXTRACTVOLUME {} build/X/ >>build/log' ::: res/dsk/*.po
-	rm -f build/X/**/.DS_Store build/X/**/PRODOS* build/X/**/LOADER.SYSTEM*
-	for f in $$(grep '^....1' res/GAMES.CONF | awk '!/^$$|^#/' | awk -F, '/,/ { print $$2 }' | awk -F= '{ print $$1 }'); do mv build/X/"$$(basename $$f)"/"$$(basename $$f)"* build/X.INDEXED/; rm -rf build/X/"$$(basename $$f)"; done
+	rm -f build/X/**/.DS_Store build/X/**/PRODOS* build/X/**/LOADER.SYSTEM* build/X/**/_FileInformation.txt
+	for f in $$(grep '^....1' build/GAMES.CONF | awk '!/^$$|^#/' | awk -F, '/,/ { print $$2 }' | awk -F= '{ print $$1 }'); do mv build/X/"$$(basename $$f)"/"$$(basename $$f)"* build/X.INDEXED/; rm -rf build/X/"$$(basename $$f)"; done
+	for d in build/X/*; do \
+		for f in "$$d"/*; do \
+			mv "$$f" build/X/"$$(basename $$f)"; \
+		done; \
+		rmdir "$$d"; \
+	done
 	(for f in build/X.INDEXED/*; do echo "$$(basename $$f)"; done) | bin/buildindexedfile.sh -a -p build/TOTAL.DATA build/X.INDEXED > build/XSINGLE.IDX
 
 index: preconditions md asmfx asmprelaunch asmdemo compress extract
@@ -88,14 +99,6 @@ index: preconditions md asmfx asmprelaunch asmdemo compress extract
 	[ -f build/index ] || (bin/converthelp.sh res/CREDITS build/CREDITS)
 	[ -f build/index ] || $(PARALLEL) 'bin/converthelp.sh "{}" "build/GAMEHELP/{/}"' ::: res/GAMEHELP/*
 #
-# create a version of GAMES.CONF without comments or blank lines
-#
-	[ -f build/index ] || (awk '!/^$$|^#/' < res/GAMES.CONF > build/GAMES.CONF)
-#
-# create a list of all game filenames, without metadata or display names, sorted by game filename
-#
-	[ -f build/index ] || (awk -F, '/,/ { print $$2 }' < build/GAMES.CONF | awk -F= '{ print $$1 }' | sort > build/GAMES.SORTED)
-#
 # precompute indexed files for prelaunch
 # note: prelaunch must be first in TOTAL.DATA due to a hack in LoadStandardPrelaunch
 # note 2: these can not be padded because they are loaded at $0106 and padding would clobber the stack
@@ -132,6 +135,12 @@ index: preconditions md asmfx asmprelaunch asmdemo compress extract
 	[ -f build/index ] || (bin/buildindexedfile.sh -p -a build/TOTAL.DATA build/FX.INDEXED < res/FX.CONF > build/FX.IDX)
 	[ -f build/index ] || (bin/buildindexedfile.sh -p -a build/TOTAL.DATA build/FX.INDEXED < res/DFX.CONF > build/DFX.IDX)
 	[ -f build/index ] || (bin/buildindexedfile.sh -p -a build/TOTAL.DATA build/FX.INDEXED < res/SFX.CONF > build/SFX.IDX)
+	[ -f build/index ] || ((for f in build/FXCODE/*; do echo "$$(basename $$f)"; done) | bin/buildindexedfile.sh -p -a build/TOTAL.DATA build/FXCODE > build/FXCODE.IDX)
+#
+# precompute indexed files for coordinates files loaded by graphic effects
+# note: these can not be padded because some of them are loaded into tight spaces near the unclobberable top of main memory
+#
+	[ -f build/index ] || ((for f in build/FXDATA/*; do echo "$$(basename $$f)"; done) | bin/buildindexedfile.sh -a build/TOTAL.DATA build/FXDATA > build/FXDATA.IDX)
 #
 # precompute indexed files for HGR & DHGR action screenshots
 # note: these can not be padded because they are compressed and the decompressor needs the exact size
@@ -194,6 +203,8 @@ index: preconditions md asmfx asmprelaunch asmdemo compress extract
 	[ -f build/index ] || bin/addfile.sh build/FX.IDX build/TOTAL.DATA > src/index/fx.idx.a
 	[ -f build/index ] || bin/addfile.sh build/DFX.IDX build/TOTAL.DATA > src/index/dfx.idx.a
 	[ -f build/index ] || bin/addfile.sh build/SFX.IDX build/TOTAL.DATA > src/index/sfx.idx.a
+	[ -f build/index ] || bin/addfile.sh build/FXCODE.IDX build/TOTAL.DATA > src/index/fxcode.idx.a
+	[ -f build/index ] || bin/addfile.sh build/FXDATA.IDX build/TOTAL.DATA > src/index/fxdata.idx.a
 	[ -f build/index ] || bin/addfile.sh build/GAMEHELP.IDX build/TOTAL.DATA > src/index/gamehelp.idx.a
 	[ -f build/index ] || bin/addfile.sh build/SLIDESHOW.IDX build/TOTAL.DATA > src/index/slideshow.idx.a
 	[ -f build/index ] || bin/addfile.sh build/MINIATTRACT0.IDX build/TOTAL.DATA > src/index/miniattract0.idx.a
@@ -254,12 +265,12 @@ attract: compress
 	bin/check-attract-mode.sh
 	bin/generate-mini-attract-mode.sh
 
-cache: preconditions md
+cache: preconditions md gamesconf
 	$(PARALLEL) ::: \
-	    'awk -F= '"'"'/^00/ { print $$2 }'"'"' < res/GAMES.CONF | bin/buildcache.py > build/cache00.a' \
-	    'awk -F= '"'"'/^0/ { print $$2 }'"'"' < res/GAMES.CONF | bin/buildcache.py > build/cache01.a' \
-	    'awk -F= '"'"'/^.0/ { print $$2 }'"'"' < res/GAMES.CONF | bin/buildcache.py > build/cache10.a' \
-	    'awk -F= '"'"'!/^$$|^#|^\[/ { print $$2 }'"'"' < res/GAMES.CONF | bin/buildcache.py > build/cache11.a'
+	    'awk -F= '"'"'/^00/ { print $$2 }'"'"' < build/GAMES.CONF | bin/buildcache.py > build/cache00.a' \
+	    'awk -F= '"'"'/^0/ { print $$2 }'"'"' < build/GAMES.CONF | bin/buildcache.py > build/cache01.a' \
+	    'awk -F= '"'"'/^.0/ { print $$2 }'"'"' < build/GAMES.CONF | bin/buildcache.py > build/cache10.a' \
+	    'awk -F= '"'"'!/^$$|^#/ { print $$2 }'"'"' < build/GAMES.CONF | bin/buildcache.py > build/cache11.a'
 	$(PARALLEL) ::: \
 	    '$(ACME) -o res/CACHE00.IDX build/cache00.a' \
 	    '$(ACME) -o res/CACHE01.IDX build/cache01.a' \
@@ -270,7 +281,7 @@ mount: dsk
 	osascript bin/V2Make.scpt "`pwd`" bin/4cade.vii build/"$(DISK)"
 
 md:
-	mkdir -p build/X build/X.INDEXED build/FX build/FX.INDEXED build/PRELAUNCH build/PRELAUNCH.INDEXED build/ATTRACT build/SS build/GAMEHELP build/DEMO
+	mkdir -p build/X build/X.INDEXED build/FX.INDEXED build/FXDATA build/FXCODE build/PRELAUNCH build/PRELAUNCH.INDEXED build/ATTRACT build/SS build/GAMEHELP build/DEMO
 	touch build/log
 
 clean:

README.md

@@ -26,7 +26,7 @@ $ cd 4cade/
 $ make
 ```
 
-If all goes well, the `build/` subdirectory will contain a `4cade.hdv` image which can be mounted in emulators like [OpenEmulator](https://archive.org/details/OpenEmulatorSnapshots) or [Virtual II](http://virtualii.com/).
+If all goes well, the `build/` subdirectory will contain a `4cade.hdv` image which can be mounted in emulators like [OpenEmulator](https://archive.org/details/OpenEmulatorSnapshots), [Ample](https://github.com/ksherlock/ample), or [Virtual II](http://virtualii.com/).
 
 If all does not go well, try doing a clean build (`make clean dsk`)
 
@@ -38,7 +38,7 @@ If that fails, please [file a bug](https://github.com/a2-4am/4cade/issues/new).
 
 You will need
  - [ACME](https://sourceforge.net/projects/acme-crossass/)
- - [Cadius for Windows](https://www.brutaldeluxe.fr/products/crossdevtools/cadius/)
+ - [Cadius for Windows](https://github.com/mach-kernel/cadius)
 
 (Those tools will need to be added to your command-line PATH.)
 
@@ -56,6 +56,43 @@ If that fails, perhaps you have out-of-date versions of one of the required tool
 
 If that fails, please [file a bug](https://github.com/a2-4am/4cade/issues/new).
 
+## Linux
+
+You will need
+ - [Cadius](https://github.com/mach-kernel/cadius)
+
+Most of the packages are already available pre-compiled and can be installed with the following
+
+``` shell
+$ sudo apt-get install git parallel acme
+```
+
+To compile Cadius enter the following
+
+``` shell
+$ git clone https://github.com/mach-kernel/cadius.git
+$ cd cadius
+$ make
+$ cd bin/release
+$ sudo cp cadius /usr/bin
+```
+
+Then open a terminal window and type
+
+``` shell
+$ git clone https://github.com/a2-4am/4cade.git
+$ cd 4cade/
+$ make
+```
+
+If all goes well, the `build/` subdirectory will contain a `4cade.hdv` image which can be mounted in emulators like [MAME](http://www.mamedev.org).
+
+If all does not go well, try doing a clean build (`make clean dsk`)
+
+If that fails, perhaps you have out-of-date versions of one of the required tools? The [Makefile](https://github.com/a2-4am/4cade/blob/main/Makefile) lists, but does not enforce, the minimum version requirements of each third-party tool.
+
+If that fails, please [file a bug](https://github.com/a2-4am/4cade/issues/new).
+
 # Navigating the code
 
 ## Initialization

bin/buildfx.js

@@ -41,9 +41,7 @@ for (i = 0; i < entries.length; i++)
 {
   groups += "!byte " + (1 + 1 + entries[i].length + 5).toString() + "\n" + "!byte " + entries[i].length.toString() + "\n" + "!text \"" + entries[i] + "\"\n" + "!be24 " + fx_off.toString() + "\n"
   size = a.getfile(WScript.Arguments(3) + "\\" + entries[i]).size
-  // if offset+size does not cross a block boundary, use the size
-  // otherwise adjust size until it ends at the next block boundary to avoid a partial copy on the last block
-  groups += "!le16 " + ((Math.floor(fx_off / 512) == Math.floor((fx_off + size) / 512)) ? size : (((fx_off + size + 511) & -512) - fx_off)).toString()  + "\n"
+  groups += "!le16 " + size + "\n"
   fx_off += size
 }
 

bin/buildindexedfile.sh

@@ -45,7 +45,7 @@ fi
 
 # make temp file with list of lines that contain keys
 records=$(mktemp)
-tr -d "\r" | awk '!/^$|^#|^\[/' > "$records"
+tr -d "\r" | awk '!/^$|^#/' > "$records"
 
 # make temp assembly source file that represents the binary OKVS data structure
 source=$(mktemp)

bin/buildokvs.sh

@@ -2,7 +2,7 @@
 
 # make temp file with just the key/value pairs (strip blank lines, comments, eof marker)
 records=$(mktemp)
-tr -d "\r" | awk '!/^$|^#|^\[/' > "$records"
+tr -d "\r" | awk '!/^$|^#/' > "$records"
 
 # make temp assembly source file that represents the binary OKVS data structure
 source=$(mktemp)

bin/buildsearch.sh

@@ -9,7 +9,7 @@
 
 # make temp file with just the key/value pairs (strip blank lines, comments, eof marker)
 records=$(mktemp)
-tr -d "\r" | awk '!/^$|^#|^\[/' > "$records"
+tr -d "\r" | awk '!/^$|^#/' > "$records"
 
 # read logs of offsets & sizes for HGR and DHGR titles
 # that were generated by an earlier script

bin/buildslideshow.js

@@ -39,8 +39,8 @@ if (!a.fileexists(WScript.Arguments(1)) || a.getfile(WScript.Arguments(1)).datel
     bits = q.indexOf("," + name + "=") + 1
     name = q.substr(bits + name.length + 1)
     name = name.substr(0, name.indexOf("\n"))
-    needsjoystick = q.substr(bits - 5, 1)
-    needs128k = q.substr(bits - 4, 1)
+    needsjoystick = q.substr(bits - 6, 1)
+    needs128k = q.substr(bits - 5, 1)
     displayname = ((WScript.Arguments.length == 3) ? name : "")
     source.writeline("!byte " + (entries[i].length - ((val >= 0) ? 1 : 0) + displayname.length + 5))
     source.writeline("!byte " + ((val >= 0) ? val : entries[i].length))

bin/buildslideshow.sh

@@ -21,7 +21,7 @@ games=$(cat "$1")
 
 # make temp file with just the key/value pairs (strip blank lines, comments, eof marker)
 records=$(mktemp)
-tr -d "\r" | awk '!/^$|^#|^\[/' > "$records"
+tr -d "\r" | awk '!/^$|^#/' > "$records"
 
 # make temp assembly source file that represents the binary OKVS data structure
 source=$(mktemp)

bin/check-attract-mode.sh

@@ -50,13 +50,13 @@ cat res/GAMES.CONF |
 grep '^\!to' src/demo/*.a | cut -d'/' -f5-|cut -d'#' -f1 |
     grep -v "SPCARTOON" |
     while read f; do
-        grep "$f=0" res/ATTRACT.CONF >/dev/null || echo "unused demo: $f";
+        grep "^$f=0" res/ATTRACT.CONF >/dev/null || echo "unused demo: $f";
     done
 
 # warn about unused slideshows
 cd res/SS
 for f in *.CONF; do
-    grep "$f" ../ATTRACT.CONF >/dev/null || echo "unused slideshow: $f";
+    grep "^$f=" ../ATTRACT.CONF >/dev/null || echo "unused slideshow: $f";
 done
 cd ../..
 

bin/converthelp.sh

@@ -1,4 +1,4 @@
 #!/bin/sh
 
 tr "\*\~\<\>\$\%" "\020\021\010\025\016\017" < "$1" | \
-    tr -d "\r" | awk '!/^\[/ { printf "%c%s", length, $0 } END { printf "\xFF" }' > "$2"
+    tr -d "\r" | awk '{ printf "%c%s", length, $0 } END { printf "\xFF" }' > "$2"

bin/flatten.js

@@ -0,0 +1,13 @@
+a = new ActiveXObject("scripting.filesystemobject")
+x = new ActiveXObject("wscript.shell")
+
+for (b = new Enumerator(a.GetFolder("build\\X").subfolders); !b.atEnd(); b.moveNext())
+{
+  for (c = new Enumerator(b.item().subfolders); !c.atEnd(); c.moveNext())
+  {
+    x.run('cmd /c move build\\X\\' + b.item().name + '\\' + c.item().name + ' build\\X', 0, 1)
+  }
+
+  x.run('cmd /c move build\\X\\' + b.item().name + '\\* build\\X', 0, 1)
+  x.run('cmd /c rd build\\X\\' + b.item().name, 0, 1)
+}

bin/generate-mini-attract-mode.sh

@@ -75,9 +75,6 @@ cat res/GAMES.CONF |
             echo "ARTWORK.SHR/POP.END=C" >> /tmp/g
         fi
 
-        # add eof
-        echo -e "\n[eof]" >> /tmp/g
-
         cat /tmp/g > res/ATTRACT/"$game"
 
         # clean up

bin/makesorted.js

@@ -13,13 +13,6 @@ while (!b.atendofstream)
     d = d.substr(0, e)
   }
 
-  e = d.indexOf("[eof]")
-
-  if (e > -1)
-  {
-    break
-  }
-
   e = d.indexOf("=")
 
   if (e == -1)
@@ -35,5 +28,4 @@ while (!b.atendofstream)
   }
 }
 
-q.write(d + "\n")
 a.createtextfile("build\\GAMES.SORTED").write(c.sort().toString().replace(/,/g, "\n"))