@dchighs/dc-assets 0.0.2 → 0.0.4

package/README.md

@@ -0,0 +1,169 @@
+# @dchighs/dc-assets
+
+**@dchighs/dc-assets** is a package for downloading assets from the game [Dragon City](https://dragoncitygame.com/) (this is not an official SocialPoint library; it is fan-made).
+
+## 📦 Installation
+
+Installation is straightforward—simply use your preferred package manager. Here is an example using NPM:
+
+```bush
+npm i @dchighs/dc-assets @dchighs/dc-core
+```
+
+> You need to install `@dchighs/dc-core` as well because I have set it as a `peerDependency`. This means the package requires `@dchighs/dc-core` to function, but it will use the specific version you have installed in your project.
+
+---
+
+## 🚀 Usage
+
+<a href="https://www.buymeacoffee.com/marcuth">
+  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="200">
+</a>
+
+### Downloading Dragon Assets
+
+#### Downloading Animations
+
+**Flash Animations (`.swf`):**
+
+To obtain the URL and download the Flash animation file (`.swf`), you will need to provide the following information:
+
+```ts
+import { DragonPhase } from "@dchighs/dc-core"
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const dragonFlashAnimationDownloader = dcAssets.dragons.animations.flash({
+		imageName: "1000_dragon_nature",
+		phase: DragonPhase.Adult,
+		// skin: "_1"
+	})
+	
+	await dragonFlashAnimationDownloader.download("dragon-animation.swf")
+})();
+```
+
+**Spine Animations (`.zip`):**
+
+```ts
+import { DragonPhase } from "@dchighs/dc-core"
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const dragonSpineAnimationDownloader = dcAssets.dragons.animations.spine({
+		imageName: "1000_dragon_nature",
+		phase: DragonPhase.Adult,
+		// skin: "_1"
+	})
+	
+	await dragonSpineAnimationDownloader.download("dragon-animation.zip")
+})();
+```
+
+---
+
+### Downloading Dragon Sprites
+
+```ts
+import { DragonPhase, DragonSpriteQuality } from "@dchighs/dc-core"
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const dragonSpriteDownloader = dcAssets.dragons.sprite({
+		imageName: "1000_dragon_nature",
+		phase: DragonPhase.Adult,
+		imageQuality: DragonSpriteQuality.Large
+		// skin: "_1"
+	})
+	
+	await dragonSpriteDownloader.download("dragon-sprite.png")
+})();
+```
+
+---
+
+### Downloading Dragon Thumbnails
+
+```ts
+import { DragonPhase } from "@dchighs/dc-core"
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const dragonThumbDownloader = dcAssets.dragons.thumbnail({
+		imageName: "1000_dragon_nature",
+		phase: DragonPhase.Adult,
+		// skin: "_1"
+	})
+	
+	await dragonThumbDownloader.download("dragon-thumbnail.png")
+})();
+```
+
+---
+
+### Downloading Island Content Packages
+
+```ts
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const islandDownloader = dcAssets.islands.package({
+		fileName: "1000_dragon_nature",
+		islandType: "heroicraces_islands",
+	})
+	
+	await islandDownloader.download("island-package.zip")
+})();
+```
+
+### Downloading Audio
+
+**Music:**
+
+```ts
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const musicDownloader = dcAssets.sounds.music({
+		keyName: "531_dc_party_planning_island"
+	})
+	
+	await musicDownloader.download("music.mp3") // Fixed extension example
+})();
+```
+
+---
+
+### Downloading Chest Sprites
+
+```ts
+import dcAssets from "@dchighs/dc-assets"
+
+;(async () => {
+	const chestDownloader = dcAssets.chests.sprite({
+		fileName: "1000_dragon_nature",
+		islandType: "heroicraces_islands",
+	})
+	
+	await chestDownloader.download("chest-sprite.png")
+})();
+```
+
+---
+
+## 🤝 Contributing
+
+* Want to contribute? Follow these steps:
+* Fork the repository.
+* Create a new branch (`git checkout -b feature-new`).
+* Commit your changes (`git commit -m 'Add new feature'`).
+* Push to the branch (`git push origin feature-new`).
+* Open a Pull Request.
+
+---
+
+## 📝 License
+
+This project is licensed under the MIT License.
+
+Would you like me to proofread the technical terms or adjust the tone for a specific audience?

package/dist/chest-sprite-downloader.d.ts

@@ -0,0 +1,13 @@
+import { DragonSpriteQuality } from "@dchighs/dc-core";
+import { StaticFileDownloader } from "./static-file-downloader";
+export type ChestSpriteDownloaderOptions = {
+    imageQuality: DragonSpriteQuality;
+    imageName: string;
+};
+export declare class ChestSpriteDownloader extends StaticFileDownloader {
+    readonly url: string;
+    readonly imageQuality: DragonSpriteQuality;
+    readonly imageName: string;
+    constructor({ imageQuality, imageName }: ChestSpriteDownloaderOptions);
+    download(filePath: string): Promise<string>;
+}

package/dist/chest-sprite-downloader.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChestSpriteDownloader = void 0;
+const static_file_downloader_1 = require("./static-file-downloader");
+class ChestSpriteDownloader extends static_file_downloader_1.StaticFileDownloader {
+    constructor({ imageQuality, imageName }) {
+        super();
+        this.imageQuality = imageQuality;
+        this.imageName = imageName;
+        this.url = `https://dci-static-s1.socialpointgames.com/static/dragoncity/mobile/ui/chests/ui_basic_${imageName}${imageQuality}.png`;
+    }
+    async download(filePath) {
+        return await super.download(this.url, filePath);
+    }
+}
+exports.ChestSpriteDownloader = ChestSpriteDownloader;

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { DragonSpriteDownloader, DragonSpriteDownloaderOptions } from "./dragon-
 import { DragonThumbnailDownloader, DragonThumbnailDownloaderOptions } from "./dragon-thumbnail-downloader";
 import { IslandPackageDownloader, IslandPackageDownloaderOptions } from "./island-package-downloader";
 import { MusicDownloader, MusicDownloaderOptions } from "./music-downloader";
+import { ChestSpriteDownloader, ChestSpriteDownloaderOptions } from "./chest-sprite-downloader";
 declare const dcAssets: {
     dragons: {
         animations: {
@@ -19,11 +20,15 @@ declare const dcAssets: {
     sounds: {
         music: (options: MusicDownloaderOptions) => MusicDownloader;
     };
+    chests: {
+        sprite: (options: ChestSpriteDownloaderOptions) => ChestSpriteDownloader;
+    };
 };
 export * from "./dragon-flash-animation-downloader";
 export * from "./static-file-downloader";
 export * from "./dragon-spine-animation-downloader";
 export * from "./dragon-sprite-downloader";
 export * from "./island-package-downloader";
+export * from "./chest-sprite-downloader";
 export * from "./music-downloader";
 export default dcAssets;

package/dist/index.js

@@ -20,6 +20,7 @@ const dragon_sprite_downloader_1 = require("./dragon-sprite-downloader");
 const dragon_thumbnail_downloader_1 = require("./dragon-thumbnail-downloader");
 const island_package_downloader_1 = require("./island-package-downloader");
 const music_downloader_1 = require("./music-downloader");
+const chest_sprite_downloader_1 = require("./chest-sprite-downloader");
 const dcAssets = {
     dragons: {
         animations: {
@@ -34,6 +35,9 @@ const dcAssets = {
     },
     sounds: {
         music: (options) => new music_downloader_1.MusicDownloader(options)
+    },
+    chests: {
+        sprite: (options) => new chest_sprite_downloader_1.ChestSpriteDownloader(options)
     }
 };
 __exportStar(require("./dragon-flash-animation-downloader"), exports);
@@ -41,5 +45,6 @@ __exportStar(require("./static-file-downloader"), exports);
 __exportStar(require("./dragon-spine-animation-downloader"), exports);
 __exportStar(require("./dragon-sprite-downloader"), exports);
 __exportStar(require("./island-package-downloader"), exports);
+__exportStar(require("./chest-sprite-downloader"), exports);
 __exportStar(require("./music-downloader"), exports);
 exports.default = dcAssets;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dchighs/dc-assets",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Library focused on downloading static files from the Dragon City server.",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -33,7 +33,7 @@
     "axios": "^1.13.2"
   },
   "peerDependencies": {
-    "@dchighs/dc-core": "^0.0.2"
+    "@dchighs/dc-core": "^0.0.3"
   },
   "repository": {
     "type": "git",