• ✨ Key Features
• 🛠️ Tech Stack
• 🚀 Getting Started
  • Prerequisites
  • Installation
• 💻 Usage
• ⚙️ Development
  • Available Scripts
  • Project Structure
• 📦 Building for Production
• 🤝 Contributing
• 📜 License
• 🙏 Acknowledgments
• 📞 Contact

Zellia Control offers a rich set of features to unlock the full potential of your Hall Effect keyboard:

• ⚡ Performance Tuning:
  • Adjustable Actuation Points: Fine-tune key actuation from 0.1mm to 4.0mm.
  • Rapid Trigger: Dynamic actuation and deactuation for ultra-responsive gameplay.
  • Continuous Rapid Trigger: Enhanced rapid trigger mode for maximum speed.
  • Real-time Pressure Monitoring: Visualize key press depth and pressure.
• ⌨️ Advanced Key Remapping:
  • Intuitive Interface: Easily remap any key on the visual keyboard.
  • Multiple Key Categories: Basic, Function, Media, Mouse, System, and Special HE keys.
  • 4 Configurable Layers: Create distinct profiles for different applications or games.
• 💡 RGB Lighting Control:
  • Multiple Effects: Choose from a variety of dynamic lighting patterns.
  • Color Customization: Per-key or zone-based color settings.
  • Brightness & Speed Control: Adjust lighting intensity and effect speed.
• 🔧 Hardware & System Tools:
  • Hardware Calibration: Calibrate switches for optimal performance.
  • Debug Mode: Access real-time key tracking and diagnostic tools.
  • Profile Management: Import and export keyboard configurations.
  • Settings Page: Configure application preferences and device settings.
• 🌐 Cross-Platform:
  • Native support for Windows, macOS, and Linux.
• 🎨 Modern UI/UX:
  • Dark/Light Mode: Automatic theme switching based on system preference.
  • Customizable Theme Colors: Personalize the app's appearance.
  • Responsive Design: Adapts to various screen sizes.

Zellia Control is built with a modern and robust technology stack:

• Tauri: Backend framework for building lightweight, secure, and cross-platform desktop applications with Rust.
• SvelteKit: Frontend framework for building fast and efficient web applications.
• TypeScript: Superset of JavaScript adding static typing for improved code quality and maintainability.
• Rust: High-performance systems programming language used for the Tauri backend.
• Tailwind CSS: Utility-first CSS framework for rapid UI development.
• Vite: Next-generation frontend tooling for fast development and optimized builds.

Follow these steps to get Zellia Control up and running on your local machine.

Ensure you have the following installed:

• Node.js (v18.x or higher recommended)
• Yarn (v1.x) or npm (v8.x or higher)
• Rust (latest stable version)
• System dependencies for Tauri (see Tauri prerequisites)

1. Clone the repository:

   git clone https://github.com/Zellia-Keyboards/Zellia-Control.git
   cd Zellia-Control

2. Install frontend dependencies:

   yarn install
   # or
   # npm install

3. Run in development mode:

   This command will start the SvelteKit frontend and the Tauri backend with hot-reloading.

   yarn tauri dev
   # or
   # npm run tauri dev

   The application will typically open automatically. If not, look for the development server URL in your terminal.

Once the application is running:

1. Connect your Zellia Hall Effect Keyboard. The application should automatically detect it.
2. Navigate through the sections using the sidebar:
   • Performance: Adjust actuation points, rapid trigger settings.
   • Remap: Customize key assignments across different layers.
   • Lighting: Control RGB effects and colors.
   • Calibration: Perform hardware calibration for your switches.
   • Debug: View real-time key data and logs.
   • Settings: Manage application preferences and keyboard profiles.
   • About: View application information and acknowledgments.
3. Changes are applied in real-time to your connected keyboard where applicable.
4. Use the Profile Management features in Settings to save and load your configurations.

In the package.json, you'll find several scripts for development:

• yarn dev: Starts the SvelteKit development server (frontend only).
• yarn build: Builds the SvelteKit frontend for production.
• yarn preview: Previews the production SvelteKit build locally.
• yarn check: Runs Svelte type checking.
• yarn check:watch: Runs Svelte type checking in watch mode.
• yarn tauri dev: Starts the full application (frontend + Tauri backend) in development mode.
• yarn tauri build: Builds the full application for production (creates installers/binaries).

zellia-control/
├── .github/                # GitHub Actions and issue templates
├── build/                  # Output directory for SvelteKit static build
├── public/                 # Renamed to static/ in your project
│   └── static/             # Static assets (favicon, logos)
├── src/                    # SvelteKit frontend source code
│   ├── app.css             # Global CSS styles
│   ├── app.html            # Main HTML shell
│   ├── lib/                # Shared Svelte components, stores, and utilities
│   │   ├── AdvancedKeyShared.ts
│   │   ├── DarkModeStore.svelte.ts
│   │   ├── KeyboardState.svelte.ts
│   │   └── Zellia80HE.svelte   # Interactive keyboard component
│   └── routes/             # SvelteKit page routes and layouts
│       ├── +layout.svelte    # Main application layout
│       ├── +page.svelte      # Home/Dashboard page
│       ├── about/
│       ├── advancedkey/
│       ├── calibration/
│       ├── debug/
│       ├── lighting/
│       ├── performance/
│       ├── remap/
│       └── settings/
├── src-tauri/              # Tauri (Rust) backend source code
│   ├── build.rs
│   ├── Cargo.toml          # Rust dependencies and project metadata
│   ├── capabilities/       # Tauri security capabilities
│   ├── icons/              # Application icons for different platforms
│   ├── src/                # Rust source files
│   │   ├── lib.rs
│   │   └── main.rs         # Main Rust application entry point
│   └── tauri.conf.json     # Tauri application configuration
├── jsconfig.json           # JavaScript/TypeScript configuration
├── package.json            # Node.js project metadata and dependencies
├── postcss.config.js       # PostCSS configuration
├── README.md               # This file
├── svelte.config.js        # SvelteKit configuration
├── tailwind.config.js      # Tailwind CSS configuration
└── vite.config.js          # Vite configuration

To build the application for production, which will generate native installers or executables for your platform:

yarn tauri build

npm run tauri build

Build artifacts will be located in src-tauri/target/release/bundle/. The specific subdirectory and file type will depend on your operating system (e.g., .msi for Windows, .dmg or .app for macOS, .deb or .AppImage for Linux).

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please ensure your code adheres to the existing style and that all tests pass.

Distributed under the MIT License. See LICENSE file for more information. (Note: You'll need to create a LICENSE file in your repository, typically containing the MIT License text if that's your chosen license.)

• The Tauri Team for creating an amazing framework.
• The Svelte Team for Svelte and SvelteKit.
• All contributors and users of this project.