{ "info": { "author": "Andrii Doroshenko (Xrayez)", "author_email": "xrayez@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Software Development :: Code Generators" ], "description": "# GDGen\n\n[![Build Status](https://travis-ci.com/Xrayez/gdgen.svg?branch=master)](https://travis-ci.com/Xrayez/gdgen)\n\n*Version: 1.0-alpha*\n\nAn advanced, configurable code generator which aims to automate some aspects of\n[Godot Engine](https://github.com/godotengine/godot) development, namely:\n\n- [x] creating C++ modules;\n- [ ] creating GDNative plugins.\n\nCurrently only C++ module generation is supported, so most of the functionallity \nis revolving around modules.\n\n## Requirements\n\n* Python 3.6+\n* Git (optional)\n\n## Compatibility\n\n* Godot Engine 3.0+ (C++ modules generation)\n\n## Installation\n\n```bash\npip install git+https://github.com/Xrayez/gdgen\n```\n\n## Usage\n\n```bash\ngdgen [-n NAME] [-s INTERNAL_NAME] [-c CONFIG_PATH] [-o OUTPUT_PATH]\n```\n\n## Examples\nFor most use cases, you can use a simple wizard. Here's an example output:\n```\n$ ~/src/godot/modules> gdgen\n\nModule name: My awesome module\nInternal module name (snake_case): my_module\nAuthor name (default - You): Me\nEngine version (default - latest): 3.1\nC++ version (default - c++11): c++20\nNumber of classes to generate (default - 0): 1\n(0) Class name: NewNode\n(0) Class inherits: Node\n(0) Class path (default - ):\nDocumentation path (default - docs): doc_classes\nIcons path (default - editor/icons): icons\nThirdparty path (default - thirdparty):\nInitialize README? (default - True):\nLicense (default - MIT):\nVersion control system (default - git):\nWill be included inside project? (default - False): True\nInitialized empty Git repository in ~/src/godot/modules/my_module/.git/\n```\n\nYou can also create your own configuration file:\n```bash\ngdgen -c tests/configs/sample.json -o ~/src/godot/modules/\n```\n\nUse default config file, but fill the required fields manually:\n```bash\ngdgen -n MyModule -s my_module\n```\n\n# Config\n\nName|Description\n-----|-----\n`name`|(Required) Descriptive name of the module.\n`internal_name`|(Required) The name used by the engine for the module to compile. This name is used by default for any unnamed `classes` to be generated later (see below).\n`author`|The name that will be used to place inside license text. If not set explicitly, the generator is going to attempt to retrieve one with the help of supported version control provider. In case of `git`, it will use `git config user.name` value.\n`engine_version`|The engine target version used to generate compatible module.\n`cpp_version`|The C++ version to compile module-specific source files.\n`classes`|An optional array to generate Godot classes. Available fields: `name` - the class name; `inherits` - one of the base (Godot) core classes; `path` - relative base directory to generate classes in.\n`docs_path`|If set, configures the module to use module-specific documentation for `classes`.\n`icons_path`|If set, configures the module to use module-specific editor icons for `classes`.\n`thirdparty_path`|If set, configures the module to apply common operations on third-party code (disabling warnings etc).\n`readme`|If `true`, initializes a barebones README file with module installation instructions.\n`license`|If set, creates LICENSE file with current year and author substituted from available license templates.\n`version_control`|If set, attempts to initialize the module with version control provider of choice.\n`to_be_included_inside_project`|If `true`, creates `.gdignore` file so that the module can be included inside regular Godot project (for instance, prevents `*.obj` build files to be wrongly recognized and imported as 3D models).\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Xrayez/gdgen", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "gdgen", "package_url": "https://pypi.org/project/gdgen/", "platform": "", "project_url": "https://pypi.org/project/gdgen/", "project_urls": { "Homepage": "https://github.com/Xrayez/gdgen" }, "release_url": "https://pypi.org/project/gdgen/1.0a0/", "requires_dist": null, "requires_python": ">=3.6", "summary": "Code generator for Godot Engine", "version": "1.0a0", "yanked": false, "yanked_reason": null }, "last_serial": 6008389, "releases": { "1.0a0": [ { "comment_text": "", "digests": { "md5": "fbe218850441850bac9abd1abc413554", "sha256": "df869c5f6394723824ce3c4feb27a172ed6c0193881f21c8278566334dba9d6d" }, "downloads": -1, "filename": "gdgen-1.0a0-py3-none-any.whl", "has_sig": false, "md5_digest": "fbe218850441850bac9abd1abc413554", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 16403, "upload_time": "2019-10-21T17:32:29", "upload_time_iso_8601": "2019-10-21T17:32:29.898965Z", "url": "https://files.pythonhosted.org/packages/b3/89/32ca06da9c2c90fc0bac7bb938b806eacfbd9119d57998ee61f915190a0d/gdgen-1.0a0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "ea79a28447cc1eb879a6af4c3bbd3a48", "sha256": "97d68f9708d135fcfb9a9897ed47038ecbab65a54a1516ca22ccface41f64474" }, "downloads": -1, "filename": "gdgen-1.0a0.tar.gz", "has_sig": false, "md5_digest": "ea79a28447cc1eb879a6af4c3bbd3a48", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 11354, "upload_time": "2019-10-21T17:32:33", "upload_time_iso_8601": "2019-10-21T17:32:33.474807Z", "url": "https://files.pythonhosted.org/packages/6a/6d/210016612ee9a45086d1ffc45527015db89bca2222e99554c1a1eb00d805/gdgen-1.0a0.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fbe218850441850bac9abd1abc413554", "sha256": "df869c5f6394723824ce3c4feb27a172ed6c0193881f21c8278566334dba9d6d" }, "downloads": -1, "filename": "gdgen-1.0a0-py3-none-any.whl", "has_sig": false, "md5_digest": "fbe218850441850bac9abd1abc413554", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 16403, "upload_time": "2019-10-21T17:32:29", "upload_time_iso_8601": "2019-10-21T17:32:29.898965Z", "url": "https://files.pythonhosted.org/packages/b3/89/32ca06da9c2c90fc0bac7bb938b806eacfbd9119d57998ee61f915190a0d/gdgen-1.0a0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "ea79a28447cc1eb879a6af4c3bbd3a48", "sha256": "97d68f9708d135fcfb9a9897ed47038ecbab65a54a1516ca22ccface41f64474" }, "downloads": -1, "filename": "gdgen-1.0a0.tar.gz", "has_sig": false, "md5_digest": "ea79a28447cc1eb879a6af4c3bbd3a48", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 11354, "upload_time": "2019-10-21T17:32:33", "upload_time_iso_8601": "2019-10-21T17:32:33.474807Z", "url": "https://files.pythonhosted.org/packages/6a/6d/210016612ee9a45086d1ffc45527015db89bca2222e99554c1a1eb00d805/gdgen-1.0a0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }