Skip to content

Commit

Permalink
📝 Fix releases link and prettify doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dev-drprasad committed Jan 5, 2021
1 parent c98dcc9 commit c9eb2d1
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,50 @@
# hsk00

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

🚧 **This is work in progress** 🚧

---

<br />

## API

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

### `add`

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

`--category` number starts from 0, left to right in menu. Example: "Sports 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
```

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

---

### `replace`

Replace will replace existing game with custom game.

Not implemented yet

---

### `descramble`

Not implemented yet

---

## Supported Consoles

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

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

## TODO

- [] May be GUI ?
- [] replace game
- [] delete game

## Need Help

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.
Expand Down

0 comments on commit c9eb2d1

Please sign in to comment.