diff --git a/SDFE.md b/SDFE.md index 89796ce..c962ff2 100644 --- a/SDFE.md +++ b/SDFE.md @@ -1,96 +1,96 @@ -## SDFE - -Some instructions how to get SDFE up and running - -### Setup Instructions - -1. Get the game data and extract it somewhere (`E:/` drive won't work!) -2. Grab the segatools below and extract it in the `bin` directory: - -#### segatools - -| Name | Link | Details | -| --------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| segatools | [Download mercury.zip](https://gitea.tendokyu.moe/Dniel97/segatools/releases/download/latest/segatools.zip) | - [Open-Source](https://gitea.tendokyu.moe/Dniel97/segatools/src/branch/develop)
- Touch/LED hook | - -3. Read the segatools [Documentation](https://gitea.tendokyu.moe/Dniel97/segatools/src/branch/master/doc/config/common.md) and configure at least those values in your `segatools.ini`: - - -#### `[vfs]` - -| Key | Default Value | Documentation | -| --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amfs` | Empty string (causes a startup error) | Configure the location of the SEGA AMFS volume. Stored on the `E` partition on real hardware. | -| `appdata` | Empty string (causes a startup error) | Configure the location of the SEGA "APPDATA" volume (nothing to do with the Windows user's `%APPDATA%` directory). Stored on the `Y` partition on real hardware. | - - -#### `[dns]` - -| Key | Default Value | Documentation | -| --------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `default` | `localhost` | Controls hostname of all of the common network services servers, unless overriden by a specific setting below. Most users will only need to change this setting. Also, loopback addresses are specifically checked for and rejected by the games themselves; this needs to be a LAN or WAN IP (or a hostname that resolves to one). Use your local IPv4 PC address if unsure. | - -#### `[gpio]` - - -| Key | Default Value | Documentation | -| -------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `dipsw1` | `1` | LAN Install: If multiple machines are present on the same LAN then set this to 1 on exactly one machine and set this to 0 on all others. | - - -4. Grab the unpacked files according to your game version and extract it in the base directory (where `bin` and `WindowsNoEditor` is located): - -#### Packages - -| Version | Link | Details | -| ---------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| 3.07.01 | [Download](https://gitea.tendokyu.moe/Dniel97/SEGAguide/media/branch/master/SDFE/30701.zip) | - Includes amfs folder with correct ICF files
- Includes FTDI driver, which is needed for LEDs (for now?) | -| Any2WACCAi | [Download](https://gitea.tendokyu.moe/Dniel97/SEGAguide/media/branch/master/SDFE/Any2WACCAi.zip) | - HIGHLY RECOMMENDED!
- Updated Mishe's virtual controller for touch devices | - -5. Use one of the following local servers to save your progress: - -#### Server - -| Name | Programming language | Details | -| ------------------------------------------------------ | -------------------- | -------------------------------------------------------------- | -| [ARTEMiS](https://gitea.tendokyu.moe/Hay1tsme/artemis) | Python 3.9+ | - Currently the only open source WACCA server
- Useless GUI | - -6. Regardless of the used server, make sure the title server IP address is not `localhost` or `127.0.0.1`, rather your own IPv4 address! -7. Optional, but highly recommended: Install **[Any2WACCAi](#anny2waccai)** from packages. -8. DONE! Launch `start.bat` and have fun :) -9. _Hold_ the Enter key for a few seconds to scan a card, this will now automatically create a random `aime.txt` in the `DEVICE` folder - - -### Any2WACCAi Installation - -1. Download and install [com0com](https://sourceforge.net/projects/com0com/files/latest/download) -2. Open `setupg` and configure two Virtual Pairs - - Virtual Pair 0: COM3 <-> COM 5 - - Virtual Pair 1: COM4 <-> COM6 -3. Set `enable buffer overrun` for all 4 COM ports -4. Change the following config in `segatools.ini` to - -```ini -; Hooks related to the touch boards -[touch] -enable=0 -``` - -5. Launch `Any2WACCAi.exe` and open the following URL on your touch device: -``` -http://:5730/ -``` - -6. (Optional, but highly recommended for Android tablets): Connect your Android tablet (with USB Debugging enabled!) via USB to your PC, install [adb](https://developer.android.com/tools/releases/platform-tools), add it to PATH and execute: -```shell -adb reverse tcp:5730 tcp:5730 -``` -and only open -``` -http://127.0.0.1:5730/ -``` - -7. Have fun! - - -(c) Instructions written by Dniel97 +## SDFE + +Some instructions how to get SDFE up and running + +### Setup Instructions + +1. Get the game data and extract it somewhere (`E:/` drive won't work!) +2. Grab the segatools below and extract it in the `bin` directory: + +#### segatools + +| Name | Link | Details | +| --------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| segatools | [Download mercury.zip](https://gitea.tendokyu.moe/Dniel97/segatools/releases/download/latest/segatools.zip) | - [Open-Source](https://gitea.tendokyu.moe/Dniel97/segatools/src/branch/develop)
- Touch hook
- LED (Elisabeth) hook
- Freeplay toggle | + +3. Read the segatools [Documentation](https://gitea.tendokyu.moe/Dniel97/segatools/src/branch/master/doc/config/common.md) and configure at least those values in your `segatools.ini`: + + +#### `[vfs]` + +| Key | Default Value | Documentation | +| --------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `amfs` | Empty string (causes a startup error) | Configure the location of the SEGA AMFS volume. Stored on the `E` partition on real hardware. | +| `appdata` | Empty string (causes a startup error) | Configure the location of the SEGA "APPDATA" volume (nothing to do with the Windows user's `%APPDATA%` directory). Stored on the `Y` partition on real hardware. | + + +#### `[dns]` + +| Key | Default Value | Documentation | +| --------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `default` | `localhost` | Controls hostname of all of the common network services servers, unless overriden by a specific setting below. Most users will only need to change this setting. Also, loopback addresses are specifically checked for and rejected by the games themselves; this needs to be a LAN or WAN IP (or a hostname that resolves to one). Use your local IPv4 PC address if unsure. | + +#### `[gpio]` + + +| Key | Default Value | Documentation | +| -------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | +| `dipsw1` | `1` | LAN Install: If multiple machines are present on the same LAN then set this to 1 on exactly one machine and set this to 0 on all others. | + + +4. Grab the unpacked files according to your game version and extract it in the base directory (where `bin` and `WindowsNoEditor` is located): + +#### Packages + +| Version | Link | Details | +| ---------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | +| 3.07.01 | [Download](https://gitea.tendokyu.moe/Dniel97/SEGAguide/media/branch/master/SDFE/30701.zip) | - Includes amfs folder with correct ICF files
- Includes FTDI driver, which is needed for LEDs (for now?) | +| Any2WACCAi | [Download](https://gitea.tendokyu.moe/Dniel97/SEGAguide/media/branch/master/SDFE/Any2WACCAi.zip) | - HIGHLY RECOMMENDED!
- Updated Mishe's virtual controller for touch devices
- Updated by @Raymonf | + +5. Use one of the following local servers to save your progress: + +#### Server + +| Name | Programming language | Details | +| ------------------------------------------------------ | -------------------- | -------------------------------------------------------------- | +| [ARTEMiS](https://gitea.tendokyu.moe/Hay1tsme/artemis) | Python 3.9+ | - Currently the only open source WACCA server
- Useless GUI | + +6. Regardless of the used server, make sure the title server IP address is not `localhost` or `127.0.0.1`, rather your own IPv4 address! +7. Optional, but highly recommended: Install **[Any2WACCAi](#anny2waccai)** from packages. +8. DONE! Launch `start.bat` and have fun :) +9. _Hold_ the Enter key for a few seconds to scan a card, this will now automatically create a random `aime.txt` in the `DEVICE` folder + + +### Any2WACCAi Installation + +1. Download and install [com0com](https://sourceforge.net/projects/com0com/files/latest/download) +2. Open `setupg` and configure two Virtual Pairs + - Virtual Pair 0: COM3 <-> COM 5 + - Virtual Pair 1: COM4 <-> COM6 +3. Set `enable buffer overrun` for all 4 COM ports +4. Change the following config in `segatools.ini` to + +```ini +; Hooks related to the touch boards +[touch] +enable=0 +``` + +5. Launch `Any2WACCAi.exe` and open the following URL on your touch device: +``` +http://:5730/ +``` + +6. (Optional, but highly recommended for Android tablets): Connect your Android tablet (with USB Debugging enabled!) via USB to your PC, install [adb](https://developer.android.com/tools/releases/platform-tools), add it to PATH and execute: +```shell +adb reverse tcp:5730 tcp:5730 +``` +and only open +``` +http://127.0.0.1:5730/ +``` + +7. Have fun! + + +(c) Instructions written by Dniel97