@dchighs/dc-config 0.0.3 → 0.0.6

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Marcuth
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2025 Marcuth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,89 +1,89 @@
-# @dchighs/dc-config
-
-> ⚠️ **Note**: Don't ask me how to get your URL, Auth Token, or User ID; I won't answer you. If you don't know how to use this, it's because you shouldn't.
-
-**@dchighs/dc-config** is a package for accessing game configuration data from [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:
-
-```cmd
-npm i @dchighs/dc-config
-
-```
-
-## 🚀 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>
-
-### Fetching configuration for specific parameters
-
-To create a `Config` instance, you need to provide credentials or use the static `.create()` method by providing the necessary parameters:
-
-```ts
-import { Config, ConfigLanguage, ConfigPlatform, ConfigFilter } from "@dchighs/dc-config"
-
-;(async () => {
-	const userId = process.env.USER_ID
-	const authToken = process.env.AUTH_TOKEN
-	const url = process.env.URL
-
-	const config = await Config.create({
-		url: url,
-		userId: userId,
-		authToken: authToken,
-		language: ConfigLanguage.Turkish, // optional - "en" is default
-		platform: ConfigPlatform.Android, // optional - "ios" is default
-		filter: [ConfigFilter.Items] // optional - undefined is default
-	})
-	
-	const data = config.data
-	
-	console.log(data)
-})();
-
-```
-
----
-
-### Loading a saved configuration from a file
-
-If you have a saved JSON file containing configuration data and want to load it to perform operations using the class, you can do it as follows:
-
-```ts
-import { Config, ConfigLanguage, ConfigPlatform, GameConfigDto } from "@dchighs/dc-config"
-import fs from "node:fs"
-
-;(async () => {
-	const filePath = "config.json"
-	const contentString = await fs.promises.readFile(filePath, { encoding: "utf-8" })
-	const data = JSON.parse(contentString) as GameConfigDto
-
-	const config = new Config({
-		language: ConfigLanguage.Turkish,
-		platform: ConfigPlatform.Android,
-		data: data
-	})
-})();
-
-```
-
----
-
-## 🤝 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
-
+# @dchighs/dc-config
+
+> ⚠️ **Note**: Don't ask me how to get your URL, Auth Token, or User ID; I won't answer you. If you don't know how to use this, it's because you shouldn't.
+
+**@dchighs/dc-config** is a package for accessing game configuration data from [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:
+
+```cmd
+npm i @dchighs/dc-config
+
+```
+
+## 🚀 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>
+
+### Fetching configuration for specific parameters
+
+To create a `Config` instance, you need to provide credentials or use the static `.create()` method by providing the necessary parameters:
+
+```ts
+import { Config, ConfigLanguage, ConfigPlatform, ConfigFilter } from "@dchighs/dc-config"
+
+;(async () => {
+	const userId = process.env.USER_ID
+	const authToken = process.env.AUTH_TOKEN
+	const url = process.env.URL
+
+	const config = await Config.create({
+		url: url,
+		userId: userId,
+		authToken: authToken,
+		language: ConfigLanguage.Turkish, // optional - "en" is default
+		platform: ConfigPlatform.Android, // optional - "ios" is default
+		filter: [ConfigFilter.Items] // optional - undefined is default
+	})
+	
+	const data = config.data
+	
+	console.log(data)
+})();
+
+```
+
+---
+
+### Loading a saved configuration from a file
+
+If you have a saved JSON file containing configuration data and want to load it to perform operations using the class, you can do it as follows:
+
+```ts
+import { Config, ConfigLanguage, ConfigPlatform, GameConfigDto } from "@dchighs/dc-config"
+import fs from "node:fs"
+
+;(async () => {
+	const filePath = "config.json"
+	const contentString = await fs.promises.readFile(filePath, { encoding: "utf-8" })
+	const data = JSON.parse(contentString) as GameConfigDto
+
+	const config = new Config({
+		language: ConfigLanguage.Turkish,
+		platform: ConfigPlatform.Android,
+		data: data
+	})
+})();
+
+```
+
+---
+
+## 🤝 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.