Dygma Layouts

Dygma keyboards are cool - but where should the keys go? This repository is a collection of user-submitted layouts for both the Dygma Raise and Dygma Defy keyboards.

All layouts are provided free of charge with license for you to use, modify, redistribute, or otherwise do whatever you want with.

Community Guidelines

When creating issues, submitting pull requests, adding files to the repository, or interacting with this repository in any way, all users are expected to follow the same community rules as in the official Dygma Discord server.

If you are unfamiliar with these rules, you are expected to join the Discord server and understand the rules before interacting with this repository.

Using a Layout

1. Go to the defy.json or raise.json file of the layout you wish to use and select the 'download' button.
2. Once the file has downloaded, launch Bazecor and select 'configure' on your keyboard.
3. Go to 'preferences' in the right sidebar, and to 'backups' under the 'global settings' section.
4. Select 'restore backup from file...' and select the downloaded file.

Adding a Layout

Dygma has alluded to plans for creating an official layout repository sometime in the future; however, there isn't anything available currently.

If you want to add your layout to this repository, follow the steps below. These instructions are intended to be as friendly as possible to users who are new to GitHub. You can view examples of other layouts in the 'layouts' folder.

1. Create a GitHub account - you'll need this to submit your additions.
2. Fork this repository - you can do this by clicking the "Fork" button in the top right of this page.
3. Fill in the template - this will add your layout to your fork.

   When creating or adding files via GitHub, you can create a folder by typing folder-name/ into the name of a file. Please do not use spaces in folder names, instead use hyphens to separate words.

   1. Create a folder in 'layouts' with your GitHub username, and another folder inside it with the name of your layout.
   2. Add a file named README.md. In this file, copy and fill out the contents of the template.
   3. Add a file named defy.json or raise.json depending on the keyboard model your layout is for. In this file, paste the contents of your latest backup from Bazecor.

      To provide specific changes to a layout for use on a particular OS, add another JSON file, e.g. defy-macos.json, raise-windows.json etc.

4. Submit a pull request (PR) - this request will submit your layout to this repository.
   • Go to the "Pull Requests" tab in this repository and click "New Pull Request".
   • Select 'compare across forks' in the text at the top.
   • Ensure the 'base repository' is this one (willsterjohnson/dygma-layouts), and the 'head repository' is your fork (your-user-name/dygma-layouts).
   • Select 'create pull request' and fill in the template.
   • Ensure you allow maintainers to edit your PR - this is especially useful for GitHub novices as modifying a PR can be difficult for new users.
   • Submit your PR.

Advanced users may use the provided update script to automate the process of updating their layout.

If you experience any difficulty adding your layout, contact one of the maintainers of this repository on Discord.

Maintainers:

• Willster Johnson (Discord: WillsterJohnson)