Skip to content

Commit c9eb2d1

Browse files
committed
📝 Fix releases link and prettify doc
1 parent c98dcc9 commit c9eb2d1

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,50 @@
11
# hsk00
22

3-
Add/Replace games to your "Data Frog Y2 (568 in 1)" console. This is CLI tool. Download tool from [releases](/releases)
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)
44

55
🚧 **This is work in progress** 🚧
66

7+
---
8+
9+
<br />
10+
711
## API
812

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

1116
### `add`
1217

18+
Adds game(s) to given category (Sports, Adventure etc..)
19+
1320
`--category` number starts from 0, left to right in menu. Example: "Sports Games" category number is `4`.
21+
1422
`--root` is root directory of game folder where `Menu.ocv` exists (can be sd card path or custom directory where files present)
1523

24+
**Example:**
25+
1626
```shell
1727
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
1828
```
1929

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

32+
---
33+
2234
### `replace`
2335

2436
Replace will replace existing game with custom game.
2537

2638
Not implemented yet
2739

40+
---
41+
2842
### `descramble`
2943

3044
Not implemented yet
3145

46+
---
47+
3248
## Supported Consoles
3349

3450
- DATA FROG Y2 HD (568 in 1)
@@ -39,6 +55,12 @@ Not implemented yet
3955

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

58+
## TODO
59+
60+
- [] May be GUI ?
61+
- [] replace game
62+
- [] delete game
63+
4264
## Need Help
4365

4466
I am not able to understand what are `GameXX.bin`, `Menu.logXX` files. They have background images, and menu selection images hidden them. But I am not able to determine offset of these images. If you know anything about these files, please let me know.

0 commit comments

Comments
 (0)