{"id":18710040,"url":"https://github.com/alisenola/unreal-rust","last_synced_at":"2025-04-12T11:18:22.624Z","repository":{"id":143072638,"uuid":"563805530","full_name":"alisenola/unreal-rust","owner":"alisenola","description":"Rust integration for Unreal Engine 5 Game.","archived":false,"fork":false,"pushed_at":"2023-11-27T03:14:10.000Z","size":299,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"latest","last_synced_at":"2025-04-12T11:18:16.545Z","etag":null,"topics":["rust","rust-plugin","serverless","unreal-api","unreal-games"],"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/alisenola.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","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}},"created_at":"2022-11-09T11:27:52.000Z","updated_at":"2024-08-10T03:49:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"cd22779e-b181-4494-830f-ea128d79b727","html_url":"https://github.com/alisenola/unreal-rust","commit_stats":null,"previous_names":["alisenola/unreal-rust"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alisenola%2Funreal-rust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alisenola%2Funreal-rust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alisenola%2Funreal-rust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alisenola%2Funreal-rust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alisenola","download_url":"https://codeload.github.com/alisenola/unreal-rust/tar.gz/refs/heads/latest","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248557847,"owners_count":21124168,"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":["rust","rust-plugin","serverless","unreal-api","unreal-games"],"created_at":"2024-11-07T12:30:06.010Z","updated_at":"2025-04-12T11:18:22.592Z","avatar_url":"https://github.com/alisenola.png","language":"Rust","funding_links":["https://www.patreon.com/quaternius"],"categories":[],"sub_categories":[],"readme":"# 🦀 unreal-rust\n\nOpinionated Rust integration for Unreal Engine\n\n[![Build Status](https://github.com/MaikKlein/unreal-rust/workflows/CI/badge.svg)](https://github.com/MaikKlein/unreal-rust/actions?workflow=CI)\n[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE-MIT)\n[![LICENSE](https://img.shields.io/badge/license-apache-blue.svg)](LICENSE-APACHE)\n[![Discord](https://img.shields.io/discord/1015534599654354975.svg?label=\u0026logo=discord\u0026logoColor=ffffff\u0026color=7389D8\u0026labelColor=6A7EC2)](https://discord.gg/jyM6fBBdt6)\n\n## ☣️ Warning\n\n`unreal-rust` is not ready to be used in a real project. `unreal-rust` is in a very early state and nothing more than a proof of concept right now. The API will change quite frequently. Things might crash, or not work as intended. The user experience will not be great.\n\nI am releasing `unreal-rust` on github to develop it in the open.\n\n## 🎯 Features\n\n- **Simple opinionated bindings**: Easy access to core APIs like playing sounds, spawning actors, pathfinding, physics etc.\n- **Developer friendly**: Fast iteration times with hot reloading in the editor and during live play. Panics are caught and do not crash the editor\n- **Editor integration**: Add Rust components to actors in the editor, or access Rust components from Blueprint to drive animations.\n- **Entity Component System**: unreal-rust is built on top of an ECS.\n- **Built on top of `AActor`**: Most gameplay features like `GameMode`, `Characters`, `GameState`, `GAS` are not directly accessible in unreal-rust. Instead unreal-rust will provide optional alternatives. But you can still interact with most parts of the engine as Rust components can be accessed in Blueprint.\n- **No engine modifications**: unreal-rust is only a `Plugin`, just drop it in your project. See [Supported versions](#supported-versions) for more information.\n- **Samples**: The development of unreal-rust is heavily driven by samples.\n- **Free**: Dual licensed under MIT/APACHE\n\n## 🖥️ Supported Platforms\n\n* 🐧 Linux\n* 🪟 Windows\n\nPotential future platforms: iOS, macOS, Android, html5/browser(possibly)\n\nConsoles are unsupported. I simply can not offer console support as it is a closed off ecosystem. Nor do I have access to any developer kits myself.\n\n## 💌 Blog posts / media\n\n* [Announcing Unreal Rust](https://maikklein.github.io/unreal-rust-1/)\n* [unreal-rust devlog](https://www.youtube.com/playlist?list=PLps1NSMUeqzicmTej83z-n1J383u1UVq1)\n\n\n## 🚩 Known problems\n\n- This is just a hobby project of mine that I work on outside of my normal work hours. I might be slow to respond to issues, questions, feature requests, or PR reviews.\n\n## 🦮 Getting started\n\n### Running the example\n\n_I am aware that these are a lot of steps. I am sorry, I will try to simplify this in the future_\n\n* Prerequisites:\n* * [Unreal Engine 5](https://www.unrealengine.com/en-US/unreal-engine-5). For Linux users you can get it [here](https://www.unrealengine.com/en-US/linux)\n* * Get [git lfs](https://git-lfs.github.com/), and run `git lfs install`\n* * [ue4cli](https://docs.adamrehn.com/ue4cli/overview/introduction-to-ue4cli), You can get it with `pip3 install ue4cli`. This step is optional but I will use `ue4cli` in this guide.\n* * [Rust](https://www.rust-lang.org/tools/install)\n\nWe start by cloning this repository \n\n```\ngit clone https://github.com/MaikKlein/unreal-rust\n```\n\nNext we clone the submodule. This will download the actual example with all the assets.\n\n```\ncd unreal-rust\ngit submodule update --init\n```\n\nNext we need to setup the example\n\n- - Linux `sh setup.sh`\n- - Windows `setup.bat`\n\nThis will symlink the `RustPlugin` into the unreal `example/RustExample/Plugin` folder.\n\nNow we need to build the actual Rust code:\n\nSimply run\n\n```\ncargo build --release\n```\n\nThis will build the whole project. This also produces our dll that we are going to load into Unreal.\n\nCopy the dll/so file into the project \n\n* Linux: `cp target/release/libunreal_rust_example.so example/RustExample/Binaries/rustplugin.so`\n* Windows: `copy .\\target\\release\\unreal_rust_example.dll .\\example\\RustExample\\Binaries\\rustplugin.dll`\n\nNow we need to build the unreal example\n\n```\ncd example/RustExample\nue4 build Development Editor\n```\n\nNow you can run the example with `ue4 run`\n\n## 🚀 Supported versions\n\n- `5.0`\n\nThis project will always try to support the latest version.\n\n- Latest version of Unreal\n- Latest version of Rust\n- Latest version of all dependencies\n\n## 🤝 Alternatives\n\n* [Unreal Angelscript](https://angelscript.hazelight.se/)\n* [UnrealCLR](https://github.com/nxrighthere/UnrealCLR)\n\n## 🥰 Thank you\n\n* [kenney](https://kenney.nl/), [quaternius](https://www.patreon.com/quaternius)\n* [bevy](https://bevyengine.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falisenola%2Funreal-rust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falisenola%2Funreal-rust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falisenola%2Funreal-rust/lists"}