oink README

The project's README from github.com/oinkvm/oink. As one markdown file: README.md.

Oink — Oink Is Not only a KVM. Your computers, working as one.

Oink — Oink Is Not only a KVM

English | 简体中文 | 日本語 | 한국어

Oink, short for "Oink Is Not only a KVM", is modern software that builds a peer-to-peer sharing network across multiple Windows and Mac computers. Use the keyboard, mouse and trackpad of any device to control any nearby device, with the same native feel everywhere; play the audio of several devices through the speakers or headphones connected to one of them; share the clipboard and drag and drop between devices; discover devices on the local network automatically; all traffic is encrypted by default.

Install

Get installers and matching source from GitHub Releases.

Supported operating systems and versions:

If SmartScreen says "Windows protected your PC", use More info → Run anyway only if offered. UAC may show an unknown publisher.

Sponsor

If this project helps you, consider sponsoring some of my AI subscription costs. Those tokens help make Oink better.

Ko-fi

Contributing

This project does not accept pull requests without context, because there is no one to review the code. Please use Issues for all bug reports and feature requests. When you report a problem, please include your device environment, diagnostic data, steps to reproduce and your AI-assisted investigation's conclusions. Using Oink in real environments and sending feedback is the biggest contribution to this project.

FAQ

Is Oink based on, or compatible with, Deskflow?
No. Oink is a project started completely from scratch. It uses its own peer-to-peer (not client–server) protocol and is not compatible with other software KVMs.

Do I have to designate one device as the controller?
No. Oink uses a peer-to-peer design: the keyboard and mouse connected to any device can control the other devices.

Can I share trackpad gestures?
Yes, but trackpads on Windows have not been tested.

Does it support clipboard sharing and drag and drop across operating systems?
Yes. The clipboard is synced across devices automatically, and you can drag text, images and files directly from one device to another — even straight into apps such as Chrome.

Do I need to buy a license for personal or commercial use?
No. Oink is free software released under GPL-3.0-only with additional terms, so you can use it for any personal or commercial purpose without asking for any further license. If you distribute Oink or a modified version of it, you must provide the complete source code under the same license, keep the original author attribution and license notices, and mark your changes; under the additional terms you also may not use the Oink name to promote derived products. Modifying Oink only for your own use, without distributing it, carries none of these obligations.

License

This project is licensed under GPL-3.0-only with additional terms.

oink (oinkvm/oink)

Searching Database…

2K ·GitHub
What is this?Oink is software that shares one keyboard, mouse, trackpad, clipboard, drag and drop and audio across several Macs and Windows PCs, with no fixed controller machine.
Is it just a KVM, or something more?It is a software KVM (the name stands for 'Oink Is Not only a KVM'), and it also shares audio, clipboard and drag and drop. Devices find each other on the local network by themselves.
How do I get it running?Download the installer for your system from GitHub Releases and install it on each computer. Devices on the same local network then find each other.
Do I need anything before installing?Macs need Apple silicon on macOS 14.2 or later. Windows needs x64 with Windows 10 1809 or later, or Windows 11. On Windows 10 LTSC you must first install the Microsoft Edge WebView2 Runtime (Evergreen).
Any install or usage pitfalls?Windows may show a SmartScreen warning, and UAC can show an unknown publisher. Intel Macs, Windows 10 before 22H2 and Windows trackpads are untested.
Does it work on Linux, iOS or Android?The README only lists macOS and Windows, so Linux, iOS and Android are not mentioned.
Is my traffic safe on the network?Yes, all traffic is encrypted by default, and devices connect peer-to-peer rather than through a central server.
Is it free, and can I use it at work?Yes. It is free under GPL-3.0-only with additional terms, so no license is needed for personal or commercial use. If you distribute a modified version, you must share its full source and cannot use the Oink name to promote it.
Is it based on Deskflow or Barrier?No. Oink was written from scratch with its own peer-to-peer protocol, so it is not compatible with other software KVMs.
Do I have to pick one machine as the controller?No. The keyboard and mouse of any connected device can control the others.
Can I drag files between a Mac and a PC?Yes. You can drag text, images and files straight from one device to another, even into apps like Chrome, and the clipboard syncs automatically.
Can one machine play audio from the others?Yes. You can play the audio of several devices through the speakers or headphones connected to one of them.
Creator
oinkvm
Size
14.5 MB
Stars
2K
Age
30d
Commits · 90 Days