Skip to content

Commit

Permalink
readme and manifest done
Browse files Browse the repository at this point in the history
  • Loading branch information
paulo-roger committed Sep 23, 2022
1 parent fd44b26 commit 3664550
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 6 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,48 @@

# Flying Tokens

Ever wanted your tokens to fly? I mean really look like they're flying, when they are supposed to, well you should try Flying Tokens.
Flying Tokens works with Token Magic FX API to add shadow and movement that simulates the flight.

## Functions

With the **Automatic Apply** enabled you just have to change the token elevation and it will do all the magic. The module first check if the character has flight movement, otherwise it won't apply the effect.
When you change the elevation to 0 the token will land.

If you opt to disable the automatic effect and prefer to enable per token you just have to disable **Automatic Apply** in the settings and now all tokens with flying speed movement will have a dove icon in the token HUD, if you click on it, it activates ***Flying Tokens*** for that specific token and then when you change its elevation the effects will apply.

#### First click the dove icon to activate *Flying Tokens* for that token and then set a new elevation
![functions1](readme/functions1.png)

#### If you want to disable just click the dove slashed icon and it will remove the filter effects, then you can change the elevation and it won't apply effects anymore.
![functions2](readme/functions2.png)

## Settings
**Automatic Apply**
*Default: active.*
This setting if checked will apply ***Flying Tokens*** effects to all tokens that have flying speed movement and you change its elevation.

**Output to chat**
*Default: active.*
Display a chat message with the token name and its new elevation.

![settings](readme/settings.png)

## Dependencies
- [Token Magic FX](https://foundryvtt.com/packages/tokenmagic)

## Known Issues
So far none.

## Feedback
You can create an issue here: [Issues](../../issues)
If you have suggestions or want to report a problem, you can create an issue here: [Issues](../../issues)

## Changelog
### 1.0.0
- Intial release

## Special Thanks
`Peterson`, ``Zhell``, ``MisterHims``
`Peterson` and ``Zhell``

## Donations
The module is totally free and will remain this way.
Expand All @@ -29,3 +54,4 @@ I am unemployed, though. So every little help counts.
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/winterwulf)

## Attributions
--
15 changes: 11 additions & 4 deletions module.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "flying-tokens",
"title": "Flying Tokens",
"description": "",
"version": "1.0.0",
"version": "This is auto replaced",
"library": "false",
"manifestPlusVersion": "1.2.0",
"minimumCoreVersion": "9",
Expand All @@ -17,12 +17,19 @@
"name": "winterwulf",
"url": "https://github.com/paulo-roger/",
"discord": "winterwulf#3118",
"ko-fi": "winterwulf"
"ko-fi": "winterwulf",
"twitter": "@vvinterwulf"
}
],
"relationships": {
"systems": [],
"requires": []
"requires": [
{
"id": "tokenmagic",
"type": "module",
"compatibility": {}
}
]
},
"esmodules": [
"scripts/flying-tokens.js"
Expand Down Expand Up @@ -56,4 +63,4 @@
"url": "https://raw.githubusercontent.com/paulo-roger/weatherfx/master/readme/cover.png"
}
]
}
}
Binary file added readme/functions1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/functions2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3664550

Please sign in to comment.