Skip to content

Commit d02990d

Browse files
committed
update readme
1 parent dd98fe5 commit d02990d

File tree

3 files changed

+62
-5
lines changed

3 files changed

+62
-5
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
<img align="right" alt="logo" width="100" height="100" src="public/icon.png">
22

3-
# slidershim
3+
# [slidershim](https://github.com/4yn/slidershim)
44

55
Software adapter for various Chunithm slider controllers with a built-in Brokenithm web controller. Has support for keyboard/gamepad output and LED lighting.
66

77
[Download link](https://github.com/4yn/slidershim/releases/latest)
88

9+
> 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.
10+
911
<img alt="screenshot" src="res/screenshots/demo.png">
1012

13+
## Changelog
14+
15+
- v0.2.0
16+
- Added support for Hori Project DIVA slider protocol
17+
- Added 16 key keyboard layout
18+
- v0.1.4
19+
- Initial public release
20+
1121
## Setup Instructions
1222

1323
1. [Download here](https://github.com/4yn/slidershim/releases/latest)
@@ -50,6 +60,7 @@ Voltex layout disables air tower, Neardayo layout enables air tower.
5060
- slidershim supports the GAMO2 Tasoller and Yuancon Laverita v2 controllers on HID firmware.
5161
- If you are using a Tasoller controller, make sure it has the correct HID firmware installed.
5262
- If your hardware controller is not one of these, it will not work.
63+
- If you have a device that communicates using serial protocol, chances are it will work with the "Diva Slider over Serial" option
5364
- 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).
5465

5566
</details>
@@ -80,6 +91,13 @@ Voltex layout disables air tower, Neardayo layout enables air tower.
8091

8192
</details>
8293

94+
<details>
95+
<summary><strong>slidershim 2.0 crashes right after I turn it on</strong></summary>
96+
97+
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).
98+
99+
</details>
100+
83101
<details>
84102
<summary><strong>I am still having problems</strong></summary>
85103

@@ -97,8 +115,8 @@ Voltex layout disables air tower, Neardayo layout enables air tower.
97115

98116
## Technical Information
99117

100-
- 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)
101-
- USB device polling is done on a dedicated thread while everything else is done on a async runtime.
118+
- 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)
119+
- USB device and serial polling is done on a dedicated thread while everything else is done on a async runtime.
102120

103121
### Repository Layout
104122

@@ -110,7 +128,7 @@ Voltex layout disables air tower, Neardayo layout enables air tower.
110128
## Planned Features
111129

112130
- Major:
113-
- Support AC slider serial protocol
131+
- ✅ DONE: Support AC slider serial protocol
114132
- Output and LED websocket adapters when UMIGURI comes out
115133
- QOL:
116134
- Documentation

res/layouts/index.html

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
77
<style>
88
body {
9-
max-width: 650px;
9+
max-width: 1200px;
1010
margin: 40px auto;
1111
padding: 0 10px;
1212
font: 18px/1.5 -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
1313
"Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji",
1414
"Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
1515
color: #444;
16+
17+
display: grid;
18+
grid-template-columns: repeat(2, 1fr);
19+
gap: 20px;
1620
}
1721
h1,
1822
h2,
@@ -255,6 +259,41 @@
255259
<div>[esc]</div>
256260
</div>
257261
</div>
262+
<body>
263+
<div class="layout">
264+
<div class="name">Keyboard 16-zone, Tasoller (Bottom Half) Layout</div>
265+
<div class="ground ground-16">
266+
<div>A</div>
267+
<div>Z</div>
268+
<div>S</div>
269+
<div>X</div>
270+
<div>D</div>
271+
<div>C</div>
272+
<div>F</div>
273+
<div>V</div>
274+
<div>G</div>
275+
<div>B</div>
276+
<div>H</div>
277+
<div>N</div>
278+
<div>J</div>
279+
<div>M</div>
280+
<div>K</div>
281+
<div>,</div>
282+
</div>
283+
<div class="air">
284+
<div>]</div>
285+
<div>[</div>
286+
<div>;</div>
287+
<div>.</div>
288+
<div>'</div>
289+
<div>/</div>
290+
</div>
291+
<div class="extra">
292+
<div>[enter]</div>
293+
<div>[space]</div>
294+
<div>[esc]</div>
295+
</div>
296+
</div>
258297
<div class="layout">
259298
<div class="name">Keyboard 8-zone, Deemo Layout</div>
260299
<div class="ground ground-8">

res/layouts/layout.png

15.9 KB
Loading

0 commit comments

Comments
 (0)