Giter VIP home page Giter VIP logo

nudelta's Introduction

ν∂ / Nudelta

License: GPLv3 CI Status

Note: This software is in beta. Nudelta is an unofficial product and is not affiliated with NuPhy Studio.

Screenshot of Nudelta Console

An open-source alternative to the NuPhy Console created by reverse-engineering the keyboards' USB protocol.

What this has:

  • Support for NuPhy Air75 on Windows 10+, macOS 11+, and Linux
    • ALPHA support for the NuPhy Halo75
  • Loading and saving keymap modifications from a .yml configuration file
  • The ability to back up and dump keymaps to binary formats (CLI)
  • The ability to dump keymaps to a human-readable hex format (CLI)

What this DOESN'T have:

  • Macros
    • Need to reverse engineer those.
  • Support for Air60, Halo65, etc.
    • I don't have them.
  • RGB Control
    • I don't need that, personally.

Contributions are super appreciated for all of these.

Running Requirements

  • An x86, x86_64 or Apple Silicon processor (w/ Rosetta)

Build Requirements

  • C++17 Compiler
  • Cmake
  • Node 14+ with Yarn

Build (GUI)

git clone https://github.com/donn/nudelta
cd nudelta
git submodule update --init --recursive
rm -rf build
yarn
yarn build

The Linux AppImage will be found under ./dist, and the Mac app will be found under ./dist/mac.

Build (CLI)

git clone https://github.com/donn/nudelta
cd nudelta
git submodule update --init --recursive
mkdir build
cd build
cmake ..
make -j$(nproc)
sudo make install

Using the CLI

You will need to use sudo on Linux. On macOS, you will need to grant Input Monitoring permissions to whichever Terminal host you're using to run Nudelta, likely Terminal.app.

No special permissions are required on Windows as far as I can tell.

Load a custom profile

nudelta -l ./donns_remap.yml

The configuration .yml file is simple: there's a top level object called "keys": which is a map of physical keys on the actual keyboard to their replacements:

keys:
    capslock: esc

See example.yml for a profile and somewhat more detailed examples.

You can find a list of:

Reset keymap to default

nudelta -r

License

The GNU General Public License v3 or, at your option, any later version. Check 'License'.

NuPhy® is a registered trademark of NuPhy Studio.

nudelta's People

Contributors

donn avatar everettperiman avatar

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.