{"_id":"@bitress/animal-crossing","_rev":"2-4c253c6356720de16851580eef6377c3","name":"@bitress/animal-crossing","dist-tags":{"latest":"8.2.1"},"versions":{"8.2.0":{"name":"@bitress/animal-crossing","version":"8.2.0","keywords":["Animal Crossing"],"author":{"name":"bitress"},"license":"MIT","_id":"@bitress/animal-crossing@8.2.0","maintainers":[{"name":"byteress","email":"cyannejustinvega@protonmail.com"}],"homepage":"https://github.com/bitress/animal-crossing#readme","bugs":{"url":"https://github.com/bitress/animal-crossing/issues"},"dist":{"shasum":"f9b094414facd6a8f35e3c872889c27905fe1f6b","tarball":"https://registry.npmjs.org/@bitress/animal-crossing/-/animal-crossing-8.2.0.tgz","fileCount":35,"integrity":"sha512-oJshyzhzFigHKQHS4Q1y1kh1uVh6p2oOX6eBjIljpSXQX0Ixzojv8oDUDJw0okm4ruKO7fi4Niz/HMjaDy23Fg==","signatures":[{"sig":"MEUCIQC7SvFlQ/xHLjSORUBi6t69zk6w0weLahXBOiLezn7xMQIgM+2LXdqRKy8sYZPLKy8sfcDVFheryh35+cjXTeLK80Q=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":43009393},"main":"lib/index.js","types":"lib/index.d.ts","gitHead":"c71b3548b466ddb7e310ea6cae48c8b8571dcd8c","scripts":{"start":"npm run build:src && rimraf ./json/combined ./json/data ./json/raw && node ./build/index.js","bundle":"node ./bin/bundle.js","publish":"git push --follow-tags origin main && npm publish","build:src":"tsc","build:docs":"npm run build:src && /bin/rm -rf ./module/docs; ./node_modules/typedoc/bin/typedoc --githubPages false --tsconfig module/tsconfig.json --out ./module/docs module/index.ts","build:types":"bash ./bin/types.sh","build:minify":"bash ./bin/minify.sh","build:module":"npm run build:src && npm run start && /bin/rm -rf ./module/data &>/dev/null && npm run build:minify && npm run build:types && npm run build:module-src && npm run build:docs","build:single":"node ./bin/bundle.js","publish:major":"./node_modules/standard-version/bin/cli.js --release-as major && npm run publish","publish:minor":"./node_modules/standard-version/bin/cli.js --release-as minor && npm run publish","publish:patch":"./node_modules/standard-version/bin/cli.js --release-as patch && npm run publish","build:module-src":"tsc --outDir lib -p module"},"_npmUser":{"name":"byteress","email":"cyannejustinvega@protonmail.com"},"repository":{"url":"git+https://github.com/bitress/animal-crossing.git","type":"git"},"_npmVersion":"11.11.0","description":"A database for Animal Crossing: New Horizons.","directories":{},"_nodeVersion":"24.14.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^7.32.0","lodash":"^4.17.21","rimraf":"^5.0.0","typedoc":"^0.22.10","prettier":"^2.5.1","@types/ws":"^8.2.1","quicktype":"^15.0.260","typescript":"^4.5.2","@types/node":"^16.11.11","@types/lodash":"^4.14.177","app-root-path":"^3.0.0","json-beautify":"^1.1.1","@norviah/sheets":"^4.2.0","standard-version":"^9.3.2","@types/app-root-path":"^1.2.4","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","typedoc-plugin-markdown":"3.11.7","@typescript-eslint/parser":"^5.5.0","typedoc-plugin-missing-exports":"^0.22.6","@typescript-eslint/eslint-plugin":"^5.5.0"},"_npmOperationalInternal":{"tmp":"tmp/animal-crossing_8.2.0_1787676839399_0.36637905130375215","host":"s3://npm-registry-packages-npm-production"}},"8.2.1":{"name":"@bitress/animal-crossing","version":"8.2.1","description":"A database for Animal Crossing: New Horizons.","main":"lib/index.js","types":"lib/index.d.ts","publishConfig":{"access":"public"},"scripts":{"build:src":"tsc","build:minify":"bash ./bin/minify.sh","build:types":"bash ./bin/types.sh","build:docs":"npm run build:src && /bin/rm -rf ./module/docs; ./node_modules/typedoc/bin/typedoc --githubPages false --tsconfig module/tsconfig.json --out ./module/docs module/index.ts","build:module-src":"tsc --outDir lib -p module","build:module":"npm run build:src && npm run start && /bin/rm -rf ./module/data &>/dev/null && npm run build:minify && npm run build:types && npm run build:module-src && npm run build:docs","publish:patch":"./node_modules/standard-version/bin/cli.js --release-as patch && npm run publish","publish:minor":"./node_modules/standard-version/bin/cli.js --release-as minor && npm run publish","publish:major":"./node_modules/standard-version/bin/cli.js --release-as major && npm run publish","publish":"git push --follow-tags origin main && npm publish","bundle":"node ./bin/bundle.js","build:single":"node ./bin/bundle.js","start":"npm run build:src && rimraf ./json/combined ./json/data ./json/raw && node ./build/index.js"},"repository":{"type":"git","url":"git+https://github.com/bitress/animal-crossing.git"},"keywords":["Animal Crossing"],"author":{"name":"bitress"},"license":"MIT","bugs":{"url":"https://github.com/bitress/animal-crossing/issues"},"homepage":"https://github.com/bitress/animal-crossing#readme","devDependencies":{"@norviah/sheets":"^4.2.0","@types/app-root-path":"^1.2.4","@types/lodash":"^4.14.177","@types/node":"^16.11.11","@types/ws":"^8.2.1","@typescript-eslint/eslint-plugin":"^5.5.0","@typescript-eslint/parser":"^5.5.0","app-root-path":"^3.0.0","eslint":"^7.32.0","eslint-config-prettier":"^8.3.0","eslint-plugin-prettier":"^4.0.0","json-beautify":"^1.1.1","lodash":"^4.17.21","prettier":"^2.5.1","quicktype":"^15.0.260","standard-version":"^9.3.2","typedoc":"^0.22.10","typedoc-plugin-markdown":"3.11.7","typedoc-plugin-missing-exports":"^0.22.6","rimraf":"^5.0.0","typescript":"^4.5.2"},"gitHead":"873fadf90b0baa59d011fa907abd359eb62c5788","_id":"@bitress/animal-crossing@8.2.1","_nodeVersion":"24.14.1","_npmVersion":"11.11.0","dist":{"integrity":"sha512-Uaf989tP1y9oGjuauQBf688+R9DvTSp1NrB37rCvmgwimfmvKEaCz4TKhcP7rItQjtPuUPmX92XhSKMP6vzuXQ==","shasum":"ae7e0e6f5dcdd09e35858e6a58ce2503a6fe7693","tarball":"https://registry.npmjs.org/@bitress/animal-crossing/-/animal-crossing-8.2.1.tgz","fileCount":35,"unpackedSize":43009393,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIB+H7a73HN1ynAJUkJlWXqKFAPsh58uNEYCWhMSh58pkAiBMCRcEdKuAx4ujIUIZ9w+cP1M6V69XcIiz/QzyeJHxGg=="}]},"_npmUser":{"name":"byteress","email":"cyannejustinvega@protonmail.com"},"directories":{},"maintainers":[{"name":"byteress","email":"cyannejustinvega@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/animal-crossing_8.2.1_1787677836539_0.639972089269462"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-25T16:53:59.245Z","modified":"2026-08-25T17:10:37.044Z","8.2.0":"2026-08-25T16:53:59.664Z","8.2.1":"2026-08-25T17:10:36.815Z"},"bugs":{"url":"https://github.com/bitress/animal-crossing/issues"},"author":{"name":"bitress"},"license":"MIT","homepage":"https://github.com/bitress/animal-crossing#readme","keywords":["Animal Crossing"],"repository":{"type":"git","url":"git+https://github.com/bitress/animal-crossing.git"},"description":"A database for Animal Crossing: New Horizons.","maintainers":[{"name":"byteress","email":"cyannejustinvega@protonmail.com"}],"readme":"## animal-crossing\r\n\r\nAn Animal Crossing: New Horizons database for npm, the data available through this module is made from various public Google Spreadsheets for Animal Crossing: New Horizons, which is referenced below.\r\n\r\nIn addition to the spreadsheets converted to JSON, the data have been sanitized and modified so working with them can be more friendly and easier, for example, recipes and translations have been merged into their relevant item.\r\n\r\nIf you're just looking for the JSON files, they can be viewed in [this directory](https://github.com/chopaeng/animal-crossing/tree/main/json). For a guide on how to run the converter locally, look at this [README](https://github.com/chopaeng/animal-crossing/blob/main/CONVERT.md).\r\n\r\n### Installation\r\n\r\n```\r\nnpm install animal-crossing\r\n```\r\n\r\n### Documentation\r\n\r\nDocumentation is generated using [typedoc](https://www.npmjs.com/package/typedoc) with the [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) plugin, and can be viewed [here](https://github.com/chopaeng/animal-crossing/tree/main/module/docs).\r\n\r\n### Usage\r\n\r\nThe following items are available from this module:\r\n  - `achievements`\r\n  - `construction`\r\n  - `creatures`\r\n  - `items`\r\n  - `reactions`\r\n  - `recipes`\r\n  - `seasonsAndEvents`\r\n  - `translations`\r\n  - `villagers`\r\n  - `npcs`\r\n\r\nAlong with types, for those using TypeScript:\r\n  - `IAchievement`\r\n  - `IConstruction`\r\n  - `ICreature`\r\n  - `IEvent`\r\n  - `IItem`\r\n  - `IReaction`\r\n  - `IRecipe`\r\n  - `ISeasonsAndEvents`\r\n  - `ITranslation`\r\n  - `IVillager`\r\n  - `INPC`\r\n\r\nThe names of all items are changed into camelCase, so they won't be same as shown on the spreadsheets. As for values, they're all changed in favor of JavaScript values, for example, `NA` is changed to `null`, `Yes`/`No` is changed to `true`/`false`, etc. If a value represents that the key does not relate to the item, an example being the key `Lighting Type` for the item `Acoustic Guitar`, the value will be changed to `null`. In addition, if a key can have multiple values, the values will be split and changed into an array.\r\n\r\nAs for the rest of the values, they're the same as they appear on the spreadsheets. To view how the keys/values are represented, you can look at the [documentation](https://github.com/chopaeng/animal-crossing/tree/main/module/docs) or the JSON files [here](https://github.com/chopaeng/animal-crossing/tree/main/json).\r\n\r\nNote that all entries are arrays, so to find a certain item, you can use the `find` method.\r\n\r\n```javascript\r\n// Node.js\r\nconst { villagers } = require('animal-crossing');\r\n\r\n// TypeScript\r\nimport { villagers } from 'animal-crossing';\r\n\r\nconst freya = villagers.find(villager => villager.name === 'Freya');\r\n\r\n// Once you have found the item you're looking for, you can view\r\n// information for said item. For villagers, for example, some\r\n// properties you can view are translations of their name and catchphrase.\r\n\r\nconsole.log(freya.translations.uSes); // Freya's name translated to Spanish,\r\nconsole.log(freya.catchphrases.uSes); // and her catchphrase translated as well.\r\n\r\n// To view the properties of all items, take a look at the documentation or the JSON files itself.\r\n```\r\n\r\n### Credit/Thanks\r\n\r\nThe spreadsheets that were converted and is available through this module are:\r\n  - the [Animal Crossing: New Horizons](https://docs.google.com/spreadsheets/d/1mo7myqHry5r_TKvakvIhHbcEAEQpSiNoNQoIS8sMpvM/edit#gid=1397507627) spreadsheet, specifically the editor's copy, and\r\n  - the [Translations](https://docs.google.com/spreadsheets/d/1MMbsvDfu59OY9YBEAfHhFJ6O8vRTllNFgMrX7RBZuyI/edit#gid=1859660274) spreadsheet.\r\n\r\nIf you use any JSON file and/or this module for a project, please credit and link these spreadsheets somewhere in your project.\r\n\r\nAnd thanks to the [acdb-team](https://github.com/acdb-team), as I took inspiration from their repo, [google-sheets-to-json](https://github.com/acdb-team/google-sheets-to-json).\r\n","readmeFilename":"README.md"}