@dchighs/dc-assets 0.0.1 → 0.0.3

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/island-package-downloader.js

@@ -17,7 +17,7 @@ class IslandPackageDownloader extends static_file_downloader_1.StaticFileDownloa
         if (islandType === dc_core_1.IslandType.GridIslands && !fileName.endsWith("_optim.zip")) {
             fileName = fileName.replace(".zip", "_optim.zip");
         }
-        this.url = `https://www.socialpointgames.com/static/dragoncity/mobile/ui/${islandType === dc_core_1.IslandType.HeroicRaces ? "heroicraces_islands" : "islands"}/HD/dxt5/${fileName}`;
+        this.url = `https://www.socialpointgames.com/static/dragoncity/mobile/ui/${islandType === dc_core_1.IslandType.HeroicRaces ? "heroicraces_islands" : islandType}/HD/dxt5/${fileName}`;
     }
     async download(filePath) {
         return await super.download(this.url, filePath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dchighs/dc-assets",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "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",