{"id":13534154,"url":"https://github.com/Dovyski/flixel-studio","last_synced_at":"2025-04-01T22:31:19.625Z","repository":{"id":140595898,"uuid":"142412724","full_name":"Dovyski/flixel-studio","owner":"Dovyski","description":"Embeddable, in-game editor for HaxeFlixel. Turn the existing Flixel debugger into a full-featured editor!","archived":false,"fork":false,"pushed_at":"2023-01-02T11:25:55.000Z","size":164,"stargazers_count":101,"open_issues_count":8,"forks_count":9,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-10-16T18:55:30.910Z","etag":null,"topics":["editor","flixel","gamedev","haxe","haxeflixel","haxelib","tool"],"latest_commit_sha":null,"homepage":"","language":"Haxe","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Dovyski.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null},"funding":{"github":["dovyski"]}},"created_at":"2018-07-26T08:34:16.000Z","updated_at":"2024-08-11T17:26:16.000Z","dependencies_parsed_at":"2024-01-03T03:54:11.173Z","dependency_job_id":"ec7b4aba-cd72-470e-950d-54a480e4d411","html_url":"https://github.com/Dovyski/flixel-studio","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dovyski%2Fflixel-studio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dovyski%2Fflixel-studio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dovyski%2Fflixel-studio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dovyski%2Fflixel-studio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dovyski","download_url":"https://codeload.github.com/Dovyski/flixel-studio/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222779865,"owners_count":17036542,"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":["editor","flixel","gamedev","haxe","haxeflixel","haxelib","tool"],"created_at":"2024-08-01T07:01:27.068Z","updated_at":"2024-11-02T21:30:59.036Z","avatar_url":"https://github.com/Dovyski.png","language":"Haxe","readme":"![](assets/images/logo/flixel-studio.png)\n\n[flixel](https://github.com/HaxeFlixel/flixel) | [addons](https://github.com/HaxeFlixel/flixel-addons) | [ui](https://github.com/HaxeFlixel/flixel-ui) | [demos](https://github.com/HaxeFlixel/flixel-demos) | [tools](https://github.com/HaxeFlixel/flixel-tools) | [studio](https://github.com/Dovyski/flixel-studio) | [templates](https://github.com/HaxeFlixel/flixel-templates) | [docs](https://github.com/HaxeFlixel/flixel-docs) | [haxeflixel.com](https://github.com/HaxeFlixel/haxeflixel.com)\n\n## About\n\n\u003e **NOTICE: this project is in early days of development! Things are expected to change and/or break. Documentation and features are still very rough, but they will eventually mature in the near future. Check the [ROADMAP](ROADMAP.md) to have an idea of how the project will evolve.**\n\nFlixel Studio is an embeddable, in-game editor for [HaxeFlixel](https://haxeflixel.com). Simply put, when enabled in a project, Flixel Studio will turn the existing Flixel debugger into a full-featured editor. You can then organize game elements using layers, edit tilemaps, change properties of game objects, among many more things.\n\nThe philosophy behind Flixel Studio is to empower game developers with tools that integrate directly into their game runtime/code.\n\n## Features\n\n![flixel-studio](https://user-images.githubusercontent.com/512405/46570435-79ab9280-c964-11e8-8824-9aca88a43786.gif)\n\n* Full-featured in-game editor.\n* Load and modify tilemaps.\n* Edit properties of game objects, e.g. position, velocity, etc.\n* Manage game elements in layers of content.\n\n## Getting started\n\n### 1. Install the `flixel-studio` lib\n\nGet the latest development version from Github:\n\n```\nhaxelib git flixel-studio https://github.com/Dovyski/flixel-studio.git\n```\n\n___NOTE: in the future, you will be able to install `flixel-studio` from the `haxelib` repository.___\n\n### 2. Add the `flixel-studio` lib to your project\n\nGo to the folder where you have your project files, open the file `Project.xml`, then add the following:\n\n```xml\n\u003chaxelib name=\"flixel-studio\"/\u003e\n```\n\nUsually libs are listed in the libraries section of the `Project.xml` file, which will probably look like the following after you add flixel-studio:\n\n```xml\n\u003c!--------------------------------LIBRARIES-------------------------------------\u003e\n\n\u003chaxelib name=\"flixel\"/\u003e\n\n\u003c!--In case you want to use the addons package--\u003e\n\u003c!--\u003chaxelib name=\"flixel-addons\" /\u003e--\u003e\n\n\u003c!--In case you want to use the ui package--\u003e\n\u003c!--\u003chaxelib name=\"flixel-ui\" /\u003e--\u003e\n\n\u003c!--In case you want to use nape with flixel--\u003e\n\u003c!--\u003chaxelib name=\"nape\" /\u003e--\u003e\n\n\u003chaxelib name=\"flixel-studio\"/\u003e\n```\n\n### 3. Usage (code)\n\nAfter installing and adding `flixel-studio` to your project, you are ready to start using it. To make Flixel Studio available for use in your game, call `flixel.addons.studio.FlxStudio.create()` anywhere in your code, e.g. in your Document class or in your `FlxState`'s `create()` override.\n\nBelow is an example of a call in the game's `create()` override:\n\n```haxe\noverride public function create():Void\n{\n\tsuper.create();\n\n\t// [your own code here]\n\n\tflixel.addons.studio.FlxStudio.create();\n}\n```\n\nBelow is an example of a call in the document class:\n\n```haxe\npackage;\n\nimport flixel.FlxGame;\nimport openfl.display.Sprite;\n\nclass Main extends Sprite\n{\n\tpublic function new():Void\n\t{\n\t\tsuper();\n\t\taddChild(new FlxGame(0, 0, MyInitialState));\t\n\t\tflixel.addons.studio.FlxStudio.create();\n\t}\n}\n```\n\n### 3. Usage (in-game editor)\n\nWhen you compile and run your game, you can just bring up Flixel's debugger (by pressing the key below \u003ckbd\u003eEsc\u003c/kbd\u003e), then click the _interaction tool_ ![](https://haxeflixel.com/documentation/images/02_handbook/debugger/icons/interactive.png) in the bar at the top.\n\nWhen Flixel Studio is enabled in a project, the interaction's panel of tools on the right have more items, e.g. a tile tool. Addionally, you will see a few new debugger windows showing layers of content, etc. Enjoy your in-game editor!\n\n## Contribute\n\nThe development process is a little bit rough right now. It's basically me coding and changing things a lot, documenting things very superficially along the way. At some point, the APIs will stabilize and it will be a lot easier to join the party.\n\nIf you want to help now, you can take flixel-studio for a ride and send me your feedback, or suggest a feature, [report a problem]((https://github.com/Dovyski/Codebot/issues/new)), or even send a pull request. Check the [ROADMAP](ROADMAP.md) to have an idea of how the project should evolve.\n\n## License\n\nFlixel Studio is licensed under the terms of the [MIT](https://choosealicense.com/licenses/mit/) Open Source license and is available for free.\n\n## Changelog\n\nSee all changes in the [CHANGELOG](CHANGELOG.md) file.\n","funding_links":["https://github.com/sponsors/dovyski"],"categories":["Libraries","Miscellaneous"],"sub_categories":["Video Tutorials","Editor","Haxe"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDovyski%2Fflixel-studio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDovyski%2Fflixel-studio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDovyski%2Fflixel-studio/lists"}