base on 🐧 A real-time physically based 3D rendering engine for React Native <a href="https://margelo.io"> <picture> <source media="(prefers-color-scheme: dark)" srcset="./img/banner-dark.png" /> <source media="(prefers-color-scheme: light)" srcset="./img/banner-light.png" /> <img alt="react-native-filament" src="./img/banner-light.png" /> </picture> </a> <br /> ### Features react-native-filament is a powerful 3D rendering engine for React Native. It features: * 🧊 Native C++ physically based rendering using [filament](https://github.com/google/filament) * 🏀 Native C++ physics using [bullet3](https://github.com/bulletphysics/bullet3) * 🏎️ GPU-accelerated by Metal and OpenGL/Vulkan * 📹 Renders on separate Threads * 📦 Easy to use reactive declarative API * 📚 Well documented * ✅ Supports old and new arch ### Installation See the [installation guide in the docs.](https://margelo.github.io/react-native-filament/docs/guides) ### Example ```tsx import { FilamentScene, FilamentView, Model, Camera, DefaultLight } from 'react-native-filament' function App() { return ( <FilamentScene> <FilamentView style={{ width: 100, height: 100 }} model={model} > {/* Render with the default camera and light: */} <Camera /> <DefaultLight > {/* Add a model to the scene (only glb supported yet): */} <Model source={require('./duck.glb')}> </FilamentView> </FilamentScene> ) } ``` > See the [example](./package/example/Shared) app ### Comparison with other libraries One library to render 3D content is [expo-gl](https://docs.expo.dev/versions/latest/sdk/gl-view) usually used together with [expo-three](https://www.npmjs.com/package/expo-three). react-native-filament has a few advantages over expo-gl: - Supports using `glb` files out of the box - On iOS react-native-filament uses Metal, where expo-gl is using the [deprecated OpenGL ES](https://developer.apple.com/documentation/opengles) apple framework - The rendering happens on the JS thread for `expo-three`, where react-native-filament uses a separate thread (and filament processes the rendering commands in a pool of different threads) - filament is battle tested and react-native-filament is used in production apps with millions of users already, proven to be highly stable ### Contributing We welcome contributions to react-native-filament! 🎉 After cloning the repo make sure you have the submodules clones as well: ```sh git submodule update --init --recursive --depth 1 ``` Install all node modules (including the examples) ```sh cd package yarn ``` And finally build filament and bullet3: ```sh # Inside ./package yarn build-bullet3 yarn build-filament:release # or yarn build-filament:debug ``` You can then build one of the example apps in `package/example/AppExamplePaper` or `package/example/AppExampleFabric`. ### Adopting at scale react-native-filament is provided _as is_. If you need help with integrating react-native-filament in your app or have additional bugfixing or feature requests, reach out to us at [margelo.io](https://margelo.io). ### Socials * 🐦 [**Follow us on Twitter**](https://twitter.com/margelo_io) for updates * 💬 [**Join the Margelo Community Discord**](https://discord.gg/6CSHz2qAvA) for chatting about react-native-filament ### Attributions & thanks #### Slay react-native-filament was built for- and mostly funded by [Slay](https://www.slay.cool) - the creators of [Pengu](https://www.slay.cool/pengu)! 🐧 Without them, react-native-filament wouldn't exist, so thanks Slay! ❤️ #### Filament and Bullet3 react-native-filament uses [filament](https://github.com/google/filament) (an amazing library by Google), and [bullet3](https://github.com/bulletphysics/bullet3) (an amazing physics library by Bullet Physics). Without those core libraries and the geniuses behind them, react-native-filament wouldn't exist - so thanks Google & Bullet! ❤️ #### Copyrights The example app in this project uses several free assets: - Image by <a href="https://www.freepik.com/free-ai-image/space-travel-collage-design_94964745.htm#fromView=search&page=1&position=1&uuid=cf66f9c3-2d56-4228-a3cf-de7c07d418fb">freepik</a> - Image by <a href="https://www.freepik.com/free-psd/3d-icon-product-management_44990845.htm#fromView=search&page=2&position=0&uuid=691aae54-efdf-451c-9112-0ff373e761e7">Freepik</a> - Image by <a href="https://www.freepik.com/free-psd/3d-collection-with-hands-holding-smartphone_13678985.htm#fromView=search&page=1&position=3&uuid=7761a685-d1b6-4202-8505-9a872775cbbb">Freepik</a> - Michelle by [mixamo](https://www.mixamo.com/#/?page=2&type=Character) - "Buster Drone" (https://skfb.ly/TBnX) by LaVADraGoN is licensed under Creative Commons Attribution-NonCommercial (http://creativecommons.org/licenses/by-nc/4.0/). ", Assign "at most 3 tags" to the expected json: {"id":"11308","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"