FUTO-Keyboard-Layout-Builder

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

FUTO-Keyboard-Layout-Builder

★ 12 Open GitHub ↗

A simple web based graphical interface to help create keyboard layout for FUTO Keyboard

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FUTO Keyboard Layout Builder

A simple web based graphical interface to help create keyboard layout for FUTO Keyboard

[Visit here](https://softorage.github.io/FUTO-Keyboard-Layout-Builder/)

## Table of Contents

- [Usage](#usage)
- [FAQ](#faq)
- [Credits](#credits)
- [Other tools](#other-tools)
- [What is Softorage?](#what-is-softorage)
- [License](#license)

## Usage

### Basic Information

* Layout Name: Name of the keyboard layout
* Language Code: Language code of the keyboard layout
* Description: Description of the keyboard layout

### Rows

* Numbers Row: Row for numbers (1-9, 0). Can be 1 at max.
* Letters Row: Rows for letters. Can be 8 at max.
* Bottom Row: Row for bottom keys (e.g. space, symbols, enter). Can be 1 at max.

### Keys

A key is a combination of base key, shifted key, and more keys.

* Base Key: Key that is visible to the user.
* Shifted Key: Key that is visible to the user when shift is pressed.
* More Keys:
  * Key(s) that is/are visible to the user when the key is long-pressed.
  * Comma separated.
  * More Keys can be specified for both Base Key (visible on long-press) and Shifted Key (visible on long-press while Shift is pressed).

> There can be at max 12 keys in each row.

### A few Notes

#### Template Keys

You can use below keys (called Template Keys) for various behaviours:
*  $shift - shift key
*  $delete - backspace key
*  $space - spacebar
*  $enter - enter/search/next/prev/go key
*  $symbols - switch to symbols menu
*  $alphabet - switch back to alphabet (only used in symbols layout)
*  $action - action key, user-defined, may be empty
*  $number - switch to numpad mode
*  $contextual - contextual key, / for URLs and date fields, @ for email fields, : for time fields
*  $zwnj - Zero-width non-joiner key, and zero-width joiner key in morekeys.
*  $optionalzwnj - same as $zwnj if useZWNJKey is true, else none
*  $gap - regular-width gap
*  $alt0 - switch to alt page 0, or back from alt page 0
*  $alt1 - switch to alt page 1, or back from alt page 1
*  $alt2 - switch to alt page 2, or back from alt page 2

#### Keyboard Behaviour

Some of the FUTO Keyboard's behaviour notes:
* A default number row and bottom row will be added by the keyboard if they are not explicitly defined.
* The keyboard automatically prepends $shift and appends $delete to the final Letter Row. This can be overridden by:
  * Specifying $shift and/or $delete somewhere OR
  * Specifying an explicit bottom row

#### LayoutSpec

For detailed instructions, follow the [ LayoutSpec documentation](https://github.com/futo-org/futo-keyboard-layouts/blob/main/LayoutSpec.md).

## FAQ

1. Do you know how to code? Do you use AI to develop this project? Is this vibe-coded?

Yes. I think, I may kinda know how to code. I am fairly confident that I understand the code I maintain (I keep forgetting though). Sometimes, there do appear parts of code (often via LLMs) that work and I don't quite understand how (and I have to ask to understand). But hey, that was the case even in StackOverflow days. I guess I'm dumb, just not enough to constantly keep messing the code. (-> Sanmay)  
   We may use AI when developing this project. If you find any issues, please report them to us. We will try to fix them as soon as possible.  
   No.
   
## Credits

- FUTO
- Softorage

## Other tools

- *Looking for a throttlestop alternative for your Intel CPU on Linux? Try our other tool: [undervolt-go](https://github.com/Softorage/undervolt-go). It comes with all the risks of a system level utility, though.*
- *Looking for a a simple 7-zip GUI on Linux that has all the advanced features that you are used to? Try our other tool: [7z-GUI-Linux](https://github.com/Softorage/7z-GUI-Linux).*

## What is Softorage?

Softorage is a software discovery platform that takes user trust and safety very seriously. It allows you to get the software on your computer, but with a distinction. Instead of hosting the packages (which involves risks of package manipulation, and is a well known malware vector), it simply links you to the official developer's website. This helps ensure that you get the software package as the original developers intended.

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Sanmay Joshi and Softorage are not affiliated with FUTO or FUTO Keyboard. This tool is designed solely for assistance purposes. No warranties or guarantees are provided regarding the accuracy or reliability of the tool or any information. Use at your own risk.

[Apache License, Version 2.0](/LICENSE.txt)

FUTO-Keyboard-Layout-Builder

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README