darkness-dependent-vision/README.md

93 lines
2.2 KiB
Markdown
Raw Normal View History

2021-06-29 05:27:27 +02:00
<!--
SPDX-FileCopyrightText: 2021 Johannes Loher
SPDX-License-Identifier: MIT
-->
# Darkness Dependent Vision
A module for [Foundry Virtual Tabletop] that provides the ability to make the
dim and bright vision of tokens depend on the scene's darkness level.
## Installation
To install and use the Darkness Dependent Vision module for Foundry Virtual
Tabletop, simply paste the following URL into the **Install Module** dialog on
the Setup menu of the application.
https://git.f3l.de/ghost/darkness-dependent-vision/-/raw/latest/src/module.json?inline=false
## Development
### Prerequisites
In order to build this module, recent versions of `node` and `yarn` are
required. Most likely using `npm` also works but only `yarn` is officially
supported. We recommend using the latest lts version of `node`, which is
`v14.17.1` at the time of writing. If you use `nvm` to manage your `node`
versions, you can simply run
```
nvm install
```
in the project's root directory.
You also need to install the the project's dependencies. To do so, run
```
yarn install
```
### Building
You can build the project by running
```
yarn build
```
Alternatively, you can run
```
yarn build:watch
```
to watch for changes and automatically build as necessary.
### Linking the built project to Foundry VTT
In order to provide a fluent development experience, it is recommended to link
the built module to your local Foundry VTT installation's data folder. In
order to do so, first add a file called `foundryconfig.json` to the project root
with the following content:
```
{
"dataPath": "/absolute/path/to/your/FoundryVTT/Data"
}
```
(if you are using Windows, make sure to use `\` as a path separator instead of
`/`)
Then run
```
yarn link-project
```
On Windows, creating symlinks requires administrator privileges so unfortunately
you need to run the above command in an administrator terminal for it to work.
## Licensing
This project is being developed under the terms of the
[LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT] for Foundry Virtual Tabletop.
This project is licensed under [MIT]. To get more detailed information about the
individual copyright holders, check the individual files.
[Foundry Virtual Tabletop]: http://foundryvtt.com
[MIT]: LICENSES/MIT.txt