Update to show new config file format

Sam Edwards 2023-08-17 16:53:26 -07:00
parent b99d27aeac
commit c56fd269af

@ -1,7 +1,38 @@
Currently BlueSCSI uses a few files at the root of the SD card for settings that are outside the norm.
# New Settings File
From [v1.1-20230708](https://github.com/erichelgeson/BlueSCSI/releases/tag/v1.1-20230708), BlueSCSI now uses the file `bluescsi.ini` located on the root of the SD card to configure all custom settings.
You should normally not have to use these unless you have a system that requires some special handling as noted below.
## File Format
The `bluescsi.ini` file uses standard [INI file syntax](https://github.com/compuphase/minIni#ini-file-syntax), and a complete example might look something like this:
```ini
; Main section for global settings
[SCSI]
; Enables "Mega STE" mode
MapLunsToIDs=1
; Other sections are scoped to the SCSI ID you want to change
[SCSI0]
; Forces a particular device type, 0 = HDD, 2 = CDROM
type=2
; Overrides the standard SCSI vendor name, max 8 characters
vendor=MATSHITA
; Overrides the standard SCSI product name, max 16 characters
product=CD-ROM CR-8004
; Overrides the standard SCSI revision number, max 4 characters
revision=1.1f
[SCSI2]
type=0
vendor=BLUESCSI
product=F1
revision=1.1
```
# Older Versions
Older releases of BlueSCSI used a few different files at the root of the SD card for custom settings
## SCSI Vendor config `scsi-config.txt`
@ -21,10 +52,12 @@ ST410800N·······
```
This file works on releases [v1.1-20220626](https://github.com/erichelgeson/BlueSCSI/releases/tag/v1.1-20220626) through [v1.1-20221203](https://github.com/erichelgeson/BlueSCSI/releases/tag/v1.1-20221203)
## Mega STE Mode `MSTE_MODE`
If you have an Atari Mega STE, place a file in the root of your SD card named `MSTE_MODE`. This will map SCSI IDs to LUNs as required for this devices (and possibly others).
The Mega STE internal SCSI/ACSI adapter only supports devices on SCSI ID 0 which limits the usefulness of BlueSCSI in this situation. MSTE_MODE enables the SCSI IDs to be remapped as LUNs for SCSI ID 0 so you can use multiple devices with the internal adapter. This is well supported and tested against [HDDRIVER written by Uwe Seimet](https://www.hddriver.net/). Other ACSI/SCSI drivers were not tested at this time but it is expected that any driver supporting multiple LUNs will also support this new feature.
This mode was added in release `v1.1-20221203`.
This file only works on release [v1.1-20221203](https://github.com/erichelgeson/BlueSCSI/releases/tag/v1.1-20221203)