/aos-reminders

Never forget your Age of Sigmar abilities again! Generate helpful in-game reminders tailored to your AoS army.

Primary LanguageTypeScript

Codeship Status for daviseford/aos-reminders

Discord

https://discord.gg/2nt9Fxp

How to Contribute

If you want to add an army or edit an existing army, please do so! Use the src/army/sample_army/ folder as a reference for how things are added!

In particular, you'll want to focus on abilities.ts, artifacts.ts, endless_spells.ts, spells.ts, traits.ts, and units.ts.

Feel free to submit a PR for any incorrect/missing rules! I am only human, and the amount of data entry needed for a single army can sometimes be overwhelming.

Top Contributors

  • daviseford
  • JohnSchramm
    • Added Nurgle
    • Added Hedonites of Slaanesh
    • Added Daughters of Khaine
    • Added Tamurkhan's Horde
    • Added Slaves to Darkness
    • Added Everchosen
    • Updated Khorne
  • thundergore
    • Added Stormcast Eternals
    • Added Fyreslayers
    • Added Endless spells
  • grzegorzmiazga
    • Added Idoneth Deepkin
    • Updated Gloomspite Gitz rules
    • Updated Malign Sorcery artefacts
  • PixelTom
    • Added Dispossessed
    • Added Kharadron Overlords
  • ctcodie
    • Added Legions of Nagash
    • Updated Sylvaneth to 2019 battletome
  • Cpt Asgard
    • Added Nighthaunt
  • Lorax
    • Added Legions of Azgorh
  • T-Nightingale
    • Added Print button

Available Scripts

This project was bootstrapped with Create React App.

In the project directory, you can run:

yarn install

If you just downloaded this repository, or if you are getting errors regarding missing packages, run yarn install to download/update dependencies.

yarn start

Runs the app in the development mode.

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.

You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.

See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.

It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

Learn More about React

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Pre-commit

I have set this repository up to automatically take care of some chores when you push a commit.

  1. Any special punctuation characters such as ‘, ’, “, and ” are removed and replaced with ' or ".
  2. Any leading or trailing whitespace is removed from any name, desc, and tag entries.
  3. Periods are added to the end of descriptions if they are missing.
  4. Finally, we use pretty-quick to format the code according to the repository standards.

Deployment

This repository is automatically deployed using CodeShip.

Whenever a commit is pushed to the master branch, the project is built and uploaded to S3.

This happens automatically, so be careful when merging to master! Your changes will immediately be live.