From d02990d5fc3b52777d4fcf799a5c1b9e5556c0ba Mon Sep 17 00:00:00 2001 From: 4yn Date: Tue, 22 Feb 2022 23:26:18 +0800 Subject: [PATCH] update readme --- README.md | 26 ++++++++++++++++++++++---- res/layouts/index.html | 41 ++++++++++++++++++++++++++++++++++++++++- res/layouts/layout.png | Bin 58372 -> 74613 bytes 3 files changed, 62 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ba5603f..8e4bb47 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,23 @@ logo -# slidershim +# [slidershim](https://github.com/4yn/slidershim) Software adapter for various Chunithm slider controllers with a built-in Brokenithm web controller. Has support for keyboard/gamepad output and LED lighting. [Download link](https://github.com/4yn/slidershim/releases/latest) +> Starting 0.2.0, there are reports that windows defender may block this software. You may need to disable windows defender the first time you run slidershim. If you are not comfortable with this, you can [download an older version here](https://github.com/4yn/slidershim/releases/tag/v0.1.4) that is known to be OK with windows defender. + screenshot +## Changelog + +- v0.2.0 + - Added support for Hori Project DIVA slider protocol + - Added 16 key keyboard layout +- v0.1.4 + - Initial public release + ## Setup Instructions 1. [Download here](https://github.com/4yn/slidershim/releases/latest) @@ -50,6 +60,7 @@ Voltex layout disables air tower, Neardayo layout enables air tower. - slidershim supports the GAMO2 Tasoller and Yuancon Laverita v2 controllers on HID firmware. - If you are using a Tasoller controller, make sure it has the correct HID firmware installed. - If your hardware controller is not one of these, it will not work. +- If you have a device that communicates using serial protocol, chances are it will work with the "Diva Slider over Serial" option - Hotplug is not supported. If you plugged in the controller after starting slidershim, re-connect your controller by just clicking the "Apply" button (even if it is grey). @@ -80,6 +91,13 @@ Voltex layout disables air tower, Neardayo layout enables air tower. +
+slidershim 2.0 crashes right after I turn it on + +I'm not sure why this happens. I suspect some cases are because of windows defender and other antivirus software stopping the process while running. Try disabling antivirus or using an [older version of slidershim](https://github.com/4yn/slidershim/releases/tag/v0.1.4). + +
+
I am still having problems @@ -97,8 +115,8 @@ Voltex layout disables air tower, Neardayo layout enables air tower. ## Technical Information -- Built with Rust, [tauri](https://github.com/tauri-apps/tauri) + [Svelte](https://github.com/sveltejs/svelte), [rusb](https://github.com/a1ien/rusb), [vigem](https://github.com/ViGEm/ViGEmClient)[-client](https://github.com/CasualX/vigem-client), [hyper](https://github.com/hyperium/hyper/), [tokio-](https://github.com/snapview/tokio-tungstenite)[tungstenite](https://github.com/snapview/tungstenite-rs) and [serialport](https://crates.io/crates/serialport) -- USB device polling is done on a dedicated thread while everything else is done on a async runtime. +- Built with Rust, [tauri](https://github.com/tauri-apps/tauri) + [Svelte](https://github.com/sveltejs/svelte), [rusb](https://github.com/a1ien/rusb), [vigem](https://github.com/ViGEm/ViGEmClient)[-client](https://github.com/CasualX/vigem-client), [hyper](https://github.com/hyperium/hyper/), [tokio-](https://github.com/snapview/tokio-tungstenite)[tungstenite](https://github.com/snapview/tungstenite-rs), [serialport](https://crates.io/crates/serialport), [dtolnay/cxx](https://github.com/dtolnay/cxx) and [wjwwood/serial](https://github.com/wjwwood/serial) +- USB device and serial polling is done on a dedicated thread while everything else is done on a async runtime. ### Repository Layout @@ -110,7 +128,7 @@ Voltex layout disables air tower, Neardayo layout enables air tower. ## Planned Features - Major: - - Support AC slider serial protocol + - ✅ DONE: Support AC slider serial protocol - Output and LED websocket adapters when UMIGURI comes out - QOL: - Documentation diff --git a/res/layouts/index.html b/res/layouts/index.html index 99883c5..6c15bc9 100644 --- a/res/layouts/index.html +++ b/res/layouts/index.html @@ -6,13 +6,17 @@