{"id":31911521,"url":"https://github.com/cococry/vortex","last_synced_at":"2026-07-19T06:33:54.222Z","repository":{"id":317770574,"uuid":"1068694745","full_name":"cococry/vortex","owner":"cococry","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-02T22:20:46.000Z","size":385,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-03T00:21:00.122Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cococry.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-02T19:09:51.000Z","updated_at":"2025-10-02T22:20:50.000Z","dependencies_parsed_at":"2025-10-03T00:21:02.822Z","dependency_job_id":"716b2caa-7c29-42a8-91f9-ae77a4453e0b","html_url":"https://github.com/cococry/vortex","commit_stats":null,"previous_names":["cococry/vortex"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/cococry/vortex","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cococry%2Fvortex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cococry%2Fvortex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cococry%2Fvortex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cococry%2Fvortex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cococry","download_url":"https://codeload.github.com/cococry/vortex/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cococry%2Fvortex/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279016301,"owners_count":26085827,"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","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-10-13T17:17:36.445Z","updated_at":"2026-07-19T06:33:54.209Z","avatar_url":"https://github.com/cococry.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vortex\n\n**vortex** is an independent wayland compositor written in C. \n\n---\n\n## Overview\n\nVortex is currently under active development as a high-performance, modern Wayland compositor\nfocused on creating a visually appealing Wayland desktop experience. \nThe project's goal is to create a self-contained, independent platform dedicated entirely to desktop compositing. \nIn other words, the compositor is responsible only for compositing and its related aspects (such as window animations and IPC), \nwhile components like the desktop shell are intentionally abstracted away from it.\n\n## Build \u0026 Run\n\nMake sure you have the required dependencies installed (debian packages shown):\n```\nmeson ninja-build libwayland-dev libdrm-dev libgbm-dev libegl1-mesa-dev libinput-dev libudev-dev libxkbcommon-dev libglfw3-dev libcglm-dev libfreetype-dev libharfbuzz-dev\n```\n\nClone \u0026 build:\n```\ngit clone --recurse-submodules https://github.com/cococry/vortex.git\ncd vortex\n\nmeson setup build\nmeson compile -C build\nsudo meson install -C build\n```\n\nTo run Vortex:\n```\n./build/vortex # Start the compositor\nWAYLAND_DISPLAY=wayland-1 weston-simple-shm # Start a simple client \n```\n\nNote: Use the wayland display that is logged by the output of **./vortex --verbose** as the WAYLAND_DISPLAY variable \nwhen starting clients.\n\n\nNote: The sink backend is automatically chosen at runtime, depending on context. \n\nSupported sink backends are:\n- *DRM/KMS* (hardware scanout)\n- *Wayland* (nested session)\n\n---\n\n## CLI options\n\n### Usage\n```bash\nvortex [option:s] (value:s)\n```\n\n\n### Options\n\n| Option | Description |\n|--------|--------------|\n| `-h, --help` | Show this help message and exit |\n| `-v, --version` | Show version information |\n| `-vb, --verbose` | Log verbose (trace) output for debugging |\n| `-lf, --logfile` | Write logs to a logfile located in:\u003cbr\u003e`~/.local/state/vortex/logs/` or `$XDG_STATE_HOME/vortex/logs` |\n| `-q, --quiet` | Run in quiet mode (no logging) |\n| `-vo, --virtual-outputs [val]` | Specify the number of virtual outputs (windows) in nested mode |\n| `-b, --backend [val]` | Specify the compositor’s sink backend.\u003cbr\u003eValid options: `drm`, `wl`. Example:\u003cbr\u003e`vortex -b drm` |\n| `-bp, --backend-path [val]` | Specify the **path to a `.so` file** to load as a custom sink backend |\n| `-expt,  --exclude-protocol [val(s)]` | Specify the optional protocols (space seperated) you wish to not support during runtime |\n\n## Sink Backend Configuration\n\nThe compositor supports **pluggable sink backends** that can be discovered at runtime.\n\n### Valid Backends\n\nValid options for backends are: \n  - drm\n  -  wl \n\nYou can specify one directly:\n\n```bash\nvortex -b drm\n```\n\nOr load a custom shared object backend manually:\n\n```bash\nvortex -bp /usr/lib/vortex/backends/libcustom.so\n```\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcococry%2Fvortex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcococry%2Fvortex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcococry%2Fvortex/lists"}