Skip to content

Commit ef18cc0

Browse files
committed
📝 Improve doc, add links and screenshot
1 parent cb1c9b9 commit ef18cc0

File tree

2 files changed

+44
-16
lines changed

2 files changed

+44
-16
lines changed

README.md

Lines changed: 44 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,51 @@
1-
# hsk00
1+
# 🚧 hsk00 🚧
22

3-
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)
3+
Add/Replace games to your "Data Frog Y2 (568 in 1)" console.
44

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

7-
---
9+
⚠️ Before you use this, backup your SD card. Just copy/paste all files to your computer.
10+
<br />
11+
<br />
12+
13+
## Download
14+
15+
There is no install step. You just download and run. GUI app will take some time to load (only on first launch)
16+
17+
- [Mac OS X GUI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk-osx-gui.app.zip)
18+
- Windows GUI (Not ready yet)
19+
- Linux GUI (Not ready yet)
20+
- [Mac OS X CLI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk00-darwin-amd64)
21+
- [Linux CLI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk00-linux-amd64) (Should work with all popular distros)
22+
- [Windows X CLI](https://github.com/dev-drprasad/hsk00/releases/download/latest/hsk00-windows-amd64.exe)
23+
24+
For CLI app, you need to give executable permission by running `chmod +x hsk00-darwin-amd64`
825

926
<br />
1027

11-
## API
28+
## CLI API
1229

13-
⚠️ BEFORE YOU RUN ANY COMMAND, BACKUP YOUR SD CARD ⚠️
14-
<br /><br />
30+
<br />
1531

1632
### `add`
1733

18-
Adds game(s) to given category (Sports, Adventure etc..)
34+
Adds game(s) to given category (Racing, Adventure etc..)
1935

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

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

2440
**Example:**
2541

2642
```shell
27-
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
43+
hsk00-darwin-amd64 add nesroms/Famicom_Wars.nes nesroms/Heavy_Barrel --category 4 --root ~/Datafrog
2844
```
2945

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

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

3450
<br />
3551

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

4056
Not implemented yet
4157

42-
---
43-
4458
<br />
4559

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

5670
<br />
5771

72+
### `scramble`
73+
74+
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.
75+
76+
Example:
77+
78+
```
79+
hsk00-darwin-amd64 scramble file1.nes file2.nes --out hskXX.asd
80+
```
81+
82+
<br />
83+
5884
## Supported Consoles
5985

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

64-
<img src="./sd-layout.png" alt="data-frog-sd-card-files" width="500" />
90+
<p align="center">
91+
<img src="./sd-layout.png" alt="data-frog-sd-card-files" width="500" />
92+
</p>
6593

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

screenshot-osx.png

292 KB
Loading

0 commit comments

Comments
 (0)