This project is being actively developed and it is not stable yet! It is currently recommended you either wait, or migrate manually.
If you encounter any issues during importing, please open an issue 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!) 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.
If you wish to migrate manually to Godot: YouTube migration guides, Godot docs (very helpful!), Discord server (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)
- Unidot Importer and UnityPackage Godot (Unity assets to Godot assets) (some of these projects may be merged into Unifree, but are not currently)
If you wish to migrate manually to Unreal Engine: helpful UE tutorials, Unreal Engine docs (very helpful!), Semi-official Discord server (for any burning questions you can't find answers to online)
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.
- Scan source project and detect files eligible for migration
- Use ChatGPT to translate
.csfiles 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; |
} |
} |
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 |
<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 |
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>
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>
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>
👋 Join our Discord server 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:
- ❗ ❗ Migrate Unity assets to Godot
- ❗ ❗ Migrate Unity assets to Cocos Creator
- What other engines should be implemented?
- Experiment with ChatGPT prompts for better code translation
- Add prompts/configs to migrate to Cocos Creator
- What other engines should be implemented?
- ❗ Step-by-step console based migration wizard
- ❗ More edge case handling
- Architecture review and improvements