The-Homebrew-Cloud/SummerCart64
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/SummerCart64.git synced 2024-11-26 07:34:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Mateusz Faderewski 2023-02-24 19:56:02 +01:00
parent 89f0866fbe
commit c03f85dcca
4 changed files with 20 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/build.yml vendored
View File

@ -70,7 +70,7 @@ jobs:
- name: Setup python - name: Setup python
uses: actions/setup-python@v4 uses: actions/setup-python@v4
with: with:
python-version: 3.11 python-version: '3.11'
- name: Download pyinstaller repository - name: Download pyinstaller repository
uses: actions/checkout@v3 uses: actions/checkout@v3

34
docs/00_quick_startup_guide.md
View File

@ -12,43 +12,43 @@
## First time setup ## First time setup
1. Make sure `python3` and `pip3` are installed in your system **Windows platform: replace `./sc64` in examples below with `sc64.exe`**
2. Grab latest `SC64.zip` package from GitHub releases
3. Extract package contents to a folder 1. Download the latest `sc64-{os}` (choose OS matching your system) and `sc64_firmware.bin` from GitHub releases page
4. Install requirements: `pip3 install -r requirements.txt` 2. Extract `sc64-{os}` package contents to a folder and place `sc64_firmware.bin` inside it
5. Run `python3 sc64.py --help` to check if requirements are installed 3. Update SC64 firmware to the latest version with `./sc64 --update-firmware sc64_firmware.bin`
6. Run `python3 sc64.py --print-state` to check if SC64 is detected 4. Run `./sc64 --print-state` to check if SC64 is detected correctly
--- ---
## Firmware backup/update ## Firmware backup/update
Keeping SC64 firmware up to date is highly recommended. `sc64.py` script is tightly coupled with specific firmware versions and will error out when it detects unsupported firmware version. Keeping SC64 firmware up to date is highly recommended. `sc64` executable is tightly coupled with specific firmware versions and will error out when it detects unsupported firmware version.
To download and backup current version of SC64 firmware run `python3 sc64.py --backup-firmware sc64_firmware_backup.bin` To download and backup current version of SC64 firmware run `./sc64 --backup-firmware sc64_firmware_backup.bin`
To update SC64 firmware run `python3 sc64.py --update-firmware sc64_firmware.bin` To update SC64 firmware run `./sc64 --update-firmware sc64_firmware.bin`
--- ---
## Internal flashcart state ## Internal flashcart state
SC64 holds some configuration after script has exit. To reset it simply run: `python3 sc64.py --reset-state`. Internal flashcart state can be checked by running: `python3 sc64.py --print-state` SC64 holds some internal configuration options after `sc64` executable finished running. To reset it simply run: `./sc64 --reset-state`. Internal flashcart state can be checked by running: `./sc64 --print-state`
--- ---
## Uploading game/save ## Uploading game/save
`python3 sc64.py --boot rom --rom path_to_rom.n64 --save-type eeprom-4k --save path_to_save.sav` `./sc64 --boot rom --rom path_to_rom.n64 --save-type eeprom-4k --save path_to_save.sav`
Replace `path_to_rom.n64` / `eeprom-4k` / `path_to_save.sav` with appropriate values for desired game. Check included help in script to check available save types. Replace `path_to_rom.n64` / `eeprom-4k` / `path_to_save.sav` with appropriate values for desired game. Check included help in program to check available save types.
Arguments `--save-type` and/or `--save` can be omitted if game doesn't require any save. Arguments `--save-type` and/or `--save` can be omitted if game doesn't require any save.
--- ---
## Downloading save ## Downloading save
`python3 sc64.py --backup-save path_to_save.sav` `./sc64 --backup-save path_to_save.sav`
Replace `path_to_save.sav` with appropriate value. Specifying save type isn't required when set correctly previously. Replace `path_to_save.sav` with appropriate value. Specifying save type isn't required when set correctly previously.
@ -56,7 +56,7 @@ Replace `path_to_save.sav` with appropriate value. Specifying save type isn't re
## Running 64DD games ## Running 64DD games
64DD games require DDIPL ROM and disk images. To run disk game type `python3 sc64.py --boot ddipl --ddipl path_to_ddipl.n64 --disk path_to_disk_1.ndd --disk path_to_disk_2.ndd`. 64DD games require DDIPL ROM and disk images. To run disk game type `./sc64 --boot ddipl --ddipl path_to_ddipl.n64 --disk path_to_disk_1.ndd --disk path_to_disk_2.ndd`.
Replace `path_to_ddipl.n64` / `path_to_disk_x.ndd` with appropriate values. Argument `--disk` can be specified multiple times. Only `.ndd` disk format is supported currently. To change inserted disk press button on the back of SC64 flashcart. Replace `path_to_ddipl.n64` / `path_to_disk_x.ndd` with appropriate values. Argument `--disk` can be specified multiple times. Only `.ndd` disk format is supported currently. To change inserted disk press button on the back of SC64 flashcart.
@ -65,13 +65,13 @@ Replace `path_to_ddipl.n64` / `path_to_disk_x.ndd` with appropriate values. Argu
## Direct boot option ## Direct boot option
If booting game through included bootloader isn't a desired option then flashcart can be put in special mode that omits this step. If booting game through included bootloader isn't a desired option then flashcart can be put in special mode that omits this step.
Run `python3 sc64.py --boot direct-rom --rom path_to_rom.n64` to disable bootloader during boot and console reset. By default `sc64.py` script will try to guess CIC seed and calculate checksum. To change seed or disable CIC use `--cic-params 0x3F,0` argument with appropriate values. Refer to included help in script for values meaning. This option is useful only for very specific cases (e.g. testing custom IPL3 or running SC64 on top of GameShark). Run `./sc64 --boot direct-rom --rom path_to_rom.n64` to disable bootloader during boot and console reset. By default `sc64` executable will try to guess CIC seed and calculate checksum. To change seed or disable CIC use `--cic-params 0x3F,0` argument with appropriate values. Refer to included help in program for values meaning. This option is useful only for very specific cases (e.g. testing custom IPL3 or running SC64 on top of GameShark).
--- ---
## Debug terminal ## Debug terminal
`sc64.py` supports UNFLoader protocol and has same functionality implemented as aforementioned program. Use argument `--debug` to activate it. `sc64` executable supports UNFLoader protocol and has same functionality implemented as aforementioned program. Use argument `--debug` to activate it.
--- ---
@ -89,4 +89,4 @@ LED on SC64 board can blink in certain situations. Most of them during normal us
Nx means that blink count is varied. Nx means that blink count is varied.
LED blinking on SD card access can be disabled through `sc64.py` script. Please refer to included help for option to change the LED behavior. LED blinking on SD card access can be disabled through `sc64` executable. Please refer to included help for option to change the LED behavior.

1
docs/04_config_options.md
View File

@ -174,7 +174,6 @@ type: *bool* | default: `0`
- `1` - 64DD block requests are passed to SD card - `1` - 64DD block requests are passed to SD card
Use this setting to change where 64DD emulation will be passing incoming block R/W requests. Use this setting to change where 64DD emulation will be passing incoming block R/W requests.
For more information about 64DD and USB request passing check [sc64.py](../sw/pc/sc64.py#L636) implementation.
--- ---

4
sw/pc/sc64.py
View File

@ -1264,8 +1264,8 @@ if __name__ == '__main__':
print(f'SC64 firmware version: [{version}]') print(f'SC64 firmware version: [{version}]')
if (script_outdated): if (script_outdated):
print('\x1b[33m') print('\x1b[33m')
print('[ SC64 firmware is newer than last known version. ]') print('[ SC64 firmware is newer than last known version ]')
print('[ Consider downloading latest script from ]') print('[ Consider downloading latest sc64 executable from ]')
print('[ https://github.com/Polprzewodnikowy/SummerCart64/releases ]') print('[ https://github.com/Polprzewodnikowy/SummerCart64/releases ]')
print('\x1b[0m') print('\x1b[0m')