asdf-overlay-window 2.0.4

Asdf Overlay window handling and input library
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

[![Npm][npm-badge]][npm-url]
[![Crates.io][crates-badge]][crates-url]
[![Documentation][docs-badge]][docs-url]

[npm-badge]: https://img.shields.io/npm/v/@asdf-overlay/core.svg
[npm-url]: https://www.npmjs.com/package/@asdf-overlay/core
[crates-badge]: https://img.shields.io/crates/v/asdf-overlay.svg
[crates-url]: https://crates.io/crates/asdf-overlay
[docs-badge]: https://docs.rs/asdf-overlay/badge.svg     
[docs-url]: https://docs.rs/asdf-overlay

# Asdf Overlay

Blazingly fast™ In-Game Overlay library for Windows.

[Documentation](https://storycraft.github.io/asdf-overlay/)

## Features

* Zero copy overlay rendering.
* Window input capturing and blocking control.
* Multi window, multi surface support.
* Renderer detection, multi-API support (DirectX 9, DirectX 11, DirectX 12, OpenGL, Vulkan)
* Code signed overlay DLL.

## Used by

[lyrs-url]: https://github.com/organization/lyrs
[tosu-url]: https://github.com/tosuapp/tosu

| Logo | Project
| :-----: | ----- |
| [![Lyrs logo](.github/images/lyrs-logo.png)][lyrs-url] | [Lyrs][lyrs-url] |
| [![Tosu logo](.github/images/tosu-logo.png)][tosu-url] | [Tosu][tosu-url] |

## Sponsorship

[sign-path-io-url]: https://signpath.io/
[sign-path-foundation-url]: https://signpath.org/

| Logo | Description |
| :-----: | ----- |
| [![SignPath logo](.github/images/signpath-logo.png)][sign-path-io-url] | Free code signing provided by [SignPath.io][sign-path-io-url], certificate by [SignPath Foundation][sign-path-foundation-url] |

## Example

Examples are located in `examples` directory.

### Node

Run
```bash
pnpm build && pnpm --filter ingame-browser start <process_name>
```
Pressing `Left Shift + A` will show ingame browser overlay and input will be redirected to browser window. Pressing again will close it.

![Ingame Browser Preview](.github/images/examples/ingame-browser.png)

### Rust

1. Run
```bash
pnpm build && cargo run -p noise-rectangle <pid>
```
Glitching squares appear and disappear on target process.

![Noise Rectangle Preview](.github/images/examples/noise-rectangle.png)

1. Run
```bash
pnpm build && cargo run -p input-capture <pid>
```
It will listen all inputs of the target process and block them until the process exit.

## License

This project is dual licensed under MIT or Apache-2.0 License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fstorycraft%2Fasdf-overlay.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fstorycraft%2Fasdf-overlay?ref=badge_large&issueType=license)