base on # Migrate Unity projects to other engines! ### :warning: This is an early prototype! :warning: This project is being actively developed and it is not stable yet! It is currently recommended you either wait, or migrate manually. ### :mag: Your feedback is crucial! If you encounter any issues during importing, please [_open an issue_](https://github.com/ProjectUnifree/unifree/issues) on this repository — it is vital for the success and improvement of this project. You can use this tool to help aid migration by providing you with a base, but you _will_ have to modify a lot of code yourself. Please do not under any circumstance expect help regarding this tool from any Godot or Unreal Engine Discord server [_(join our server instead!)_](https://discord.gg/Ee5wJ4JWBQ) And please don't correlate any bad experience you have while using this tool to _"Godot/Unreal sucking and being broken"_, both engines are very stable and game-ready; This is not an official project for either of those engines, this is a community effort. #### Godot Engine If you wish to migrate manually to Godot: [YouTube migration guides](https://www.youtube.com/results?search_query=Migrate+from+Unity+to+Godot), [Godot docs](https://docs.godotengine.org/en/stable/) _(very helpful!)_, [Discord server](https://discord.gg/4JBkykG) _(for any burning questions you can't find answers to online)_ These other tools would also be very helpful!: - [UnityGLTF _(Unity 3D models to Godot models)_](https://github.com/KhronosGroup/UnityGLTF) - [Unidot Importer](https://github.com/V-Sekai/unidot_importer) and [UnityPackage Godot](https://github.com/barcoderdev/unitypackage_godot) _(Unity assets to Godot assets)_ (some of these projects may be merged into Unifree, but are not currently) #### Unreal Engine If you wish to migrate manually to Unreal Engine: [helpful UE tutorials](https://www.youtube.com/results?search_query=Unreal+Engine+basics+%22(for+Unity+developers)%22), [Unreal Engine docs](https://docs.unrealengine.com/5.3/en-US/unreal-engine-for-unity-developers/) _(very helpful!)_, [Semi-official Discord server](https://discord.com/invite/unreal-slackers) _(for any burning questions you can't find answers to online)_ #### Other engines (Cocos, Stride, etc) Search up a tutorial on YouTube, view the docs, and join your engine's Discord server or subreddit for any questions! These engines are not currently supported by this tool, as we have a lot more to work on. But support may be added sometime in the future. We are currently focusing on Godot, as well as Unreal. ## Features * Scan source project and detect files eligible for migration * Use ChatGPT to translate `.cs` files into Godot scripts and Unreal 3D classes. Here is how sample translation looks: ``` Unity | Godot ------------------------------------------------------ | ------------------------------------------------------ public class Player : MonoBehaviour | class_name Player: { | private SpriteRenderer spriteRenderer; | var sprite_renderer: SpriteRenderer public Sprite[] sprites; | var sprites: Array private int spriteIndex; | var sprite_index: int | public float strength = 5f; | var strength: float = 5.0 | private Vector3 direction; | var direction: Vector3 | private void Awake() | func _ready(): { | sprite_renderer = get_node("SpriteRenderer") spriteRenderer = GetComponent<SpriteRenderer>(); | } | func _on_start(): | call_deferred("animate_sprite") private void Start() | set_process(true) { | InvokeRepeating( | func _on_enable(): nameof(AnimateSprite), | var position = transform.position 0.15f, | position.y = 0.0 0.15f | transform.position = position ); | direction = Vector3.ZERO } | | private void OnEnable() | { | Vector3 position = transform.position; | position.y = 0f; | transform.position = position; | direction = Vector3.zero; | } | } | ``` ## Installation and Usage `launch.sh` (or `launch.bat` on windows) is the main script that downloads Unifree code, installs a python virtual environment, installs dependencies and launches the main program (`unifree/free.py`). It accepts following parameters: | Key | Description | |-----------------------------|---------------------------------------------------------------------------------------------------------------| | `<your_openai_api_key>` | [How to get an OpenAI API Key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key) | | `<config_name>` | Name of the migration. Currently supported: `godot`, `godot-huggingface`, `godot-mono`, `unreal` | | `<source_project_dir>` | Absolute path of the project to migrate | | `<destination_project_dir>` | Absolute path of where results should be written | ### macOS ``` brew install git python3 curl -0 https://raw.githubusercontent.com/ProjectUnifree/unifree/main/launch.sh | bash OPENAI_API_KEY=<your_openai_api_key> ./launch.sh <config_name> <source_project_dir> <destination_project_dir> ``` ### Windows Install Git for Windows https://git-scm.com/download/win, then run: ``` git clone https://github.com/ProjectUnifree/unifree cd unifree launch.bat <your_openai_api_key> <config_name> <source_project_dir> <destination_project_dir> ``` ### Ubuntu/Debian ``` sudo apt install git python3 python3-venv curl -0 https://raw.githubusercontent.com/ProjectUnifree/unifree/main/launch.sh | bash OPENAI_API_KEY=<your_openai_api_key> ./launch.sh <config_name> <source_project_dir> <destination_project_dir> ``` ## Call To Action :wave: Join our [Discord server](https://discord.gg/Ee5wJ4JWBQ) for a live discussion! We are actively seeking contributors. If you are familiar with Unity, Godot, Cocos Creator or any other engines, help us! Here is what we need help with: #### Asset Migration * :exclamation: :exclamation: Migrate Unity assets to Godot * :exclamation: :exclamation: Migrate Unity assets to Cocos Creator * What other engines should be implemented? #### Source Migration * Experiment with ChatGPT prompts for better code translation * Add prompts/configs to migrate to Cocos Creator * What other engines should be implemented? #### Framework * :exclamation: Step-by-step console based migration wizard * :exclamation: More edge case handling * Architecture review and improvements ", Assign "at most 3 tags" to the expected json: {"id":"2159","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"