From cf7127a8fe5687d591795080e97fdc44a82b1ef5 Mon Sep 17 00:00:00 2001 From: 4am Date: Wed, 20 Oct 2021 20:22:39 -0400 Subject: [PATCH] update some comments --- res/ATTRACT.CONF | 69 +++++++++++++++++++++++++----------------------- res/DFX.CONF | 47 +++++++++++++++++---------------- res/FX.CONF | 46 +++++++++++++++++--------------- res/GAMES.CONF | 2 ++ 4 files changed, 86 insertions(+), 78 deletions(-) diff --git a/res/ATTRACT.CONF b/res/ATTRACT.CONF index e8b3b937f..91c2d8c4a 100644 --- a/res/ATTRACT.CONF +++ b/res/ATTRACT.CONF @@ -1,3 +1,39 @@ +# +# Mega-Attract-Mode configuration file +# +# Mega-Attract-Mode is split into modules. Each module can be a short +# slideshow, a self-running demo (like a game's built-in 'attract mode'), or +# even just a single screenshot. Modules are run in the order listed here, one +# after the next, until interrupted by user input. The last-run module is +# tracked in the global prefs file (PREFS.CONF). +# +# The same format is used by the per-game ("mini-attract-mode") configuration files. +# +# This file is converted to a binary data structure at build time and stored in +# ATTRACT.IDX on the final disk image. +# +# Format: +# key=value +# +# |key| must be unique within this file +# +# |value| must be one of +# 0 = self-running demo (|key| is an executable binary file in /DEMO/) +# 1 = HGR title slideshow (|key| is a file in /SS/ containing files in /TITLE.HGR/) +# 2 = HGR action slideshow (|key| is a file in /SS/ containing files in /ACTION.HGR/) +# 3 = DHGR title slideshow (|key| is a file in /SS/ containing files in /TITLE.DHGR/) +# 4 = DHGR action slideshow (|key| is a file in /SS/ containing files in /ACTION.DHGR/) +# 5 = SHR box art slideshow (|key| is a file in /SS/ containing files in /ARTWORK.SHR/) +# 6 = GR action slideshow (|key| is a file in /SS/ containing files in /ACTION.GR/) +# A = single HGR file (|key| is a file in /ACTION.HGR/) +# B = single DHGR file (|key| is arbitrary path from program root directory) +# C = single SHR file (|key| is a file in /ARTWORK.SHR/) +# D = single GR file (|key| is arbitrary path from program root directory) +# +# Blank lines and lines beginning with '#' are ignored (like this one!) +# A line beginning with '[' terminates the parsing +# + # set 1 FAVORITES2.CONF=1 ACTIONHIJ1.CONF=2 @@ -366,36 +402,3 @@ LADY.TUT=0 SHR22.CONF=5 [eof] - -# -# Mega-Attract-Mode configuration file -# -# Mega-Attract-Mode is split into modules. Each module can be a short -# slideshow, a self-running demo (like a game's built-in 'attract mode'), or -# even just a single screenshot. Modules are run in the order listed here, one -# after the next, until interrupted by user input. The last-run module is -# tracked in the global prefs file. -# -# The same format is used by the per-game attract mode configuration files. -# -# Format: -# key=value -# -# |key| must be unique within this file -# -# |value| must be one of -# 0 = self-running demo (|key| is an executable binary file in /DEMO/) -# 1 = HGR title slideshow (|key| is a file in /SS/ containing files in /TITLE.HGR/) -# 2 = HGR action slideshow (|key| is a file in /SS/ containing files in /ACTION.HGR/) -# 3 = DHGR title slideshow (|key| is a file in /SS/ containing files in /TITLE.DHGR/) -# 4 = DHGR action slideshow (|key| is a file in /SS/ containing files in /ACTION.DHGR/) -# 5 = SHR box art slideshow (|key| is a file in /SS/ containing files in /ARTWORK.SHR/) -# 6 = GR action slideshow (|key| is a file in /SS/ containing files in /ACTION.GR/) -# A = single HGR file (|key| is arbitrary path from program root directory) -# B = single DHGR file (|key| is arbitrary path from program root directory) -# C = single SHR file (|key| is arbitrary path from program root directory) -# D = single GR file (|key| is arbitrary path from program root directory) -# -# Blank lines and lines beginning with '#' are ignored (like this one!) -# A line beginning with '[' terminates the parsing -# diff --git a/res/DFX.CONF b/res/DFX.CONF index 0317897f9..cd9b46112 100644 --- a/res/DFX.CONF +++ b/res/DFX.CONF @@ -1,3 +1,27 @@ +# +# Transition effects for DHGR slideshows +# +# Each Mega-Attract Module that is a DHGR slideshow (see ATTRACT.CONF) +# will use a single transition effect for the length of the module. +# Transition effects are loaded in the order listed in this file. Each line +# of this file is a filename (not including comments, like this one). The +# name of the next transition effect is stored in the global prefs, so this +# file should not contain duplicates. +# +# Transition effects are binary files loaded at $6000 and called with main +# memory banked in, DHGR page 1 showing, and the next DHGR graphic already +# loaded at $4000/main and $4000/aux. A transition effect has full use of +# auxiliary memory, zero pages (both), text pages (both, but preserve screen +# holes), and main memory $6000-$BEFF. $BF00-$BFFF/main is reserved for the +# ProDOS shim. LC RAM banks 1 and 2 are reserved for the launcher. +# +# Important: LC RAM bank 1 will be read/write on entry and must be read/write +# on exit. If you need ROM routines, you are responsible for switching to ROM +# then switching back to RAM bank 1 (read/write) before returning. +# +# This file is converted to a binary data structure during build and stored +# in DFX.IDX on the final disk image. +# DHGR.FIZZLE2BIT DHGR.RIPPLE DHGR.SOFT.DIAG @@ -60,27 +84,4 @@ DHGR.WAVY.IRIS DHGR.BLOOM.RIP DHGR.48.SYNC DHGR.FLICK - [eof] - -# -# transition effects for DHGR slideshows -# -# Each Mega-Attract Module that is a DHGR slideshow (see attract.conf) -# will use a single transition effect for the length of the module. -# Transition effects are loaded in the order listed in this file. Each line -# of this file is a filename (not including comments, like this one). The -# name of the next transition effect is stored in the global prefs, so this -# file should not contain duplicates. -# -# Transition effects are binary files loaded at $6000 and called with main -# memory banked in, DHGR page 1 showing, and the next DHGR graphic already -# loaded at $4000/main and $4000/aux. A transition effect has full use of -# auxiliary memory, zero pages (both), text pages (both, but preserve screen -# holes), and main memory $6000-$BEFF. $BF00-$BFFF/main is reserved for the -# ProDOS shim. LC RAM banks 1 and 2 are reserved for the launcher. -# -# Important: LC RAM bank 1 will be read/write on entry and must be read/write -# on exit. If you need ROM routines, you are responsible for switching to ROM -# then switching back to RAM bank 1 (read/write) before returning. -# diff --git a/res/FX.CONF b/res/FX.CONF index 9c998989a..c4b3832ca 100644 --- a/res/FX.CONF +++ b/res/FX.CONF @@ -1,3 +1,27 @@ +# +# Transition effects for HGR slideshows +# +# Each Mega-Attract Module that is an HGR slideshow (see ATTRACT.CONF) +# will use a single transition effect for the length of the module. +# Transition effects are loaded in the order listed in this file. Each line +# of this file is a filename (not including comments, like this one). The +# name of the next transition effect is stored in the global prefs, so this +# file should not contain duplicates. +# +# Transition effects are binary files loaded at $6000 and called with +# hi-res page 1 showing and the next HGR graphic already loaded at $4000. +# A transition effect can use $6000-$BEFF in main memory, zero page, and +# text page if needed (but preserve the screen holes). $800-$1FFF is reserved +# for the slideshow data. $BF00-$BFFF is reserved for the ProDOS shim. +# LC RAM banks 1 and 2 are reserved for the launcher. +# +# Important: LC RAM bank 1 will be read/write on entry and must be read/write +# on exit. If you need ROM routines, you are responsible for switching to ROM +# then switching back to RAM bank 1 (read/write) before returning. +# +# This file is converted to a binary data structure during build and stored +# in FX.IDX on the final disk image. +# BOXES48.SNAKE RIPPLE SOFT.DIAGONAL @@ -123,25 +147,3 @@ BOXES48.ARROW REDLINES FLICK [eof] - -# -# transition effects for HGR slideshows -# -# Each Mega-Attract Module that is an HGR slideshow (see attract.conf) -# will use a single transition effect for the length of the module. -# Transition effects are loaded in the order listed in this file. Each line -# of this file is a filename (not including comments, like this one). The -# name of the next transition effect is stored in the global prefs, so this -# file should not contain duplicates. -# -# Transition effects are binary files loaded at $6000 and called with -# hi-res page 1 showing and the next HGR graphic already loaded at $4000. -# A transition effect can use $6000-$BEFF in main memory, zero page, and -# text page if needed (but preserve the screen holes). $800-$1FFF is reserved -# for the slideshow data. $BF00-$BFFF is reserved for the ProDOS shim. -# LC RAM banks 1 and 2 are reserved for the launcher. -# -# Important: LC RAM bank 1 will be read/write on entry and must be read/write -# on exit. If you need ROM routines, you are responsible for switching to ROM -# then switching back to RAM bank 1 (read/write) before returning. -# diff --git a/res/GAMES.CONF b/res/GAMES.CONF index 3e76d42e5..f4ca8a8c9 100755 --- a/res/GAMES.CONF +++ b/res/GAMES.CONF @@ -394,6 +394,8 @@ # # Master game list # +# This file is stored as-is on the final disk image. (Hi!) +# # Format: # ABCD,directory=name #