@opys/curseforge 0.1.6 → 0.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +38 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,38 @@
1
+ # @opys/curseforge
2
+
3
+ [![npm](https://img.shields.io/npm/v/@opys/curseforge.svg)](https://www.npmjs.com/package/@opys/curseforge)
4
+
5
+ CurseForge mod-file plugin — resolves a list of CurseForge file
6
+ references (numeric IDs or `/files/<id>` URLs) into downloadable
7
+ Artifacts via the [CurseForge API](https://docs.curseforge.com/).
8
+
9
+ ```sh
10
+ npm install @opys/curseforge
11
+ ```
12
+
13
+ ```js
14
+ import { defineConfig } from '@opys/dev';
15
+ import { forge } from '@opys/forge';
16
+ import { curseforge } from '@opys/curseforge';
17
+
18
+ export default defineConfig({
19
+ output: 'opys.json',
20
+ plugins: [
21
+ forge('1.20.1-best'),
22
+ curseforge({
23
+ apiKey: process.env.CURSEFORGE_TOKEN,
24
+ files: [
25
+ 238222, // Just Enough Items
26
+ 'https://curseforge.com/.../files/5847', // JourneyMap
27
+ ],
28
+ }),
29
+ ],
30
+ });
31
+ ```
32
+
33
+ Requires a [CurseForge API key](https://console.curseforge.com/)
34
+ passed as `apiKey` (or via the `CURSEFORGE_TOKEN` env var that the
35
+ opys integration tests use).
36
+
37
+ Part of the [opys](https://github.com/harmoniya-net/opys) toolkit;
38
+ re-exported by [`@opys/minecraft`](https://www.npmjs.com/package/@opys/minecraft).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@opys/curseforge",
3
- "version": "0.1.6",
3
+ "version": "0.1.7",
4
4
  "type": "module",
5
5
  "main": "./dist/index.js",
6
6
  "exports": {
@@ -15,8 +15,8 @@
15
15
  "test": "vitest run tests/unit --passWithNoTests"
16
16
  },
17
17
  "dependencies": {
18
- "@opys/core": "^0.1.6",
19
- "@opys/dev": "^0.1.6"
18
+ "@opys/core": "^0.1.7",
19
+ "@opys/dev": "^0.1.7"
20
20
  },
21
21
  "devDependencies": {
22
22
  "tsdown": "*",