mirror of
https://github.com/Foundryborne/daggerheart.git
synced 2026-01-15 13:11:08 +01:00
Merge pull request #14 from Foundryborne/wojo/basic-readme
Wojo/basic readme
This commit is contained in:
commit
887c85f224
1 changed files with 33 additions and 0 deletions
33
README.md
Normal file
33
README.md
Normal file
|
|
@ -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 <path>/<to>/<repo>`
|
||||||
|
- 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 <path to development folder> 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 `<your>/<path>/<to>/<foundry>/<main.js>`
|
||||||
|
- The main is likely in `<Foundry Install Location>/resouces/app/main.js`
|
||||||
|
- Replace `--dataPath=C:/FoundryDevFiles` with `<your>/<path>/<to>/<foundry>/<data>`
|
||||||
|
|
||||||
|
Now you should be able to build the app using `npm start`
|
||||||
|
[Foundry VTT Website][1]
|
||||||
|
|
||||||
|
|
||||||
|
[1]: https://foundryvtt.com/
|
||||||
Loading…
Add table
Add a link
Reference in a new issue