{"id":13547275,"url":"https://github.com/netgfx/Phaser-typewriter","last_synced_at":"2025-04-02T19:32:52.893Z","repository":{"id":50254747,"uuid":"48637665","full_name":"netgfx/Phaser-typewriter","owner":"netgfx","description":"A phaser helper for the typewriter effect","archived":false,"fork":false,"pushed_at":"2017-07-03T09:53:04.000Z","size":892,"stargazers_count":38,"open_issues_count":2,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-03T15:38:36.578Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/netgfx.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":"2015-12-27T08:08:57.000Z","updated_at":"2024-10-28T12:55:52.000Z","dependencies_parsed_at":"2022-09-05T15:10:48.501Z","dependency_job_id":null,"html_url":"https://github.com/netgfx/Phaser-typewriter","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/netgfx%2FPhaser-typewriter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgfx%2FPhaser-typewriter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgfx%2FPhaser-typewriter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netgfx%2FPhaser-typewriter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netgfx","download_url":"https://codeload.github.com/netgfx/Phaser-typewriter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246880300,"owners_count":20848839,"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":[],"created_at":"2024-08-01T12:00:53.261Z","updated_at":"2025-04-02T19:32:49.589Z","avatar_url":"https://github.com/netgfx.png","language":"JavaScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=JCFPKZJ7Y23JJ\u0026lc=GR\u0026item_name=NetGfx%2ecom\u0026currency_code=EUR\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted"],"categories":["🚀 A series of exquisite and compact web page cool effects","Uncategorized"],"sub_categories":["Input Effect","Uncategorized"],"readme":"[![forthebadge](http://forthebadge.com/images/badges/uses-js.svg)](http://forthebadge.com)\n\n# Phaser-typewriter\nA typewriter effect wrapper for Phaser.io Javascript library\n\n\u003ch3\u003eInitialize the typewriter anywhere in your game\u003c/h3\u003e\n\n```\nvar typewriter = new Typewriter();\ntypewriter.init(gameInstance, options);\n```\n\npass necesery options like: context (the object that launches the typewriter)\n\n```\ntypewriter.init(gameInstance, {\n    x: 290,\n    y: 40,\n    fontFamily: \"chillerBlack\",\n    fontSize: 26,\n    maxWidth: 300,\n    sound: reg.track,\n    text: \"Some text to be typed!\"\n  });\n  typewriter.start();\n```\n\n\u003chr\u003e\n\n\u003cimg src=\"https://netgfx.com/trunk/randomPICS/Recording%209_zpsj4j8pxgo.gif\"/\u003e\n\n\u003cstrong\u003eView example: \u003ca href=\"http://www.netgfx.com/trunk/games/tools/phaser-typewriter\"\u003eComplete example \u003cspan\u003e(make sure to listen to the writing sound playing in the background ;) )\u003c/span\u003e\u003c/a\u003e\u003c/strong\u003e\n\n  \u003chr\u003e\n\n\u003cstrong\u003eGame Instance\u003c/strong\u003e\nThe game instance that we want the tooltips to appear to, such as \"game\"\n\n\u003cstrong\u003eGeneral Options:\u003c/strong\u003e\n\n\u003cul\u003e\n\t\u003cli\u003e\u003cstrong\u003etext:\u003c/strong\u003e The text to be written automatically\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003ex\u003c/strong\u003e The x position of the text (default: 100)\u003c/li\u003e\n\t\u003cli\u003e\u003cstrong\u003ey\u003c/strong\u003e The y position of the text (default: 100)\u003c/li\u003e\n\t\u003cli\u003e\u003cstrong\u003ewriterObj\u003c/strong\u003e A Phaser.Text or Phaser.BitmapText object, pre-created\u003c/li\u003e\n\t\u003cli\u003e\u003cstrong\u003ewriterFn: \u003c/strong\u003e The function to call when writing the text (default: null)\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003eendFn: \u003c/strong\u003e The function to call when the writing ends (defailt: null)\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003etime: \u003c/strong\u003e The duration of the animation effect writing each letter (default: 100ms)\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003emaxWidth: \u003c/strong\u003e The maximum width where the text will wrap (default: 200)\u003c/li\u003e\n\t\u003cli\u003e\u003cstrong\u003efontFamily: \u003c/strong\u003e The font family for the text to be writen (default: Arial)\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003efontSize: \u003c/strong\u003e The font size for the text (default: 28)\u003c/li\u003e\n  \u003cli\u003e\u003cstrong\u003esound: \u003c/strong\u003e The sound effect to play during the typewriter effect, it auto-stops when typing ends (default: null)\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cstrong\u003eAPI Functions\u003c/strong\u003e\n\n\u003cul\u003e\n    \u003cli\u003e\u003cstrong\u003einit: \u003c/strong\u003e Adds the options and game object to the Typewriter constructor\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003estart: \u003c/strong\u003e Enables and starts the typewriter effect\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003edestroy: \u003c/strong\u003e Destroys the typewriter object\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003ehideText: \u003c/strong\u003e Hide the text\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003eshowText: \u003c/strong\u003e Show the text\u003c/li\u003e\n    \u003cli\u003e\u003cstrong\u003emoveToTop: \u003c/strong\u003e Move the text to the top\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003ci\u003e\n\u003c/i\u003e\n\n\u003chr\u003e\n\n\u003cstrong\u003eBuy me a coffee or tea!\u003c/strong\u003e \u003cbr\u003e\n\u003ca href=\"https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=JCFPKZJ7Y23JJ\u0026lc=GR\u0026item_name=NetGfx%2ecom\u0026currency_code=EUR\u0026bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted\"\u003e\u003cimg src=\"https://www.paypalobjects.com/webstatic/en_US/btn/btn_donate_92x26.png\"/\u003e\u003c/a\u003e\n\n\n\u003chr\u003e\n\n\u003eThe TODO list is diminising!\n\n\u003ePlease let me know if you come across some bug or have something to contribute\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetgfx%2FPhaser-typewriter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetgfx%2FPhaser-typewriter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetgfx%2FPhaser-typewriter/lists"}