qmk_firmware/keyboards/spaceman/2_milk/keymaps/encg/readme.md

# encg's Keymap

## What is this?

A simple slot machine emulator for the [2% Milk Keyboard](https://github.com/Spaceman/SpaceboardsHardware/tree/master/Keyboards/2%25%20Milk). This idea is based on the [implementation by /u/ln8r on /r/mechanicalkeyboards](https://www.reddit.com/r/MechanicalKeyboards/comments/hcw21b/2_milk_slot_machine/).

## How does it work?

The top button outputs all possible winning emoji combinations followed by a corresponding "score." Emojis are output one-by-one with a short delay to simulate the "slots" feel.

![IMG](https://i.imgur.com/rUc3IOn.gif)

The bottom button outputs 3 random emojis one by one. The random function takes `timer_read()` as its seed value [(referenced here)](https://beta.docs.qmk.fm/developing-qmk/qmk-reference/ref_functions#software-timers).

![IMG](https://i.imgur.com/4EREsIq.png)

## Unicode Setup

This keymap's default unicode input mode is `UNICODE_MODE_WINCOMPOSE` which requires [WinCompose](https://github.com/samhocevar/wincompose). For other OSes, see [QMK documentation on unicode input modes](https://docs.qmk.fm/#/feature_unicode?id=input-modes).

## Ideas for the future

- [ ] Factor in emoji hierarchy into RNG algorithm
- [ ] Random/Wildcard emoji
- [ ] Keep a count for winng combinations
- [ ] Implement tap dance for easily switching unicode input types
[Keymap] Adding encg keymap for 2% Milk keyboard (#11041) * adding my keymap * Updating coding convention and style for new keymap PR * Added GPL license header and to-do list to readme 2020-12-06 12:04:22 -08:00			`# encg's Keymap`

			`## What is this?`

			`A simple slot machine emulator for the [2% Milk Keyboard](https://github.com/Spaceman/SpaceboardsHardware/tree/master/Keyboards/2%25%20Milk). This idea is based on the [implementation by /u/ln8r on /r/mechanicalkeyboards](https://www.reddit.com/r/MechanicalKeyboards/comments/hcw21b/2_milk_slot_machine/).`

			`## How does it work?`

			`The top button outputs all possible winning emoji combinations followed by a corresponding "score." Emojis are output one-by-one with a short delay to simulate the "slots" feel.`

			`![IMG](https://i.imgur.com/rUc3IOn.gif)`

			The bottom button outputs 3 random emojis one by one. The random function takes `timer_read()` as its seed value [(referenced here)](https://beta.docs.qmk.fm/developing-qmk/qmk-reference/ref_functions#software-timers).

			`![IMG](https://i.imgur.com/4EREsIq.png)`

			`## Unicode Setup`

Normalise Unicode keycodes (#18898) * `UC_MOD`/`UC_RMOD` -> `UC_NEXT`/`UC_PREV` * `UNICODE_MODE_` -> `QK_UNICODE_MODE_` * `UC_MAC` -> `UNICODE_MODE_MACOS` * `UC_LNX` -> `UNICODE_MODE_LINUX` * `UC_WIN` -> `UNICODE_MODE_WINDOWS` * `UC_BSD` -> `UNICODE_MODE_BSD` * `UC_WINC` -> `UNICODE_MODE_WINCOMPOSE` * `UC_EMACS` -> `UNICODE_MODE_EMACS` * `UC__COUNT` -> `UNICODE_MODE_COUNT` * `UC_M_MA` -> `UC_MAC` * `UC_M_LN` -> `UC_LINX` * `UC_M_WI` -> `UC_WIN` * `UC_M_BS` -> `UC_BSD` * `UC_M_WC` -> `UC_WINC` * `UC_M_EM` -> `UC_EMAC` * Docs * Update quantum/unicode/unicode.h 2022-10-31 14:15:12 -07:00			This keymap's default unicode input mode is `UNICODE_MODE_WINCOMPOSE` which requires [WinCompose](https://github.com/samhocevar/wincompose). For other OSes, see [QMK documentation on unicode input modes](https://docs.qmk.fm/#/feature_unicode?id=input-modes).
[Keymap] Adding encg keymap for 2% Milk keyboard (#11041) * adding my keymap * Updating coding convention and style for new keymap PR * Added GPL license header and to-do list to readme 2020-12-06 12:04:22 -08:00
			`## Ideas for the future`

			`- [ ] Factor in emoji hierarchy into RNG algorithm`
			`- [ ] Random/Wildcard emoji`
			`- [ ] Keep a count for winng combinations`
			`- [ ] Implement tap dance for easily switching unicode input types`