font-awesome-for-phaser 0.3.4

package/README.md

@@ -0,0 +1,68 @@
+# Font Awesome for Phaser
+
+Utilitários e tipos principais para desenvolvimento de jogos com Phaser.
+
+## 📦 Instalação
+
+```bash
+npm install font-awesome-for-phaser
+# or
+pnpm add font-awesome-for-phaser
+# or
+yarn add font-awesome-for-phaser
+```
+
+## 🚀 Add to your project
+
+First, you must have the free font awesome imported in your page.
+
+```html
+<style>
+  @import 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css';
+</style>
+```
+
+Or, you can use our auto import
+
+```typescript
+import { loadFont } from 'font-awesome-for-phaser';
+
+loadFont().then(() => {
+  const config: Phaser.Types.Core.GameConfig = {
+    // .....
+  };
+  new Game(config);
+});
+
+// or
+async function startGame() {
+  await loadFont();
+
+  const config: Phaser.Types.Core.GameConfig = {
+    // .....
+  };
+  new Game(config);
+}
+```
+
+## Usage
+
+You can use Font Awesome icons in your Phaser game in two ways:
+
+### Using icon as text
+
+```typescript
+import { getIconChar } from 'font-awesome-for-phaser';
+
+// .....
+const iconText = scene.add.text(0, 0, char, {
+  font: `36px 'FontAwesome'`, // IMPORTANT! The name of the font MUST BE between char ('), if you use `font: '36px FontAwesome', won't work
+  color: '#ffffff',
+});
+iconText.setOrigin(0.5);
+
+// Or you can use our component
+import { IconText } from 'font-awesome-for-phaser';
+
+const iconText = new IconText(this, 10, 10, 'facebook', { fontSize: 42 });
+```

package/dist/components/icon-text.d.ts

@@ -0,0 +1,18 @@
+import { Scene } from 'phaser';
+import { type IconKey } from '../constants/icons';
+/**
+ * IconText is a Phaser Text GameObject that displays Font Awesome icons
+ * By default, the origin is set to (0.5, 0.5). To change it, use setOrigin() method
+ *
+ * @param scene - The Scene to which this IconText belongs
+ * @param x - The horizontal position of this IconText in the world
+ * @param y - The vertical position of this IconText in the world
+ * @param icon - The Font Awesome icon key to display
+ * @param size - The font size in pixels (default: 16)
+ * @param style - Additional text style configuration options
+ */
+export declare class IconText extends Phaser.GameObjects.Text {
+    constructor(scene: Scene, x: number, y: number, icon: IconKey, size?: number, style?: Phaser.Types.GameObjects.Text.TextStyle);
+    setIcon(icon: IconKey): void;
+}
+//# sourceMappingURL=icon-text.d.ts.map

package/dist/components/icon-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"icon-text.d.ts","sourceRoot":"","sources":["../../src/components/icon-text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAGlD;;;;;;;;;;GAUG;AACH,qBAAa,QAAS,SAAQ,MAAM,CAAC,WAAW,CAAC,IAAI;gBAEjD,KAAK,EAAE,KAAK,EACZ,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,IAAI,EAAE,OAAO,EACb,IAAI,GAAE,MAAW,EACjB,KAAK,GAAE,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAc;IAO9C,OAAO,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI;CAGpC"}

package/dist/components/icon-text.js

@@ -0,0 +1,23 @@
+import { getIconChar } from '../utils';
+/**
+ * IconText is a Phaser Text GameObject that displays Font Awesome icons
+ * By default, the origin is set to (0.5, 0.5). To change it, use setOrigin() method
+ *
+ * @param scene - The Scene to which this IconText belongs
+ * @param x - The horizontal position of this IconText in the world
+ * @param y - The vertical position of this IconText in the world
+ * @param icon - The Font Awesome icon key to display
+ * @param size - The font size in pixels (default: 16)
+ * @param style - Additional text style configuration options
+ */
+export class IconText extends Phaser.GameObjects.Text {
+    constructor(scene, x, y, icon, size = 16, style = {}) {
+        super(scene, x, y, getIconChar(icon), { fontSize: `${size}px`, ...style });
+        this.setFontFamily("'FontAwesome'");
+        this.setOrigin(0.5, 0.5);
+    }
+    setIcon(icon) {
+        this.setText(getIconChar(icon));
+    }
+}
+//# sourceMappingURL=icon-text.js.map

package/dist/components/icon-text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"icon-text.js","sourceRoot":"","sources":["../../src/components/icon-text.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;;;;;;;GAUG;AACH,MAAM,OAAO,QAAS,SAAQ,MAAM,CAAC,WAAW,CAAC,IAAI;IACnD,YACE,KAAY,EACZ,CAAS,EACT,CAAS,EACT,IAAa,EACb,OAAe,EAAE,EACjB,QAAiD,EAAE;QAEnD,KAAK,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,IAAI,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;QAC3E,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QACpC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC3B,CAAC;IAEM,OAAO,CAAC,IAAa;QAC1B,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;IAClC,CAAC;CACF"}

package/dist/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './icon-text';
+//# sourceMappingURL=index.d.ts.map

package/dist/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/dist/components/index.js

@@ -0,0 +1,2 @@
+export * from './icon-text';
+//# sourceMappingURL=index.js.map

package/dist/components/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}