From d57479fa2b197df5712586799244e6b291d01ced Mon Sep 17 00:00:00 2001 From: Stephen Anthony Date: Mon, 8 Jun 2020 10:59:11 -0230 Subject: [PATCH] Updated documentation with changes to properties key names. --- docs/index.html | 52 ++++++++++++++++++++++---------------------- src/tools/PropSet.pm | 44 ++++++++++++++++++------------------- 2 files changed, 48 insertions(+), 48 deletions(-) diff --git a/docs/index.html b/docs/index.html index abe4e09db..69e1aff77 100644 --- a/docs/index.html +++ b/docs/index.html @@ -549,7 +549,7 @@ have to do anything yourself. However, it is also possible to force the bankswitch type to use by adding a special filename extension. These extensions are listed in the ROM properties section under - Cartridge.Type -> File Extension.

+ Cart.Type -> File Extension.

Note: These extensions are the same as those used by the Harmony Cart and Unocart and are not case-sensitive, so you can name your files and have them @@ -2732,7 +2732,7 @@ 

-bs <type>
- Set "Cartridge.Type" property. See the Game Properties section + Set "Cart.Type" property. See the Game Properties section for valid types. @@ -2743,27 +2743,27 @@ 
-startbank <bank>
- Set "Cartridge.StartBank" property. + Set "Cart.StartBank" property. 
-channels <Mono|Stereo>
- Set "Cartridge.Sound" property. + Set "Cart.Sound" property. 
-ld <A|B>
- Set "Console.LeftDifficulty" property. + Set "Console.LeftDiff" property. 
-rd <A|B>
- Set "Console.RightDifficulty" property. + Set "Console.RightDiff" property. 
-tv <Color|BW>
- Set "Console.TelevisionType" property. + Set "Console.TVType" property. @@ -3962,24 +3962,24 @@ Ms Pac-Man (Stella extended codes): 

    ; Comments
-   "Cartridge.MD5"      "Value"
-   "Property"           "Value"
+   "Cart.MD5"  "Value"
+   "Property"  "Value"
    ""
 
    ; Comments
-   "Cartridge.MD5"      "Value"
-   "Property"           "Value"
+   "Cart.MD5"  "Value"
+   "Property"  "Value"
    ""
 
    . . .
 
    ; Comments
-   "Cartridge.MD5"      "Value"
-   "Property"           "Value"
+   "Cart.MD5"  "Value"
+   "Property"  "Value"
    ""

Every block in the property file must have a unique value for the - Cartridge.MD5 property.

+ Cart.MD5 property.

Properties

@@ -3993,7 +3993,7 @@ Ms Pac-Man (Stella extended codes): - + - + @@ -4100,7 +4100,7 @@ Ms Pac-Man (Stella extended codes): - +
Cartridge.Type:Cart.Type: Indicates the bank-switching type for the game. The value of this property must be either Auto or one of the following (for more information about bank-switching see Kevin Horton's 2600 bankswitching @@ -4058,7 +4058,7 @@ Ms Pac-Man (Stella extended codes):
Cartridge.StartBank:Cart.StartBank: Indicates which bank to use for reading the reset vector.
Cartridge.Sound:Cart.Sound: Indicates if the game should use 1 or 2 channels for sound output. All original Atari 2600 machines supported 1 channel only, but some homebrew games have been written to take advantage of stereo @@ -4119,19 +4119,19 @@ Ms Pac-Man (Stella extended codes): - + - + - + @@ -4232,14 +4232,14 @@ Ms Pac-Man (Stella extended codes):

Console.TelevisionType:Console.TVType: Indicates the default television setting for the game. The value must be Color or BW.
Console.LeftDifficulty:Console.LeftDiff: Indicates the default difficulty setting for the left player. The value must be A or B.
Console.RightDifficulty:Console.RightDiff: Indicates the default difficulty setting for the right player. The value must be A or B.
- + - + - + - + - + - + diff --git a/src/tools/PropSet.pm b/src/tools/PropSet.pm index 7cba557f9..0c40d7452 100755 --- a/src/tools/PropSet.pm +++ b/src/tools/PropSet.pm @@ -3,29 +3,29 @@ package PropSet; # NOTE: If the property types ever change in Stella, the following hashmap # and array must be updated (and stay in sequence) my %prop_type = ( - "Cart.MD5" => 0, - "Cart.Manufacturer" => 1, - "Cart.ModelNo" => 2, - "Cart.Name" => 3, - "Cart.Note" => 4, - "Cart.Rarity" => 5, - "Cart.Sound" => 6, - "Cart.StartBank" => 7, - "Cart.Type" => 8, - "Console.LeftDiff" => 9, - "Console.RightDiff" => 10, - "Console.TVType" => 11, - "Console.SwapPorts" => 12, - "Controller.Left" => 13, - "Controller.Right" => 14, - "Controller.SwapPaddles" => 15, + "Cart.MD5" => 0, + "Cart.Manufacturer" => 1, + "Cart.ModelNo" => 2, + "Cart.Name" => 3, + "Cart.Note" => 4, + "Cart.Rarity" => 5, + "Cart.Sound" => 6, + "Cart.StartBank" => 7, + "Cart.Type" => 8, + "Console.LeftDiff" => 9, + "Console.RightDiff" => 10, + "Console.TVType" => 11, + "Console.SwapPorts" => 12, + "Controller.Left" => 13, + "Controller.Right" => 14, + "Controller.SwapPaddles" => 15, "Controller.PaddlesXCenter" => 16, - "Controller.PaddlesYCenter" => 17, - "Controller.MouseAxis" => 18, - "Display.Format" => 19, - "Display.VCenter" => 20, - "Display.Phosphor" => 21, - "Display.PPBlend" => 22 + "Controller.PaddlesYCenter" => 17, + "Controller.MouseAxis" => 18, + "Display.Format" => 19, + "Display.VCenter" => 20, + "Display.Phosphor" => 21, + "Display.PPBlend" => 22 ); my @prop_type_as_string = ( "Cart.MD5",
Cartridge.Name:Cart.Name: Indicates the actual name of the game. When you save snapshots, load/save state files, or use the ROM Audit Mode functionality, this is the name that will be used for the respective file(s).
Cartridge.MD5:Cart.MD5: Indicates the MD5 checksum of the ROM image as a string of hexadecimal digits. Stella uses this property while attempting to match a game with its block of properties. If the @@ -4250,22 +4250,22 @@ Ms Pac-Man (Stella extended codes):
Cartridge.Manufacturer:Cart.Manufacturer: Indicates the game's manufacturer.
Cartridge.ModelNo:Cart.ModelNo: Indicates the manufacturer's model number for the game.
Cartridge.Rarity:Cart.Rarity: Indicates how rare a cartridge is, based on the scale described on AtariAge.
Cartridge.Note:Cart.Note: Contains any special notes about playing the game.