improved readme

This commit is contained in:
~d6 2024-07-27 22:43:08 -04:00
parent b9c204469e
commit 0c8781b12c
1 changed files with 35 additions and 1 deletions

View File

@ -4,6 +4,8 @@
![screenshot of initial solitaire deal](start.png) ![screenshot of initial solitaire deal](start.png)
## details
Currently *Kodiak* is very limited: Currently *Kodiak* is very limited:
- Can't move cards from the foundation - Can't move cards from the foundation
@ -18,6 +20,8 @@ Future releases may relax some or all of these constraints.
![screenshot of solitarire mid-game](game1.png) ![screenshot of solitarire mid-game](game1.png)
## building and running
Building the Kodiak ROM requires a Uxn assembler: Building the Kodiak ROM requires a Uxn assembler:
``` ```
@ -31,6 +35,36 @@ Running the Kodiak ROM requires an emulator. For example:
$ uxnemu kodiak.rom $ uxnemu kodiak.rom
``` ```
## infrequently-asked questions
**Is dragging cards buggy?**
You don't need to hold down the mouse button when dragging a card.
Just click once to pick up and click again to release.
**Is this harder than other solitaire games?**
Probably, yes. In addition to not having an "undo" feature, Kodiak
does not check to see if a solitaire deal is winnable or not, meaning
that some games would probably be impossible to win no matter how you
played them.
**Can I make the game bigger?**
Many emulators support a zoom option. For example, `uxnemu` and
`uxn11` both use the F1 key to toggle zoom levels.
The game size is intentionally small to support older platforms with
lower screen resolution, such as the Nintendo DS.
**I won the game and the cards didn't bounce!**
That isn't a question. (Also, sorry!)
**Will you add support for my preferred solitaire variant?**
Probably not, but maybe. I am considering adding support for [Sawayama Solitaire](https://zachtronics.fandom.com/wiki/Sawayama_Solitaire). Depending on how that goes I may consider adding support for other variants as well.
![another screenshot of solitaire](game2.png) ![another screenshot of solitaire](game2.png)
Kodiak was built by d_m, 2023-2024 Kodiak was built by [d_m](http://plastic-idolatry.com/erik), 2023-2024