{"id":15137931,"url":"https://github.com/voxell-tech/velyst","last_synced_at":"2025-04-05T09:04:56.456Z","repository":{"id":241059497,"uuid":"804153501","full_name":"voxell-tech/velyst","owner":"voxell-tech","description":"Interactive Typst content creator using Vello and Bevy.","archived":false,"fork":false,"pushed_at":"2025-03-29T07:42:48.000Z","size":799,"stargazers_count":92,"open_issues_count":12,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-29T08:03:16.547Z","etag":null,"topics":["bevy","typst","vector-graphics","vello"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voxell-tech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["nixon-voxell"],"ko_fi":"voxelltech","patreon":"voxelltech"}},"created_at":"2024-05-22T03:59:01.000Z","updated_at":"2025-03-28T15:38:29.000Z","dependencies_parsed_at":"2024-09-16T03:15:11.250Z","dependency_job_id":null,"html_url":"https://github.com/voxell-tech/velyst","commit_stats":null,"previous_names":["voxell-tech/bevy_typst"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxell-tech%2Fvelyst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxell-tech%2Fvelyst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxell-tech%2Fvelyst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voxell-tech%2Fvelyst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voxell-tech","download_url":"https://codeload.github.com/voxell-tech/velyst/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312068,"owners_count":20918344,"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":["bevy","typst","vector-graphics","vello"],"created_at":"2024-09-26T07:03:38.684Z","updated_at":"2025-04-05T09:04:56.411Z","avatar_url":"https://github.com/voxell-tech.png","language":"Rust","funding_links":["https://github.com/sponsors/nixon-voxell","https://ko-fi.com/voxelltech","https://patreon.com/voxelltech"],"categories":[],"sub_categories":[],"readme":"# Velyst\n\nInteractive [Typst](https://typst.app) content creator using [Vello](https://github.com/linebender/vello) and [Bevy](https://bevyengine.org).\n\n![hello world](./.github/assets/hello_world.gif)\n\n*Associated example [here](./examples/hello_world.rs)!*\n\n## Quickstart\n\nVelyst renders Typst content using Typst functions. To get started rendering a simple box, create a function inside a `.typ` file:\n\n```typ\n#let main(width, height) = {\n  // Convert float to length\n  let width = (width * 1pt)\n  let height = (height * 1pt)\n\n  box(width: width, height: height, fill: white)\n}\n```\n\nThen, in your `.rs` file, register your Typst asset file and function.\n\n```rs\nuse bevy::prelude::*;\nuse bevy_vello::VelloPlugin;\nuse velyst::{prelude::*, VelystPlugin};\n\nfn main() {\n    App::new()\n        .add_plugins((DefaultPlugins, VelloPlugin::default()))\n        .add_plugins(VelystPlugin::default())\n        .register_typst_asset::\u003cHelloWorld\u003e()\n        .compile_typst_func::\u003cHelloWorld, MainFunc\u003e()\n        .render_typst_func::\u003cMainFunc\u003e()\n        .insert_resource(MainFunc {\n            width: 100.0,\n            height: 100.0,\n        })\n        .add_systems(Startup, setup)\n        .run();\n}\n\nfn setup(mut commands: Commands) {\n    commands.spawn(Camera2dBundle::default());\n}\n\n// `main` function in Typst with their respective values.\n#[derive(TypstFunc, Resource, Default)]\n#[typst_func(name = \"main\")] // name of function in the Typst file\nstruct MainFunc {\n    width: f64,\n    height: f64,\n}\n\n// Path to the Typst file that you created.\n#[derive(TypstPath)]\n#[typst_path = \"path/to/file.typ\"]\nstruct HelloWorld;\n```\n\n## Interactions\n\nVelyst comes with built-in interactions using `bevy_ui`.\n\n![game ui](./.github/assets/game_ui.png)\n\n*Associated example [here](./examples/game_ui.rs)!*\n\n## Join the community!\n\nYou can join us on the [Voxell discord server](https://discord.gg/Mhnyp6VYEQ).\n\n## License\n\n`velyst` is dual-licensed under either:\n\n- MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))\n- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))\n\nThis means you can select the license you prefer!\nThis dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxell-tech%2Fvelyst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoxell-tech%2Fvelyst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoxell-tech%2Fvelyst/lists"}