Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
4yn committed Feb 22, 2022
1 parent dd98fe5 commit d02990d
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 5 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
<img align="right" alt="logo" width="100" height="100" src="public/icon.png">

# 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.
<img alt="screenshot" src="res/screenshots/demo.png">

## 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)
Expand Down Expand Up @@ -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).

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

</details>

<details>
<summary><strong>slidershim 2.0 crashes right after I turn it on</strong></summary>

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).

</details>

<details>
<summary><strong>I am still having problems</strong></summary>

Expand All @@ -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

Expand All @@ -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
Expand Down
41 changes: 40 additions & 1 deletion res/layouts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<style>
body {
max-width: 650px;
max-width: 1200px;
margin: 40px auto;
padding: 0 10px;
font: 18px/1.5 -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto,
"Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji",
"Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
color: #444;

display: grid;
grid-template-columns: repeat(2, 1fr);
gap: 20px;
}
h1,
h2,
Expand Down Expand Up @@ -255,6 +259,41 @@
<div>[esc]</div>
</div>
</div>
<body>
<div class="layout">
<div class="name">Keyboard 16-zone, Tasoller (Bottom Half) Layout</div>
<div class="ground ground-16">
<div>A</div>
<div>Z</div>
<div>S</div>
<div>X</div>
<div>D</div>
<div>C</div>
<div>F</div>
<div>V</div>
<div>G</div>
<div>B</div>
<div>H</div>
<div>N</div>
<div>J</div>
<div>M</div>
<div>K</div>
<div>,</div>
</div>
<div class="air">
<div>]</div>
<div>[</div>
<div>;</div>
<div>.</div>
<div>'</div>
<div>/</div>
</div>
<div class="extra">
<div>[enter]</div>
<div>[space]</div>
<div>[esc]</div>
</div>
</div>
<div class="layout">
<div class="name">Keyboard 8-zone, Deemo Layout</div>
<div class="ground ground-8">
Expand Down
Binary file modified res/layouts/layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d02990d

Please sign in to comment.