Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kiriri/gd2cs.py

Regex based Python script that converts arbitrary gdscript code to C#
https://github.com/kiriri/gd2cs.py

Last synced: 12 days ago
JSON representation

Regex based Python script that converts arbitrary gdscript code to C#

Awesome Lists containing this project

README 

        
# gd2cs.py

Regex based Python script that converts arbitrary gdscript code to C#


Wrapped in a graphical UI plugin for use in the Godot Editor.


It's far from perfect, but it it should let you skip most of the gruntwork when converting. 
 

It analyzes syntax only. No fancy code analysis.



__Make sure to back-up all your files. No warranty of any kind is given. The author of this script cannot be held liable for any damage it may cause.__



__Use at your own risk.__



## Godot compatibility of UI plugin

- Originally developed for Godot _v3.2_ ([see this version in Asset library](https://godotengine.org/asset-library/asset/849))

- Current version tested rudimentary with Godot _v4.1.stable.mono.official [970459615]_.



## Known issues

- Keywords in strings or comments may be replaced


- Ternary operators such as A?B:C are too expensive to parse correctly and are therefore ignored in some transformations.



## Usage



### In Godot:

Just drop the addon directly into your godot projects addon folder, then activate it in your Project Settings.


Then navigate to Project->Tools->gd2cs .


Hover over buttons or input controls to find out what they do.



### From Python:

Specify the input gd file via -f "\*" and the target output file via -o "\*" . 


Use -t * to specify the number of spaces in a tab (default = 4). This will replace consecutive spaces with tabs so the regex patterns can match a mix of space-offsets and tab-offsets (eg "else:\n    pass" will become "else:\n\tpass").





Example :


`python3 gd2cs.py/gd2cs.py -i "Test_Script_Godot.gd" -o "Output/TestScript.cs"`





Example Code Conversion (apr. real life example. Intentionally formatted badly to show where the converter will fail) :


```GDScript

tool

extends Node



enum {UNIT_NEUTRAL, UNIT_ENEMY, UNIT_ALLY}

enum Named {THING_1, THING_2, ANOTHER_THING = -1}



export(Date,Param)      const Date = preload("res://path")

const ABC = true

var G:float setget setterA, getterA

var DEF = -0.1 # Step



var f = typeof(4+6/12)



signal a()

signal b(a:int,b:Type)



var string_test_1 = 'an "Elephant"'

var string_test_2 = 'an

 \'Elephantos\''



# "Default" 'Data' (I recommend splitting this kind of stuff into separate json files in c#)

const _default_data = {

	"t" : 100,

	"r

	afg" : 'asfgh',

	"u" : false,# Example Comment

	"r":["a",{"b":false}],

	"t":{"e":{"g":1,"f":2},},

};



func setterA(v:float):

	return

	pass



func getterA()->float:

	return 1.



func ready():

	var s = range(abs(-1),randi())

	

	.ready();



    if ABC: # Comment

        assert(false)

    elif false:

        print("Hello"+" "+"World")

    else:

        (a+b)()

    return [

    [0,e,[0,{}]], # a

    [1,{},[0,{}]],

    ];



# Do stuff

func r(value:T,val=false,s)->bool:

	if value == null : return !true



	var type = typeof(value)

	match type :

		TYPE_BOOL,TYPE_INT,TYPE_NIL:

			return value

		TYPE_DICTIONARY:

			var result = {}

			for k in value:

				result[k] = value[k]

			return result

			

func default_async_function():

	yield(self,'a');

			

```










Result :



```cs



using System;

using Godot;

using Dictionary = Godot.Collections.Dictionary;

using Array = Godot.Collections.Array;



[Tool]

public class GameDataTest2 : Node

{

	 

	enum {UNIT_NEUTRAL, UNIT_ENEMY, UNIT_ALLY};

	enum Named {THING_1, THING_2, ANOTHER_THING = -1}

	

	[Export(Param)] static readonly Date Date = GD.Load("res://path");

	const bool ABC = true;

	float G {get{return getterA();} set{setterA(value);}}

	float DEF = -0.1f ;// Step

	

	__TYPE__ f = (4+6/12).GetType();

	

	[Signal] delegate void a();

	[Signal] delegate void b(int a,Type b);

	

	string string_test_1 = "an \"Elephant\"";

	__TYPE__ string_test_2 = "an\n"+

	" \'Elephantos\'"

	

	// "Default" 'Data' (I recommend splitting this kind of stuff into separate json files in c#)

	static readonly Dictionary _default_data = new Dictionary(){

		{"t", 100},

		{"r\n"+

	"	afg", "asfgh"},

		{"u", false},// Example Comment

		{"r",new Array(){"a",new Dictionary(){{"b",false}}}},

		{"t",new Dictionary(){{"e",new Dictionary(){{"g",1},{"f",2}}},}},

	};

	

	public void setterA(float v)

	{  

		return;

	

	}

	

	public float getterA()

	{  

		return 1.;

	

	}

	

	public __TYPE__ ready()

	{  

		var s = GD.Range(Mathf.Abs(-1),GD.Randi());

		

		base.ready();

	

		if(ABC) // Comment

		{

			System.Diagnostics.Debug.Assert(false);

		}

		else if(false)

		{

			GD.Print("Hello"+" "+"World");

		}

		else

		{

			(a+b)()

		}

		return new Array(){

		new Array(){0,e,new Array(){0,new Dictionary(){}}}, // a

		new Array(){1,new Dictionary(){},new Array(){0,new Dictionary(){}}},

		};

	

	// Do stuff

	}

	

	public bool r(T value,bool val=false,__TYPE__ s)

	{  

		if(value == null)

			 return !true;

	

		var type = (value).GetType();

		switch( type )

		{

			case typeof(bool):

			case typeof(int):

			case null:

				return value;

				break;

			case typeof(Dictionary):

				Dictionary result = new Dictionary(){};

				foreach(var k in value)

				{

					result[k] = value[k];

				}

				return result;

				

				break;

		}

	}

	

	public async void default_async_function()

	{  

		await ToSignal(this,"a");

	}

	

				

}

```



As you can see, it's not perfect and it will require you to manually fix the formatting and some underivable type definitions afterwards. But it should save you hundreds of hours on your code conversions. If it does save you time, please consider leaving a donation. It'll flow right back into making this project even better.



## What's next



\- process entire folders (recursively)



But before that the focus will be on polishing existing features, increasing performance and publishing it on the Godot Asset Store.