git404hub

what is nur-modkeys fr?

nuroctane/nur-modkeys — explained in plain English

Analysis updated 2026-05-18

0JavaScriptAudience · generalComplexity · 2/5LicenseSetup · easy

tl;dr

A browser tool for designing and previewing custom mechanical keyboards in 3D, then exporting the design for building.

vibe map

mindmap
  root((MODKEYS))
    What it does
      3D keyboard preview
      Live customization
      Export designs
    Tech stack
      Vanilla JavaScript
      Three.js
      Vite
    Use cases
      Design a keyboard
      Share a build
      Get manufacturing files
    Audience
      Keyboard hobbyists
      Makers

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

Design a custom mechanical keyboard and preview it in 3D before ordering parts.

VIBE 2

Export a finished design as an SVG manufacturing template or spec sheet for a builder.

VIBE 3

Share a keyboard build with others using a link that encodes the full configuration.

what's the stack?

JavaScriptViteThree.jsGSAPWeb Audio API

how it stacks up fr

nuroctane/nur-modkeys00kaku/gallery-slider-block3rd-eden/ircb.io
Stars0
LanguageJavaScriptJavaScriptJavaScript
Last pushed2021-05-192016-11-16
MaintenanceDormantDormant
Setup difficultyeasyeasyeasy
Complexity2/52/52/5
Audiencegeneralgeneraldeveloper

Figures from each repo's GitHub metadata at analysis time.

how do i run it?

Difficulty · easy time til it works · 30min
Use, modify, and share freely, including for commercial projects, as long as you keep the copyright notice.

in plain english

MODKEYS is a browser based tool for designing and visualizing a mechanical keyboard before you build it. It runs entirely in the browser on desktop and mobile, so there is nothing to install. You pick a layout, a compact 60 percent board, a 65 percent standard board, or a 75 percent board with a rotary knob, then choose keycap shapes, colors, case finish, plate material, switch type, and lighting style, and watch the changes appear on a 3D model you can orbit, pan, and zoom with a mouse, trackpad, or touch. The tool offers 19 ready made color themes plus full custom color options for individual keys, along with per key text, fonts, glow effects, uploaded images, and emoji marks. There are 16 case designs, 3 finishes, 8 plate materials, and 10 switch types to choose from, and lighting can be set to wave, static, breathe patterns, or turned off, with adjustable brightness and both underglow and per key glow. Once you have a design you like, you can undo or redo up to 50 steps of history, save it to a local gallery, or share it with others through a link that encodes your build. When you are ready to move from screen to reality, MODKEYS can export your design as KLE JSON, an SVG manufacturing template, a full spec sheet, or a PDF, giving you the files a keyboard builder or manufacturer would need. On mobile devices the site swaps in a separate interface built specifically for touch, with bottom tabs for each customization section and a dedicated export sheet, rather than simply shrinking the desktop layout. The project is built with Vite, vanilla JavaScript modules with no framework, Three.js for the 3D rendering, GSAP for animation, and the Web Audio API to generate switch click sounds procedurally rather than by playing recorded audio files. The project is released under the MIT license, so it can be freely used, modified, and shared, including for commercial purposes.

prompts (copy fr)

prompt 1
Show me how to add a new keycap profile to MODKEYS' keyboard configurator.
prompt 2
Help me extend MODKEYS to export a bill of materials alongside the spec sheet.
prompt 3
Write a new colorway preset for MODKEYS using a custom hex palette I provide.
prompt 4
Explain how MODKEYS' mobile shell switches at the breakpoint so I can add a new section tab.

Frequently asked questions

what is nur-modkeys fr?

A browser tool for designing and previewing custom mechanical keyboards in 3D, then exporting the design for building.

What language is nur-modkeys written in?

Mainly JavaScript. The stack also includes JavaScript, Vite, Three.js.

What license does nur-modkeys use?

Use, modify, and share freely, including for commercial projects, as long as you keep the copyright notice.

How hard is nur-modkeys to set up?

Setup difficulty is rated easy, with roughly 30min to a first successful run.

Who is nur-modkeys for?

Mainly general.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.