Giter VIP home page Giter VIP logo

keycolor-preview's Introduction

KeyColor - Keyboard & Keycap Color Preview

Keyboard information, layouts, styles are based on the data from the QMK Configurator with some of my modifications.

๐Ÿฅณ Why I'm here

This project popped up in my mind when I ordered Canoe Gen 2 and wanted to see what it looks like when combined with the keysets I have. So if you have the same concern, here it is for you. Hope this helps people who are in the mechanical keyboard community in order to build a favorite keyboard.

๐ŸŽ‰ Feature

  • 3D keycap viewer (except KAT profile)
  • Different font, text display per keycap profile
  • Support displaying characters of other languages
    • Hiragana (GMK Bento, Mecha-01, Sumi...)
    • Hangul (GMK Hanguk)
    • Cyrillics (GMK Yuri)
  • Multiple colorway selections for alphas, modifiers
  • Use SVG icons for novelties like Esc, Enter (SA Oblivion)

๐ŸŽจ TODO

  • Keyboard cases
  • Auto resize in small screens
  • 3D features
    • Artisan keycaps ๐Ÿ˜†
    • Keycap legend

๐Ÿ“ฌ Pull Request

You are welcome.

  • Add new keyboards:

    • Add new items at public/keyboards.json
    • Add new keyboard info at the public/keyboards folder following the data from QMK
    • Key code is required for layout, don't need any label here. Or you can use default layout (see keyboards/percent/canoe)
  • Add new default layouts:

    • Add new files into public/layouts
  • Add a new colorway:

    • Clone a new colorway from QMK or look at src/scss/colorways.scss and other files in the same folder

๐Ÿ“ Credits

keycolor-preview's People

Contributors

anhthang avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Forkers

ous50

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.