Skip to content

sansarip/nw-calculator

Repository files navigation

New World Crafting Calculator

Web app for calculating item crafting ingredients in New World.

View it at newworldcraft.io.

Data scraped from nwdb.info 🙇

PRs are welcome! You can find me for collaboration here on Discord.

Current State of the App

For simplicity's sake, all item data is in the items.json file. If you notice an issue, then you should drop a <date>-<description>.patch.json file in the the resources/data dir containing your desired changes. If your changes include adding/editing an image url of an item, then you must also put a corresponding 128x128 image in the images directory. Once your patch file is ready, then you can run make patch-data in order to patch the items.json file with your changes. You'll need Babashka installed before running the aforementioned Make command.

Dev

Get a no-strings-attached dev environment with Gitpod 💥 (it may take a while to build initially) or read the info below to set up your dev environment locally.

Prerequisites

Web App

Run the web application (figwheel-main) server with the following command:

lein fig:dev

After some time, you should be able to browse to http://localhost:9500 to view the main app and http://localhost:9500/devcards.html to view the devcards.

Scraper

The scraper graciously pulls data from nwdb.info in a single-threaded, throttled fashion. The following command will download item data and item images.

lein scrape or make scrape

If you only want item data then run make scrape-data, and if you only want item images then run make scrape-images.

Afterwards, you can patch known data discrepancies with make patch-data which will output the finalized resources/public/data/items.json file. make patch will look at the patch files in resources/data/ in order to know what to patch.

Prod

If you wish to create a release, you'll need the same prerequites as Dev installed. You'll want to also make sure you have the following tools installed:

To compile the Prod JS, run lein fig:prod.

Or, you can just run make release which will compile Prod JS, overwrite build/ (this is where the site's content is built from), bump the version, prompt for a CHANGELOG update, and commit the release.

License

Copyright © 2021 sansarip

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.