saluu/darkness-dependent-vision
0
0
Fork 0
Code Issues 1 Pull requests 4 Projects Releases 18 Packages 1 Activity

docs: improve the readme

Browse source
This commit is contained in:
Johannes Loher 2021-11-05 20:53:25 +01:00
parent 3a9c8b5e3e
commit b1b8a81d9a
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -20,7 +20,7 @@ https://git.f3l.de/ghost/darkness-dependent-vision/-/raw/latest/src/module.json?
### libWrapper ### libWrapper
This module uses the [libWrapper] library for wrapping core methods. It is only This module uses the [libWrapper] library for wrapping core methods. It is only
a soft dependency (a shim is provided) but it is highly recommended to install a soft dependency (a shim is provided) but it is highly recommended installing
libWrapper as a module for the best experience and compatibility with other libWrapper as a module for the best experience and compatibility with other
modules. modules.
@ -35,7 +35,7 @@ Token Configuration:
[![Usage 2](img/usage_2.png)](img/usage_2.png) [![Usage 2](img/usage_2.png)](img/usage_2.png)
In the next image, you can see an example of the module in action: The token is In the next image, you can see an example of the module in action: The token is
configured to only have bright vision at a darkness level between 0 and 0.5 but configured to only have bright vision at a darkness level between 0 and 0.5, but
the scene's darkness level is set to 0.6, so the token has no bright vision. On the scene's darkness level is set to 0.6, so the token has no bright vision. On
the other hand, the token is also configured to have dim vision at a darkness the other hand, the token is also configured to have dim vision at a darkness
level between 0 and 0.7, so it _does_ have dim vision. level between 0 and 0.7, so it _does_ have dim vision.
@ -48,9 +48,8 @@ level between 0 and 0.7, so it _does_ have dim vision.
In order to build this module, recent versions of `node` and `yarn` are 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 required. Most likely using `npm` also works but only `yarn` is officially
supported. We recommend using the latest lts version of `node`, which is supported. We recommend using the latest lts version of `node`. If you use `nvm`
`v14.17.1` at the time of writing. If you use `nvm` to manage your `node` to manage your `node` versions, you can simply run
versions, you can simply run
``` ```
nvm install nvm install
@ -58,7 +57,7 @@ nvm install
in the project's root directory. in the project's root directory.
You also need to install the the project's dependencies. To do so, run You also need to install the project's dependencies. To do so, run
``` ```
yarn install yarn install
@ -102,8 +101,9 @@ Then run
yarn link-project yarn link-project
``` ```
On Windows, creating symlinks requires administrator privileges so unfortunately On Windows, creating symlinks requires administrator privileges, so
you need to run the above command in an administrator terminal for it to work. unfortunately you need to run the above command in an administrator terminal for
it to work.
## Licensing ## Licensing