infiland/gm2godot

A tool that converts GameMaker projects into Godot

GM2Godot

GM2Godot is a tool which converts GameMaker (2024.6.2) projects to Godot (4.2) projects. This repository is work in progress but feel free to help!

What it is and what it isn't

When presenting this tool, I've gotten a couple of questions what the tool really is and what it is supposed to be, so I'll break it down.

GM2Godot is:

• A tool that ports assets from GameMaker to Godot
• Is for people who don't want to port the GameMaker project to Godot from scratch
• Not perfect. It will make mistakes.

GM2Godot isn't:

• For people who expect everything will work perfectly.
• A compiler that can seamlessly transpile GML to GDScript (yet)
• This isn't a tool which converts exported GML projects to Godot, use UndertaleToolMod instead

Contribution

Contribution is found in CONTRIBUTING.md. But pretty much fork the repo, do pull requests and I'll try to code review them.

Installation

Clone this repository

git clone https://github.com/Infiland/GM2Godot

Open VSC and install Python 3.9.0 or later (I haven't tested older python versions)

py --version

You can download python here.

If you are Linux, you are required to have Tkinter module, do the following: (tested this on Ubuntu, so it probably works on debian based systems)

sudo apt-get install python3-tk python3-pil python3-pil.imagetk

The program requires the following libraries to use

pip install Pillow markdown2 tkhtmlview

(If you have Pillow installed, version 8.0.0 or newer is required)

Once installed, you can run the program:

python main.py

How to use

The tool will open a GUI menu upon running main.py.

At the top, place the GameMaker directory and the Godot directory in each textbox. NOTE: Godot directory needs to be completely empty to avoid data loss, GameMaker should stay as is.

Once you put both directories in the tool, you can choose in settings what you want to port and press the "Convert" button.

It will then start taking assets from GameMaker and port them into your empty Godot project. The tool will be done when it says so in the console and when the progress bar is at 100%.

gm2godot's Issues

Port Gamemaker Audio Groups and turn them into Godot AudioBuses

Port gamemaker audiogroups and turn them into audiobuses

Create empty script in objects

Each object would have a script, which has populated event scripts

So the create event from gamemaker would be _ready():

And step event would be _process():

Input events would be under _input(): and inside would be if statements depending on what was pressed, released, held etc etc.

Other events would serve as custom functions

Define sprite collision mask

Sprite collisions are defined in the sprite editor in GameMaker. Read collision mask in https://manual.gamemaker.io/monthly/en/The_Asset_Editors/Sprites.htm

We could try making scenes with a sprite node which also has a Collision2D node

Define the following:

• Rectangle
• Rotated Rectangle
• Ellipse
• Diamond
• Precise
• Precise (per frame)

Add timer since the conversion started

Add a timer below the progress bar which shows how long the conversion has lasted

Port gamemaker game settings to godot game settings

Port things whenever or not vsync is enabled, fullscreen, blending, or other settings that can be easily transfered from gamemaker to godot in the tool

Add "Stop" button

Add a button which stop conversion of files

Tool needs to properly copy the order of gamemaker's sprite frames to godot.

Gamemaker sprites can have multiple frames, when they do, they have a specific order of frames on how they are shown in GameMaker.

Currently the tool does take all sprites, but they are taken from a random (or at least wrong) order, which is bad for making animations using sprites.

To fix this, inside gamemaker sprite folders there is a .yy file that shows the order of each sprite how they should be represented inside the GameMaker engine.

I think a good idea would be to read that .yy file and then based on the information it takes the images that are referenced in that file

Port notes from Gamemaker to Godot

Notes in Gamemaker are just .txt files, very easy to port.

Make a folder in godot called notes and put all of the notes in there.
Also add setting to port notes

Add settings in the tool

Add settings in the tool like what assets you want to import in the project.

So it would have a list of checkboxes where you can select for eg, just to port sprites over

Add Contributing.MD

Add some basic contributing.md documentation

Add program icon for GM2Godot

Add a program icon for GM2Godot instead of using the default tkinter icon
Haven't decided on how it will look like but we'll see

Add an about section in GM2Godot

Add an about section in the tool and include contribution credits.

Modernize the GUI of the tool

The look of the tool is ugly, needs a bit more refining with the GUI

Port sound info from GM to Godot

Sound information is found in .yy files which contain in what bitrate sounds are in GameMaker and other various information like if the sounds are mono/stereo, whenever they are compressed etc.

Port empty objects that have sprites

Objects in GameMaker are bundled with events, and each event acts like a script. So the "Create Event" in GameMaker is like the _ready(): in Godot, and _process(): is the "Step Event"

Make the tool create the "objects" folder which contains scenes with the gamemaker's object name. In each scene, there is a node2D with the imported sprite that is taken from the gamemaker object

Port fonts from Gamemaker to Godot

Make a new folder in godot called "fonts" and in gamemaker inside of folder fonts, in .yy files search for "fontName" in the files, which is the exact name of the font and let the tool assign the name to a font in godot

Click "Version" to see release notes

Clicking "Version" will show release notes

Proper README.md

Make a proper README.md with full instructions and intentions on how to use this tool.

Port included files from gamemaker to godot

Straight forward, just make a "included files" folder in gamemaker and copy everything to godot

Simplify main.py

Simplify main.py and make classes for the following:

GUI folder which has styles, progress bar, buttons and console
Converters folder which has all of the conversion scripts
Utils folder for other functions

Fix crash with GM2Godot requiring the game icon

Fix crash with GM2Godot requiring the game icon

Have each sound tied to an AudioBus in Godot

Have every single sound tied to an AudioBus that gets imported from AudioGroups in Godot

EDIT: This is currently impossible as in Godot you can assign audio buses only in AudioStreamPlayer or similar but not in audio files themselves. I am thinking that at least the tool to make folders based on gamemaker audio groups and assign various sounds there

Quotation marks need to be removed when the value is a boolean

Quotation marks need to be removed when the value is a boolean or this will happen

It will corrupt the project and not read values correctly

Port sounds from GameMaker to Godot

GameMaker has a "sounds" folder and it should copy over .mp3, .wav and .ogg files over to Godot.

Add "Remove All" and "Select All" in settings

Add options to select all or remove all options in settings

Port tilemaps from Gamemaker to godot

Port tilemaps to godot, have it recognize how the tilemap is split and make a resource of the tilemap in the godot directory.

Detect .yyp file and project.godot file

In order for the conversion to begin, there needs to be a .yyp file in the GameMaker root folder and project.godot in Godot's root folder

Port game name to godot

Port the name of the game to a godot project

Port game icon to godot

Take the image from options\windows\icons\icon.ico and put it in the root folder of godot as 'icon.ico'