Skip to content

Commit

Permalink
Update documentation and mrext version (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
wizzomafizzo authored Mar 11, 2024
1 parent b99fb7a commit e14aaee
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 3 deletions.
29 changes: 29 additions & 0 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ This text can be as simple as a path to a game file, or perform multiple custom
- [Absolute Path](#absolute-path)
- [Relative Path](#relative-path)
- [System Lookup](#system-lookup)
- [Special Cases](#special-cases)
- [ao486](#ao486)
- [AmigaVision (Amiga)](#amigavision-amiga)
- [NeoGeo](#neogeo)
- [Combining Commands](#combining-commands)
- [Custom Commands](#custom-commands)
- [Generic Launch (launch)](#generic-launch-launch)
Expand Down Expand Up @@ -137,6 +141,31 @@ PCEngine/Another Game (USA).pce
> [!NOTE]
> While this method is basically the same as a relative path right now, as TapTo develops, we will be adding more features to this System Lookup method so it's not necessary to use explcit paths. It will also be important going forward as more devices are supported with different file structures.
### Special Cases

Some systems have special cases and extra support implemented for their launching capabilities.

#### ao486

If a .vhd file is launched via TapTo, and this .vhd file is sitting in its own folder with an .iso file, that .iso file will also be automatically mounted alongside the .vhd file.

#### AmigaVision (Amiga)

Launching games in the [AmigaVision](https://amiga.vision/) image on the Amiga core is supported via the `games.txt` files and `demos.txt` files located in the `Amiga/listings` folder on your SD card.

For example, to launch Beneath a Stell Sky in AmigaVision:
```
Amiga/listings/games.txt/Beneath a Steel Sky (OCS)[en]
```

The `games.txt` and `demos.txt` files contain a listing of all supported games and demos, generated by AmigaVision, and can be treated as a virtual folder for launching via TapTo. Other games can be launched using the same format of `Amiga/listings/games.txt/<Game Name>`.

Opening the `games.txt` and `demos.txt` files in a text editor will show the full list of supported games and demos.

#### NeoGeo

NeoGeo also supports launching .zip files and folders directly with TapTo, as is supported with the MiSTer core itself.

## Combining Commands

All commands and game/core launches can be combined on a single token if space permits using the `||` separator.
Expand Down
6 changes: 3 additions & 3 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ require (
github.com/txn2/txeh v1.4.0 // indirect
golang.org/x/mod v0.15.0 // indirect
golang.org/x/net v0.21.0 // indirect
golang.org/x/sys v0.17.0 // indirect
golang.org/x/sys v0.18.0 // indirect
golang.org/x/tools v0.18.0 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.0.0
gopkg.in/yaml.v3 v3.0.1 // indirect
Expand All @@ -30,7 +30,7 @@ require (
require (
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
golang.org/x/term v0.17.0 // indirect
golang.org/x/term v0.18.0 // indirect
)

require (
Expand All @@ -39,5 +39,5 @@ require (
github.com/hsanjuan/go-ndef v0.0.1
github.com/joho/godotenv v1.5.1
github.com/rs/zerolog v1.31.0
github.com/wizzomafizzo/mrext v0.0.0-20240303122843-4575382d468a
github.com/wizzomafizzo/mrext v0.0.0-20240310134955-83d3355e2a28
)
6 changes: 6 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ github.com/wizzomafizzo/mrext v0.0.0-20240224140822-3314a169bb9b h1:DRmnv7pJvO8F
github.com/wizzomafizzo/mrext v0.0.0-20240224140822-3314a169bb9b/go.mod h1:NVCseMt06sXiZ9fsA1OdiaMfVfK6jp3t1VCJF7DLGHU=
github.com/wizzomafizzo/mrext v0.0.0-20240303122843-4575382d468a h1:VOhreW4fiJj24L82f7b4pEwleJM6BvVPXM9yVOzBaYE=
github.com/wizzomafizzo/mrext v0.0.0-20240303122843-4575382d468a/go.mod h1:NVCseMt06sXiZ9fsA1OdiaMfVfK6jp3t1VCJF7DLGHU=
github.com/wizzomafizzo/mrext v0.0.0-20240310134955-83d3355e2a28 h1:7InFy5PJfj0xHv1zL7gZ9MFRMIKesTIiTjWIA+rK/Y8=
github.com/wizzomafizzo/mrext v0.0.0-20240310134955-83d3355e2a28/go.mod h1:pWjoPIzJIXlDfEmdf++eUqsZKrEsYVkOHy39s/H7WLA=
golang.org/x/exp v0.0.0-20240222234643-814bf88cf225 h1:LfspQV/FYTatPTr/3HzIcmiUFH7PGP+OQ6mgDYo3yuQ=
golang.org/x/exp v0.0.0-20240222234643-814bf88cf225/go.mod h1:CxmFvTBINI24O/j8iY7H1xHzx2i4OsyguNBmN/uPtqc=
golang.org/x/mod v0.15.0 h1:SernR4v+D55NyBH2QiEQrlBAnj1ECL6AGrA5+dPaMY8=
Expand All @@ -63,9 +65,13 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.17.0 h1:25cE3gD+tdBA7lp7QfhuV+rJiE9YXTcS3VG1SqssI/Y=
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.17.0 h1:mkTF7LCd6WGJNL3K1Ad7kwxNfYAW6a8a8QqtMblp/4U=
golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
golang.org/x/term v0.18.0 h1:FcHjZXDMxI8mM3nwhX9HlKop4C0YQvCVCdwYl2wOtE8=
golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
Expand Down

0 comments on commit e14aaee

Please sign in to comment.