This readme provides information on installing and running quartersbrief and contributing to its development. To find out more about what quartersbrief is and how to use it, go to [https://quartersbrief.github.io].

This project is intended as an information tool for the popular video game World of Warships. While the game is easy enough to get started on, playing it well requires knowing a vast amount of information about ships' capabilities, quirks and technical data. Quartersbrief provides that information, restricted to that which is actually pertinent to the current battle, saving you the trouble of having to memorize half of the World of Warships wiki.

The easiest way to install is through the .deb package provided with each release. Provided you already have added i386 as a foreign architecture, and NodeJS is available in your package repositories in version 17 or higher, all you need to do is run

sudo apt install ~/Downloads/quartersbrief_<x.y.z>_amd64.deb

replacing x.y.z with the version you downloaded.

To add i386 as a foreign architecture, run:

sudo dpkg --add-architecture i386 && sudo apt update

before installing.

NodeJS is available in the distro repositories, but usually in a version that is quite old. A newer PPA is maintained among others at nodesource. To use it, run:

curl -fsSL https://deb.nodesource.com/setup_17.x | sudo -E bash -

The easiest way to install on Windows is through the installer provided with each release. Make sure that NodeJS is installed.

Quartersbrief depends on wine to perform automatic updates of its data whenever the game updates. Unfortunately, this makes the disk footprint quite large. If you don't want this, you can install from source and disable automatic updates.

Download the source of the release and unzip it. Then run npm install --omit=dev --no-package-lock. After that, run quartersbrief with the --allow-updates=no option.

Fairly current game data can be downloaded from the World of Warships Fitting Tool repository. Usually game updates are reflected here within a few days. Save these files to ~/.local/share/quartersbrief.

You need to have NodeJS 17 or newer installed. Download and unzip the source of the release, then run npm install --omit=dev --no-package-lock.

Run quartersbrief --wowsdir <path/to/game>, replacing <path/to/game> with the path to your World of Warships installation directory. To avoid having to pass this at every start, it can be set in quartersbrief.json.

After starting quartersbrief, direct your browser to localhost:10000.

git clone [email protected]:BadIdeaException/quartersbrief.git
npm install

This project is intended to be run inside a Vagrant virtual machine to ensure a consistent, easily reproducable and readily replacable environment for tests and tryouts. To start this virtual machine, after cloning, run

vagrant up

When the vagrant virtual machine is provisioned, it will create some scripts in /home/vagrant/.local/bin. This will expose the following commands for convenience:

• npm start as quartersbrief
• npm test as tests (notice the extra s, to avoid conflict with the Linux test command)
• npm run debug|debug-local|debug-test|debug-local-test as their respective script names

E.g. to debug locally, you can simply run debug-local-test from anywhere.

npm test

Some tests hit the actual live online Wargaming API. These require an API key. This can be provided in three ways:

1. By setting it in the environment variable WG_APPLICATION_ID.
2. By passing it as an argument using --application_id. (Note: When using npm, you need to add a double hyphen -- before this option, e.g. npm test -- --application_id=12345.)
3. By putting it in a file called wg-application-id.secret in the project's root folder. *.secret files are listed in .gitignore, so this is safe to do.

See Wargaming.net Developer's Guide on how to get an application id.

Run node src/quartersbrief.js (or the convenience script quartersbrief) to start the server, then navigate your browser to localhost:10000. The virtual machine exposes this port, so you can do it from the host.

With the development configuration, quartersbrief looks for World of Warhips in the folder /opt/World_of_Warships on the virtual machine. (Notice the underscores because of this bug.) You can create a folder called dev/wows on the project's root folder, and it will get shared to that location. By putting a tempArenaInfo.json in a subfolder called replays, you can simulate a running battle. (The game generates this file whenever a battle is started and deletes it when the battle ends, so you can just copy it during the battle.)

The virtual machine exposes port 9229 to enable remote debugging from a graphical debugger. Run

npm run debug

(or npm run debug-test for debugging the tests).

There are also commands for using the built-in Node.js debugger. Append -local to debug for this, i.e. npm run debug-local or npm run debug-local-test.

This project uses release-it for handling releases. Simply run release-it from inside the Vagrant VM and follow the on-screen instructions.

I am developing this project as a one-man show at the moment. If you have suggestions, feedback, or want to contribute, reach out through the issues. Pull requests are welcome, but expected to be fully tested and (obviously) passing.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.