kodiak/README.md

74 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2024-07-15 15:58:05 +01:00
# kodiak
2024-07-28 03:04:02 +01:00
*Kodiak* is an implementation of [Klondike Solitaire](https://en.wikipedia.org/wiki/Klondike_(solitaire)) for the[Uxn/Varvara ecosystem](https://100r.co/site/uxn.html) virtual machine.
2024-08-07 05:28:05 +01:00
![screenshot of splash screen](about.png)
2024-07-15 15:58:05 +01:00
2024-07-28 05:47:43 +01:00
## controls
- Use the mouse to move the pointer
- Click to pick up cards; release to drop them
2024-07-28 05:47:43 +01:00
- Press *Return* to print internal game state
2024-07-28 03:43:08 +01:00
## details
2024-08-07 05:34:25 +01:00
Currently *Kodiak* is somewhat limited:
2024-07-28 03:04:02 +01:00
- No undo functionality
- No scoring or timing
2024-07-28 20:19:05 +01:00
- No options
2024-07-28 03:04:02 +01:00
Future releases may relax some or all of these constraints.
2024-08-07 05:28:05 +01:00
![screenshot of starting solitarire deal](start.png)
2024-07-28 03:04:02 +01:00
2024-07-28 03:43:08 +01:00
## building and running
2024-07-28 03:04:02 +01:00
Building the Kodiak ROM requires a Uxn assembler:
2024-07-15 15:58:05 +01:00
```
2024-07-28 03:04:02 +01:00
$ uxnasm kodiak.tal kodiak.rom
Assembled kodiak.rom in 10923 bytes(16.73% used), 253 labels, 0 macros.
2024-07-15 15:58:05 +01:00
```
2024-07-28 03:04:02 +01:00
Running the Kodiak ROM requires an emulator. For example:
```
$ uxnemu kodiak.rom
```
2024-07-28 03:43:08 +01:00
## infrequently-asked questions
**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!)
2024-07-28 05:40:03 +01:00
**Why did a bunch of weird numbers appeared in the console?**
Currently hitting *Return* will dump the internal state of the game for debugging purposes. This produces a lot of output but doesn't otherwise affect the game.
2024-07-28 03:43:08 +01:00
**Will you add support for my preferred solitaire variant?**
2024-07-28 03:44:57 +01:00
Probably not, but maybe.
2024-07-28 03:45:23 +01:00
I am considering adding support for [Sawayama Solitaire](https://zachtronics.fandom.com/wiki/Sawayama_Solitaire). Depending on how that goes I may add support for other variants as well.
2024-07-28 03:43:08 +01:00
2024-08-07 05:28:05 +01:00
![screenshot of solitaire mid-game](game1.png)
2024-07-28 03:04:02 +01:00
2024-07-28 03:43:08 +01:00
Kodiak was built by [d_m](http://plastic-idolatry.com/erik), 2023-2024