Skip to content

Commit

Permalink
📝 Improve doc, add links and screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
dev-drprasad committed Jan 6, 2021
1 parent cb1c9b9 commit ef18cc0
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 16 deletions.
60 changes: 44 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,51 @@
# hsk00
# 🚧 hsk00 🚧

Add/Replace games to your "Data Frog Y2 (568 in 1)" console. This is CLI tool. Download tool from [releases](https://github.com/dev-drprasad/hsk00/releases)
Add/Replace games to your "Data Frog Y2 (568 in 1)" console.

🚧 **This is work in progress** 🚧
<p align="center">
<img src="screenshot-osx.png" alt="hsk00-osx-screenshot" width="450" />
</p>

---
⚠️ Before you use this, backup your SD card. Just copy/paste all files to your computer.
<br />
<br />

## Download

There is no install step. You just download and run. GUI app will take some time to load (only on first launch)

- [Mac OS X GUI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk-osx-gui.app.zip)
- Windows GUI (Not ready yet)
- Linux GUI (Not ready yet)
- [Mac OS X CLI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk00-darwin-amd64)
- [Linux CLI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk00-linux-amd64) (Should work with all popular distros)
- [Windows X CLI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk00-windows-amd64.exe)

For CLI app, you need to give executable permission by running `chmod +x hsk00-darwin-amd64`

<br />

## API
## CLI API

⚠️ BEFORE YOU RUN ANY COMMAND, BACKUP YOUR SD CARD ⚠️
<br /><br />
<br />

### `add`

Adds game(s) to given category (Sports, Adventure etc..)
Adds game(s) to given category (Racing, Adventure etc..)

`--category` number starts from 0, left to right in menu. Example: "Sports Games" category number is `4`.
`--category` number starts from `0`, left to right in menu. Example: "Racing Games" category number is `4`.

`--root` is root directory of game folder where `Menu.ocv` exists (can be sd card path or custom directory where files present)

**Example:**

```shell
hsk00-darwin-amd64 add in/Famicom_Wars.nes in/Heavy_Barrel.nes in/Fantasy_Zone.nes in/Final_Fantasy_II.nes --category 4 --root ~/Datafrog
hsk00-darwin-amd64 add nesroms/Famicom_Wars.nes nesroms/Heavy_Barrel --category 4 --root ~/Datafrog
```

⚠️ This will change menu text slightly ⚠️. If you can't lanuch games or change menu page, restore files with your backup.
⚠️ This will change menu text slightly.

---
If you can't lanuch games or change page, restore files with your backup.

<br />

Expand All @@ -39,8 +55,6 @@ Replace will replace existing game with custom game.

Not implemented yet

---

<br />

### `descramble`
Expand All @@ -55,13 +69,27 @@ hsk00-darwin-amd64 descramble ~/Datafrog2/Game04/hsk06.asd

<br />

### `scramble`

Generates scrambled `asd` file given mutliple files. Input files can be anything. This is low level API. If you're uncertain what this command do, probably you don't need this command.

Example:

```
hsk00-darwin-amd64 scramble file1.nes file2.nes --out hskXX.asd
```

<br />

## Supported Consoles

- DATA FROG Y2 HD (568 in 1)
- Extreme Mini HD Game Box
- Probably works with SD card that looks like below
- Probably works with console whose SD card looks like below

<img src="./sd-layout.png" alt="data-frog-sd-card-files" width="500" />
<p align="center">
<img src="./sd-layout.png" alt="data-frog-sd-card-files" width="500" />
</p>

Let me know if it works with other consoles. It helps other people

Expand Down
Binary file added screenshot-osx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ef18cc0

Please sign in to comment.