mirror of
https://github.com/feschber/lan-mouse.git
synced 2026-04-09 01:11:28 +03:00
committed by
GitHub
parent
c50b746816
commit
d042c0aa4a
58
README.md
58
README.md
@@ -1,4 +1,7 @@
|
||||
# Lan Mouse Share
|
||||
|
||||

|
||||
|
||||
Goal of this project is to be an open-source replacement for proprietary tools like [Synergy](https://symless.com/synergy), [Share Mouse](https://www.sharemouse.com/de/).
|
||||
|
||||
Focus lies on performance and a clean, manageable implementation that can easily be expanded to support additional backends like e.g. Android, iOS, ... .
|
||||
@@ -7,6 +10,8 @@ Of course ***blazingly fast™*** and stable, because it's written in rust.
|
||||
|
||||
For an alternative (with slightly different goals) you may check out [Input Leap](https://github.com/input-leap).
|
||||
|
||||
_Now with a gtk frontend_
|
||||
|
||||
## Configuration
|
||||
Configuration is done through the file `config.toml`,
|
||||
which must be located in the current working directory when
|
||||
@@ -16,32 +21,43 @@ executing lan-mouse.
|
||||
A minimal config file could look like this:
|
||||
|
||||
```toml
|
||||
# example configuration
|
||||
|
||||
# optional port (defaults to 4242)
|
||||
port = 4242
|
||||
# # optional frontend -> defaults to gtk if available
|
||||
# # possible values are "cli" and "gtk"
|
||||
# frontend = "gtk"
|
||||
|
||||
# define a client on the right side with host name "iridium"
|
||||
[right]
|
||||
# hostname
|
||||
host_name = "iridium"
|
||||
# optional list of (known) ip addresses
|
||||
ips = ["192.168.178.156"]
|
||||
|
||||
# define a client on the left side with IP address 192.168.178.189
|
||||
[left]
|
||||
host_name = "my-laptop"
|
||||
# The hostname is optional: When no hostname is specified,
|
||||
# at least one ip address needs to be specified.
|
||||
host_name = "thorium"
|
||||
# ips for ethernet and wifi
|
||||
ips = ["192.168.178.189"]
|
||||
```
|
||||
|
||||
Where `left` can be either `left`, `right`, `top` or `bottom`.
|
||||
|
||||
> :warning: Note, that with the gtk frontend, the clients from the config
|
||||
> file are currently ignored.
|
||||
|
||||
### Additional options
|
||||
Additionally
|
||||
- a preferred backend
|
||||
- a port override for the default port (4242)
|
||||
|
||||
can be specified.
|
||||
|
||||
Supported backends currently include "wlroots", "x11" and "windows".
|
||||
|
||||
These two options can also be specified via the commandline
|
||||
options `--backend` and `--port` respectively.
|
||||
|
||||
## Build and Run
|
||||
Build only
|
||||
Build in release mode:
|
||||
```sh
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
Run
|
||||
Run directly:
|
||||
```sh
|
||||
cargo run --release
|
||||
```
|
||||
@@ -133,12 +149,8 @@ This is to be looked into in the future.
|
||||
(this works natively on sway versions >= 1.8)
|
||||
|
||||
## Windows support
|
||||
Currently windows can receive mouse and keyboard events, however unlike
|
||||
with the wlroots back-end,
|
||||
|
||||
the scancodes are not translated between keyboard layouts.
|
||||
|
||||
Event emitting is WIP.
|
||||
Currently windows can receive mouse and keyboard events,
|
||||
event producing on windows is WIP.
|
||||
|
||||
|
||||
## TODOS
|
||||
@@ -151,11 +163,11 @@ Event emitting is WIP.
|
||||
- [x] Button support
|
||||
- [ ] Latency measurement + logging
|
||||
- [ ] Bandwidth usage approximation + logging
|
||||
- [ ] Multiple IP addresses -> check which one is reachable
|
||||
- [x] Multiple IP addresses -> check which one is reachable
|
||||
- [x] Merge server and client -> Both client and server can send and receive events depending on what mouse is used where
|
||||
- [ ] Liveness tracking (automatically ungrab mouse when client unreachable)
|
||||
- [x] Liveness tracking (automatically ungrab mouse when client unreachable)
|
||||
- [ ] Clipboard support
|
||||
- [ ] Graphical frontend (gtk?)
|
||||
- [x] Graphical frontend (gtk?)
|
||||
- [ ] *Encrytion*
|
||||
- [ ] Gnome Shell Extension (layer shell is not supported)
|
||||
- [ ] respect xdg-config-home for config file location.
|
||||
|
||||
Reference in New Issue
Block a user