{"id":20390335,"url":"https://github.com/timvisee/pixelpwnr","last_synced_at":"2025-08-11T17:44:24.535Z","repository":{"id":27974423,"uuid":"115726219","full_name":"timvisee/pixelpwnr","owner":"timvisee","description":":fireworks: Insanely fast pixelflut client for images and animations written in Rust.","archived":false,"fork":false,"pushed_at":"2024-12-30T00:42:13.000Z","size":200,"stargazers_count":74,"open_issues_count":4,"forks_count":11,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-28T17:11:13.277Z","etag":null,"topics":["37c3","animated-images","flood","hacktoberfest","pixelflut","pixelpwnr","rust"],"latest_commit_sha":null,"homepage":"https://timvisee.com/projects/pixelpwnr","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/timvisee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["timvisee"],"custom":["https://timvisee.com/donate"],"patreon":"timvisee","ko_fi":"timvisee"}},"created_at":"2017-12-29T13:53:02.000Z","updated_at":"2025-01-18T00:05:40.000Z","dependencies_parsed_at":"2024-01-13T00:39:36.486Z","dependency_job_id":"bf2e62f3-d91d-483d-8606-d4c1468bda09","html_url":"https://github.com/timvisee/pixelpwnr","commit_stats":{"total_commits":119,"total_committers":7,"mean_commits":17.0,"dds":0.2941176470588235,"last_synced_commit":"38ce0f0c43b5072e35c19048dbe12301614f25ca"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fpixelpwnr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fpixelpwnr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fpixelpwnr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvisee%2Fpixelpwnr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvisee","download_url":"https://codeload.github.com/timvisee/pixelpwnr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226215,"owners_count":20904465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["37c3","animated-images","flood","hacktoberfest","pixelflut","pixelpwnr","rust"],"created_at":"2024-11-15T03:24:20.526Z","updated_at":"2025-04-04T18:09:08.365Z","avatar_url":"https://github.com/timvisee.png","language":"Rust","funding_links":["https://github.com/sponsors/timvisee","https://timvisee.com/donate","https://patreon.com/timvisee","https://ko-fi.com/timvisee"],"categories":[],"sub_categories":[],"readme":"# pixelpwnr\n\nA quick [pixelflut][pixelflut] ([video][pixelflut-video]) client in\n[Rust][rust] for use at [34C3][34C3], that _pwns_ whole pixelflut panels.\n\nFor a high performance pixelflut client and server implementations, see:\n- [pixelpwnr-server][pixelpwnr-server]: server\n- [pixelpwnr-cast][pixelpwnr-cast]: cast your screen to a pixelflut server\n\n## Features\n\n* Many concurrent drawing pipes, fast multithreading\n* Animated images, with GIFs, webp's or multiple frame images\n* Control over render sizes and offset\n* Automatic image sizing and formatting\n* Blazingly fast [binary protocol](https://github.com/timvisee/pixelpwnr-server#the-binary-px-command) (`PB` with `--binary`)\n* Faster than most other clients :-)\n* Linux, Windows and macOS\n\n## Usage\n\nPixelflut a simple image:\n```bash\n# Flut a simple image.\n# - To host 127.0.0.1 on port 8080\n# - With the image: image.png\n# - With 4 painting threads\n# - With the size of the screen (default)\npixelpwnr 127.0.0.1:8080 -i image.png -c 4\n\n# Other CLI syntax is also supported\npixelpwnr \"127.0.0.1:8080\" --image=\"image.png\" -c=4\n```\n\nPixelflut an animated image:\n```bash\n# Flut an animated image, with multiple frames.\n# - To host 127.0.0.1 on port 8080\n# - With the images: *.png\n# - With 5 frames per second\n# - With 4 painting threads\n# - With a size of (400, 400)\n# - With an offset of (100, 100)\npixelpwnr 127.0.0.1:8080 -i *.png --fps 5 -c 4 -w 400 -h 400 -x 100 -y 100\n```\n\nUse the `--help` flag, or see the [help](#help) section for all available\noptions.\n\n## Installation\n\nFor installation, Git and Rust cargo are required.\nInstall the latest version of Rust with [rustup][rustup].\n\nThen, clone and install `pixelpwnr` with:\n\n```bash\n# Clone the project\ngit clone https://github.com/timvisee/pixelpwnr.git\ncd pixelpwnr\n\n# Install pixelpwnr\ncargo install -f\n\n# Start using pixelpwnr\npixelpwnr --help\n\n# or run it directly from Cargo\ncargo run --release -- --help\n```\n\nOr just build it and invoke the binary directly (Linux/macOS):\n\n```bash\n# Clone the project\ngit clone https://github.com/timvisee/pixelpwnr.git\ncd pixelpwnr\n\n# Build the project (release version)\ncargo build --release\n\n# Start using pixelpwnr\n./target/release/pixelpwnr --help\n```\n\n## Performance \u0026 speed optimization\n\nThere are many things that affect how quickly pixels can be painted on a\npixelflut server.  \nSome of them are:\n- Size of the image that is drawn.\n- Amount of connections used to push pixels.\n- Performance of the machine `pixelpwnr` is running on.\n- Network interface performance of the client.\n- Network interface performance of the server.\n- Performance of the pixelflut server.\n\nThings that improve painting performance:\n- Use a wired connection.\n- Use a LAN connection, closely linked to the pixelflut server. The lower\n  latency the better, due to the connection being over TCP.\n- Use as many threads (`-c` flag) as the server, your connection and your\n  machine allows.\n- Paint a smaller image (`-w`, `-h` flags).\n- Paint in an area on the screen, where the least other things are pained.\n- Use multiple machines (servers) with multiple `pixelpwnr` instances to push\n  pixels to the screen.\n\n## Help\n\n```text\n$ pixelpwnr --help\n\nInsanely fast pixelflut client for images and animations\n\nUsage: pixelpwnr [OPTIONS] --image \u003cPATH\u003e... \u003cHOST\u003e\n\nArguments:\n  \u003cHOST\u003e  The host to pwn \"host:port\"\n\nOptions:\n      --help             Show this help\n  -i, --image \u003cPATH\u003e...  Image path(s)\n  -w, --width \u003cPIXELS\u003e   Draw width [default: screen width]\n  -h, --height \u003cPIXELS\u003e  Draw height [default: screen height]\n  -x \u003cPIXELS\u003e            Draw X offset [default: 0]\n  -y \u003cPIXELS\u003e            Draw Y offset [default: 0]\n  -c, --count \u003cCOUNT\u003e    Number of concurrent threads [default: number of CPUs]\n  -r, --fps \u003cRATE\u003e       Frames per second with multiple images [default: 1]\n  -b, --binary           Use binary mode to set pixels (`PB` protocol extension) [default: off]\n  -f, --flush \u003cENABLED\u003e  Flush socket after each pixel [default: true] [default: true] [possible values: true, false]\n  -V, --version          Print version\n```\n\n## Relevant projects\n\n- [pixelpwnr-server][pixelpwnr-server]: server\n- [pixelpwnr-cast][pixelpwnr-cast]: cast your screen to a pixelflut server\n\n## License\nThis project is released under the GNU GPL-3.0 license.\nCheck out the [LICENSE](LICENSE) file for more information.\n\n\n[34C3]: https://events.ccc.de/congress/2017/wiki/index.php/Main_Page\n[pixelflut]: https://cccgoe.de/wiki/Pixelflut\n[pixelflut-video]: https://vimeo.com/92827556/\n[pixelpwnr-cast]: https://github.com/timvisee/pixelpwnr-cast\n[pixelpwnr-server]: https://github.com/timvisee/pixelpwnr-server\n[rust]: https://www.rust-lang.org/\n[rustup]: https://rustup.rs/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvisee%2Fpixelpwnr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvisee%2Fpixelpwnr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvisee%2Fpixelpwnr/lists"}