diff --git a/README.md b/README.md new file mode 100644 index 00000000..1d2dab80 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Daggerheart +#### For Foundry VTT +This is a repo for a Foundry VTT implementation of daggerheart. It is not associated with critical role +or darrington press. + +# Table Of Contents +- [Overview](#overview) +- [Developer Guide](#developer-guide) + +# Overview + +# Developer Guide +#### Setup +- Open a terminal in the directory with the repo `cd //` +- NOTE: The repo should be placed in the system files are or somewhere else and a link (if on linux) is placed in the system directory +- NOTE: Linux link can be made using `ln -snf daggerheart` inside the system folder + +- Install npm `npm install` +- Update package.json to match your profile +``` +"start": "concurrently \"rollup -c --watch\" \"node C:/FoundryDev/resources/app/main.js --dataPath=C:/FoundryDevFiles --noupnp\" \"gulp\"", +"start-test": "node C:/FoundryDev/resources/app/main.js --dataPath=C:/FoundryDevFiles && rollup -c --watch && gulp", + +``` +- Replace `C:/FoundryDev/resources/app/main.js` with `////` +- The main is likely in `/resouces/app/main.js` +- Replace `--dataPath=C:/FoundryDevFiles` with `////` + +Now you should be able to build the app using `npm start` +[Foundry VTT Website][1] + + +[1]: https://foundryvtt.com/