AntoineThebaud / swlcalc

Gear planner for Secret World Legends

Home Page:https://antoinethebaud.github.io/swlcalc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

swlcalc

swlcalc is a fan-made gear planner for Secret World Legends (SWL), a MMORPG by Funcom. It can be used to plan your gear progression, to visualize the stats you will reach with a given gear and also to share and show others what gear you use to tackle encounters in PvE or PvP.

swlcalc can be found at : http://AntoineThebaud.github.io/swlcalc

Some features yet to be released can be found in the swlcalc features board. Feel free to drop suggestions in the issues !

Contributing

Disclaimer

swlcalc is in maintenance mode for quite some time now. There are still features & improvements that could be considered, but the main functionalities are long implemented. For sure this is also due to the fact that SWL didn't get any major update since Sept 2020.

swlcalc code & the technologies it relies on are quite old fashioned and no longer in line with modern Javascript standards. Actually this has always been the case from the beginning of the project, as this was already true for tswcalc. The goal when building swlcalc at the time was indeed to quickly come up with a working app, hence this choice. Thus be aware if you ever come around here and would like to contribute. Despite this be assured that contributions are still welcome :)

General

Pull requests are welcome! All active development of swlcalc takes place in the develop branch. The tip of master always points to the latest, stable release. All releases are tagged. The latest release is deployed to the gh-pages branch.

Contributions can also be bug reports, feature requests and other feedback !

Prerequisites

First, download and install Node.js.

Then install grunt globally :

npm install -g grunt-cli

Building

Fetch the source code (if you have added a SSH key to github) :

git clone git@github.com:AntoineThebaud/swlcalc.git

Alternatively :

git clone https://github.com/AntoineThebaud/swlcalc.git

Install swlcalc dependencies, defined in package.json :

npm install

Build swlcalc by running :

grunt

Run tests :

grunt test

Tests can be found in the test folder. Open the html file to run tests in the browser. Open the js file to view the test logic.

When developing, use:

grunt watch

The previous command monitors changes to files in the src folder. If any changes are detected, the build task is run.

Open build/index.html to view.

Distribution

To create a distribution in the dist folder :

grunt dist

Open dist/index.html to view.

To create a zip-archive distribution:

grunt package

License

MIT License for the source code. Please see the LICENSE file.

All art assets included in public/assets/images/icons/ should be considered property of Funcom GmBH unless otherwise noted. A small sample of signet, glyph and equipment icons are redistributed under fair use.

Acknowledgements

swlcalc was built from tswcalc, a gear planner designed for The Secret World (TSW). Thanks to Joakibj and all the contributors of this project that made possible to create a gear planner for Secret World Legends without starting from scratch.

About

Gear planner for Secret World Legends

https://antoinethebaud.github.io/swlcalc

License:MIT License


Languages

Language:JavaScript 93.2%Language:HTML 3.9%Language:CSS 2.8%