farming-weight 0.12.2 → 0.12.3

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 +7 -5
  2. package/package.json +6 -5
package/README.md CHANGED
@@ -1,4 +1,5 @@
1
1
  # Farming Weight
2
+
2
3
  NPM package for Farming Weight and fortune calculations in Hypixel SkyBlock.
3
4
 
4
5
  Created specifically for the [EliteWebsite](https://github.com/EliteFarmers/Website) and [EliteBot](https://github.com/EliteFarmers/Bot) projects, but can be used for any project, as long as some credit is given per the license.
@@ -6,6 +7,7 @@ Created specifically for the [EliteWebsite](https://github.com/EliteFarmers/Webs
6
7
  **This is a new package that's changing rapidly, there aren't any comprehensive docs at this time**
7
8
 
8
9
  ## Installation
10
+
9
11
  ```bash
10
12
  npm install farming-weight
11
13
  ```
@@ -46,7 +48,7 @@ calculator.setEarnedMedals({
46
48
 
47
49
  const weight = calculator.getWeightInfo();
48
50
 
49
- console.log(weight.totalWeight);
51
+ console.log(weight.totalWeight);
50
52
  // 10000.53 (or whatever the total weight is)
51
53
 
52
54
  console.log(weight.bonusSources);
@@ -66,10 +68,10 @@ const drops = calculateDetailedAverageDrops({
66
68
  bountiful: true,
67
69
  mooshroom: true,
68
70
  dicerLevel: 3,
69
- blocksBroken: 24000 // 100% efficiency for 20 minutes
71
+ blocksBroken: 24000, // 100% efficiency for 20 minutes
70
72
  });
71
73
 
72
- console.log(drops[Crop.Wheat].collection) // 123000 (or whatever the collection is)
74
+ console.log(drops[Crop.Wheat].collection); // 123000 (or whatever the collection is)
73
75
  ```
74
76
 
75
77
  ### FarmingPlayer Calculator
@@ -78,7 +80,7 @@ The `createFarmingPlayer` function is used to create a `FarmingPlayer` object, w
78
80
 
79
81
  ```ts
80
82
  const options = {
81
- tools: farmingTools // Array of FarmingTool objects, or EliteItemFto objects (not raw NBT data)
83
+ tools: farmingTools // Array of FarmingTool objects, or EliteItemFto objects (not raw NBT data)
82
84
  armor: armorSet // Array of FarmingArmor objects, an ArmorSet object, or EliteItemDto objects
83
85
  equipment: equipment // Array of FarmingEquipment objects, or EliteItemDto objects
84
86
  accessories: accessories // Array of FarmingAccessory objects, or EliteItemDto objects
@@ -99,4 +101,4 @@ const calculator = calculateDetailedAverageDrops({
99
101
  dicerLevel: player.selectedTool?.item.skyblockId?.match(/DICER_(\d+)/)?.[1] ?? 3) as 1 | 2 | 3,
100
102
  blocksBroken: blocksBroken,
101
103
  });
102
- ```
104
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "farming-weight",
3
- "version": "0.12.2",
3
+ "version": "0.12.3",
4
4
  "description": "Tools for calculating farming weight and fortune in Hypixel Skyblock",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -8,6 +8,7 @@
8
8
  "module": "dist/index.js",
9
9
  "scripts": {
10
10
  "build": "tsc",
11
+ "build:watch": "tsc --watch",
11
12
  "format": "pnpm biome check --write",
12
13
  "lint": "pnpm biome check",
13
14
  "test": "vitest run",
@@ -25,19 +26,19 @@
25
26
  ],
26
27
  "repository": {
27
28
  "type": "git",
28
- "url": "git+https://github.com/EliteFarmers/FarmingWeight.git"
29
+ "url": "git+https://github.com/EliteFarmers/Website.git"
29
30
  },
30
31
  "files": [
31
32
  "dist/**/*"
32
33
  ],
33
34
  "bugs": {
34
- "url": "https://github.com/EliteFarmers/FarmingWeight/issues"
35
+ "url": "https://github.com/EliteFarmers/Website/issues"
35
36
  },
36
37
  "publishConfig": {
37
38
  "registry": "https://registry.npmjs.org/",
38
39
  "access": "public"
39
40
  },
40
- "homepage": "https://github.com/EliteFarmers/FarmingWeight#readme",
41
+ "homepage": "https://github.com/EliteFarmers/Website#readme",
41
42
  "author": "Kaeso",
42
43
  "license": "MIT",
43
44
  "devDependencies": {
@@ -48,4 +49,4 @@
48
49
  "vitest": "^4.0.16"
49
50
  },
50
51
  "packageManager": "pnpm@9.15.0"
51
- }
52
+ }