Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-3b82f6?style=flat-square)](LICENSE)
[![Weights: CC BY-NC 4.0](https://img.shields.io/badge/weights-CC%20BY--NC%204.0-7c3aed?style=flat-square)](models/WEIGHTS_LICENSE.md)
[![Releases](https://img.shields.io/badge/releases-page-444?style=flat-square)](https://github.com/getflyhigh/flyhigh-engine/releases)
[![Built on FlyHigh](https://img.shields.io/badge/built%20on-FlyHigh-19c37d?style=flat-square)](https://github.com/topics/flyhigh-engine)
[![Uses FlyHigh](https://img.shields.io/badge/uses-FlyHigh-19c37d?style=flat-square)](docs/projects.md)
[![Ko-fi](https://img.shields.io/badge/support-ko--fi-ff5e5b?style=flat-square)](https://ko-fi.com/monzikxd)
[![Compute by CloudRift](assets/cloudrift.svg)](https://cloudrift.ai)

Expand Down Expand Up @@ -200,16 +200,15 @@ Tests, CLI tools, developer settings: [development](docs/development.md). How th
Status: 0.x. The Rust API follows [ARCHITECTURE.md](ARCHITECTURE.md) and may still change; the C ABI and the
JavaScript classes change additively. What changed is in the [changelog](CHANGELOG.md).

## Built on FlyHigh

Projects that run on the engine carry the GitHub topic
[`flyhigh-engine`](https://github.com/topics/flyhigh-engine); add it to yours to be listed there.
## Projects using FlyHigh

- **[Framegen](https://github.com/MONZikWasTaken/Framegen)**: a browser extension that generates frames for any
`<video>` on a page (Chrome, Firefox); the first host written on the engine's classes alone.
- **[OpenNOW](https://github.com/OpenCloudGaming/OpenNOW)**: an open-source cloud gaming client whose frame
generation runs on the engine: in-betweens for the game stream in the native client.

[See all projects](docs/projects.md)

## Weights

The weights ship in this repository: `models/flyhighfg.bin` (little-endian f16, 62 tensors, 776 k parameters) with
Expand Down
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ Start with the guide for your platform, then [options.md](options.md) when you w
| [model-format.md](model-format.md) | the model files (`graph.json`, manifest, weight blob) and how to ship another checkpoint |
| [development.md](development.md) | building, the CLI tools, tests and parity fixtures, developer environment variables |
| [decisions.md](decisions.md) | the decision records: what was decided, when and why |
| [projects.md](projects.md) | the apps that use the engine, and how to add yours |
| [CONTRIBUTING.md](../CONTRIBUTING.md), [SECURITY.md](../SECURITY.md), [CHANGELOG.md](../CHANGELOG.md) | how to build, check and contribute; how to report a vulnerability; what changed |
17 changes: 17 additions & 0 deletions docs/projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Projects using FlyHigh

Apps that use the engine for some or all of their frame generation. To be listed, open an issue or a pull request
that adds a line here; the GitHub topic [`flyhigh-engine`](https://github.com/topics/flyhigh-engine) on your
repository lists it there as well.

| Project | What it is | What the engine does there |
|---|---|---|
| [Framegen](https://github.com/MONZikWasTaken/Framegen) | browser extension (Chrome, Firefox) | generates frames for any `<video>` on a page; the first host written on the engine's classes alone |
| [OpenNOW](https://github.com/OpenCloudGaming/OpenNOW) | open-source cloud gaming client | frame generation for the game stream in the native client |
| [yoru](https://github.com/Tons-7/yoru) | self-hosted anime streaming app | optional frame generation in its browser player |

A badge, if you want one:

```markdown
[![Uses FlyHigh](https://img.shields.io/badge/uses-FlyHigh-19c37d?style=flat-square)](https://github.com/getflyhigh/flyhigh-engine)
```
Loading