{"id":21410624,"url":"https://github.com/isoteriksoftware/mingdx","last_synced_at":"2025-07-14T02:31:06.546Z","repository":{"id":61750691,"uuid":"306540340","full_name":"isoteriksoftware/mingdx","owner":"isoteriksoftware","description":"A small libGDX based Java game library","archived":false,"fork":false,"pushed_at":"2022-10-20T13:27:37.000Z","size":848,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-03-04T23:59:36.167Z","etag":null,"topics":["2d","3d","android","cross-platform","ga","game","game-library","html5","ios","java","libgdx","linux","macosx","mingdx","windows"],"latest_commit_sha":null,"homepage":"https://isoteriktechnologies.gitbook.io/mingdx/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/isoteriksoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-23T05:45:03.000Z","updated_at":"2022-12-14T23:27:18.000Z","dependencies_parsed_at":"2022-10-20T17:15:21.128Z","dependency_job_id":null,"html_url":"https://github.com/isoteriksoftware/mingdx","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isoteriksoftware%2Fmingdx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isoteriksoftware%2Fmingdx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isoteriksoftware%2Fmingdx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isoteriksoftware%2Fmingdx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/isoteriksoftware","download_url":"https://codeload.github.com/isoteriksoftware/mingdx/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225941255,"owners_count":17549010,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["2d","3d","android","cross-platform","ga","game","game-library","html5","ios","java","libgdx","linux","macosx","mingdx","windows"],"created_at":"2024-11-22T17:40:51.316Z","updated_at":"2024-11-22T17:40:51.938Z","avatar_url":"https://github.com/isoteriksoftware.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"![mingdx-logo](https://user-images.githubusercontent.com/50753501/97774186-13e76000-1b56-11eb-804d-f89aba2681b2.png)\n\n![Release](https://jitpack.io/v/iSoterikTechnologies/mingdx.svg)\n\n[minGDX](https://isoteriksoftware.gitbook.io/mingdx/) **is a small open source Java game development library based on [libGDX](https://libgdx.com/).\nIt is neither an alternative nor a replacement for libGDX, it simply provides another (better) way of coding a libGDX game. minGDX is not an extension of libGDX either!**\n\nWe all love libGDX, it is cross-platform, and most of the time, it gets the job done. However, just like any other framework, liGDX can't handle every needs of a game.\nThis is because games are usually too specific, so it is hard to anticipate the developer's needs. libGDX already handles most of the low-level details that we (libGDX users)\ndon't have to deal with ourselves, however, there are still some boiler plates that we keep repeating for every project, and it gets worse.\nminGDX takes care of common boiler plates and presents a clean component-based API for developing your libGDX game.\n\nJust in case you're wondering what the **min** in minGDX means, it stands for _minimal_, as in **minimal libGDX**. We're terrible at naming things, yes we know :)\n\n\n## Getting minGDX / Documentation\nminGDX is dependent on two of the main libGDX extensions: **box2d** and **gdx-ai**. When creating your libGDX project, it is advisable to add those extensions at that point.\n\nminGDX is available in JitPack:\n- Add JitPack in your root build.gradle at the end of repositories:\n```shell\nallprojects {\n    repositories {\n        ...\n        maven { url 'https://jitpack.io' }\n    }\n}\n```\n- To pull minGDX, open the project-level build.gradle file, add `api 'com.github.iSoterikTechnologies:mingdx:v2.0.0'` to the dependencies closure of the core project.\nSync the project and wait for gradle to do its magic!\n\n**Note:** We used _api_ instead of _implementation_ because we want the other sub-projects (modules) to be able to access minGDX. This is possible because the sub-projects\ndepend on the core project. If we don't do this, then we must add the dependecy to every other module!\n\nThough minGDX is a relatively small library, it is very well documented! We offer a regularly updated tutorial blog dedicated to minGDX and a clean documentation website:\n- [Visit the tutorial blog](https://gdx-gaming.blogspot.com)\n- [MinGdx documentation](https://isoteriksoftware.gitbook.io/mingdx/)\n- [Javadocs](https://isoteriksoftware.github.io/mingdx/)\n\n\n## Usage\nIt is very easy to get started with minGDX. Integrate minGDX in 4 easy steps:\n- Make your game class extend `com.isoterik.mgdx.MinGdxGame`:\n```java\nimport com.isoterik.mgdx.MinGdxGame;\n\npublic class MyGameClass extends MinGdxGame {\n\n}\n```\n- Override the `initGame()` method and return a `com.isoterik.mgdx.Scene` instance (this will be your splash scene!):\n```java\nimport com.isoterik.mgdx.MinGdxGame;\nimport com.isoterik.mgdx.Scene;\n\npublic class MyGameClass extends MinGdxGame {\n    @Override\n    protected Scene initGame() {\n        return new Scene();\n    }\n}\n```\n- Optionally set a scene transition animation:\n```java\nimport com.isoterik.mgdx.MinGdxGame;\nimport com.isoterik.mgdx.Scene;\nimport com.isoterik.mgdx.m2d.scenes.transition.SceneTransitions;\n\npublic class MyGameClass extends MinGdxGame {\n    @Override\n    protected Scene initGame() {\n        splashTransition = SceneTransitions.fade(1f); // Let's fade in!\n        return new Scene();\n    }\n}\n```\n- Run your game!\n\nIf you see a red background displayed then congratulations, you've just ran your first minGDX game!\n\n\n## Support\nWe've only just scratched the surface! Head on to our [tutorial blog](https://gdx-gaming.blogspot.com) to learn more.\nCheck out the [documentations](https://isoteriksoftware.gitbook.io/mingdx/) and, also the [minGDX javadocs](https://isoteriksoftware.github.io/mingdx/).\n\n\n## License\nJust like libGDX, minGDX is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) meaning you can use it free of charge, without strings attached in commercial and non-commercial projects.\nWe, however, love to get (non-mandatory) credit in case you release a game or app using minGDX!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisoteriksoftware%2Fmingdx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fisoteriksoftware%2Fmingdx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisoteriksoftware%2Fmingdx/lists"}