# Quicktap Engine
Quicktap is a (hopefully) standard-compliant Rust implementation of the [WireGuard protocol](https://wireguard.org).

It was designed to be a simpler alternative to Cloudflare's [boringtun](https://github.com/cloudflare/boringtun).

## Getting Started: Normal People

> Warning: Quicktap's CLI (and quicktap as a whole) is in a very unfinished state right now. Use something else for a little bit.

See the sections below for your platform for a guide on how to use Quicktap.

### Linux
> Dont! Linux has had [in-kernel WireGuard support since 5.6](https://lists.zx2c4.com/pipermail/wireguard/2020-March/005206.html) and you probably have it. If you don't, use `wireguard-linux-compat`. There is no reason to use quicktap on Linux. The kernel module is better and faster.

After you've ignored the previous sentences and want to do it anyway:

First, compile quicktap. You only need to do this once per release.

1. Download the latest release from https://gitlab.e3t.cc/e3team/elaeis4/-/releases.
2. Make sure you have Rust installed. Check out https://rustup.rs if you don't.
3. Run `cargo build --release` in the project directory.

After compilation, use `target/release/quicktap-cli <name-of-your-interface>` to create your interface. Then you can configure it as usual with `ip` and `wg` commands.

### MacOS
Not yet...

### NetBSD
Not yet...

## Getting Started: Application Developers

It's just a typical Rust library. It's up on crates.io as `quicktap` for stable releases.
We aim to have pretty good documentation, so check out the crate documentation for more info on how to use it.

## Getting Started: Quicktap Developers

It's just a typical Rust library. Try to follow our [contributor guidelines](../CONTRIBUTING.md). Thanks!