{"id":26517581,"url":"https://github.com/m165437/nice-view-gem","last_synced_at":"2026-01-26T19:28:23.618Z","repository":{"id":283353919,"uuid":"875544803","full_name":"M165437/nice-view-gem","owner":"M165437","description":"A sleek customization for the nice!view shield","archived":false,"fork":false,"pushed_at":"2025-03-19T19:21:39.000Z","size":280,"stargazers_count":212,"open_issues_count":2,"forks_count":46,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-28T10:06:42.316Z","etag":null,"topics":["zmk","zmk-module"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/M165437.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-20T09:14:40.000Z","updated_at":"2025-03-27T20:39:38.000Z","dependencies_parsed_at":"2025-03-19T20:40:28.483Z","dependency_job_id":null,"html_url":"https://github.com/M165437/nice-view-gem","commit_stats":null,"previous_names":["m165437/nice-view-gem"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M165437%2Fnice-view-gem","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M165437%2Fnice-view-gem/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M165437%2Fnice-view-gem/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/M165437%2Fnice-view-gem/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/M165437","download_url":"https://codeload.github.com/M165437/nice-view-gem/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247166168,"owners_count":20894654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["zmk","zmk-module"],"created_at":"2025-03-21T08:27:41.853Z","updated_at":"2026-01-26T19:28:23.612Z","avatar_url":"https://github.com/M165437.png","language":"C","readme":"# nice-view-gem\n\n![Preview](https://github.com/m165437/nice-view-gem/blob/main/.github/assets/preview.jpg?raw=true)\n\n### A sleek customization for the nice!view shield\n\nAdd this shield to your keymap repo (see usage below) and run the GitHub action to build your firmware.\n\n### Features\n\n- Uses a **fixed range for the chart and gauge deflection**. 📈\n- Includes a **beautiful animation** for the peripheral of split keyboards. 💎\n- Comes with **pixel-perfect symbols** for BLE and USB connections. 📡\n\n## Usage\n\nTo use this shield, first add it to your `config/west.yml` by adding a new entry to remotes and projects.\n\nAlways pin both ZMK and this module to matching revisions.\n\n- ZMK `v0.3` → use release `v0.3.0`\n- ZMK `main` (Zephyr 4.1+) → use the `main` branch\n\n```yml\nmanifest:\n  remotes:\n    - name: zmkfirmware\n      url-base: https://github.com/zmkfirmware\n    - name: m165437 #new entry\n      url-base: https://github.com/M165437 #new entry\n  projects:\n    - name: zmk\n      remote: zmkfirmware\n      revision: main\n      import: app/west.yml\n    - name: nice-view-gem #new entry\n      remote: m165437 #new entry\n      revision: main #new entry\n  self:\n    path: config\n```\n\nNow, simply swap out the default nice_view shield on the board for nice_view_gem in your `build.yaml` file.\n\n```yml\n---\ninclude:\n  - board: nice_nano_v2\n    shield: kyria_left nice_view_adapter nice_view_gem #updated entry\n  - board: nice_nano_v2\n    shield: kyria_right nice_view_adapter nice_view_gem #updated entry\n```\n\nFinally, make sure to enable the custom status screen in your ZMK configuration:\n\n```conf\nCONFIG_ZMK_DISPLAY=y\nCONFIG_ZMK_DISPLAY_STATUS_SCREEN_CUSTOM=y\n```\n\n## Configuration\n\nModify the behavior of this shield by adjusting these options in your personal configuration files. For a more detailed explanation, refer to [Configuration in the ZMK documentation](https://zmk.dev/docs/config).\n\n| Option                                     | Type | Description                                                                                                                                                                                                                                                       | Default |\n| ------------------------------------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |\n| `CONFIG_NICE_VIEW_GEM_WPM_FIXED_RANGE`     | bool | This shield uses a fixed range for the chart and gauge deflection. If you set this option to `n`, it switches to a dynamic range, like the default nice!view shield, which adjusts based on the last 10 WPM values provided by ZMK.                               | y       |\n| `CONFIG_NICE_VIEW_GEM_WPM_FIXED_RANGE_MAX` | int  | Adjusts the maximum value of the fixed range to better align with your current goal.                                                                                                                                                                              | 100     |\n| `CONFIG_NICE_VIEW_GEM_ANIMATION`           | bool | If you find the animation distracting (or want to save battery), you can turn it off by setting this option to `n`. When disabled, a random animation frame is selected each time you restart your keyboard.                                                      | y       |\n| `CONFIG_NICE_VIEW_GEM_ANIMATION_FRAME`     | int  | When the animation is disabled, you can set this to a specific frame index (1–16) to display instead of a random one.                                                                                                                                             | 0       |\n| `CONFIG_NICE_VIEW_GEM_ANIMATION_MS`        | int  | Controls the animation speed. Higher values increase the delay between frames (for example, `96000` shows a new frame every couple of seconds). The animation has 16 frames; the default value of 960 milliseconds plays it at 60 fps.                            | 960     |\n\n## Credits\n\nShoutout to Teenage Engineering for their [TX-6](https://teenage.engineering/products/tx-6), from which the inspiration (and maybe even a few pixel strokes) originated. 😬\n\nAs for the floating crystal, appreciation goes to the pixel wizardry of Trixelized, who graciously lent their art to this project. 💎\n\nThe font, Pixel Operator, is the work of Jayvee Enaguas, kindly shared under a [Creative Commons Zero (CC0) 1.0](https://creativecommons.org/publicdomain/zero/1.0/) license. 🖋️\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm165437%2Fnice-view-gem","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm165437%2Fnice-view-gem","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm165437%2Fnice-view-gem/lists"}