Skip to content

Commit

Permalink
update readme, add screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
edzillion committed Dec 19, 2020
1 parent 9ee482b commit 96902cb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# About Face -- FoundryVTT Module
About Face is a module for FoundryVTT that changes a token's direction based on movement. It also provides optional "facing" indicators for tokens.

![Example](https://github.com/eadorin/about-face/raw/master/AboutFace-Demo.gif)
![Example](https://github.com/League-of-Foundry-Developers/about-face/raw/master/AboutFace-Demo.gif)

## Installation
Simply use the install module screen within the FoundryVTT setup
Expand All @@ -12,15 +12,19 @@ Two options are available in the game settings module config. Otherwise, with ev
- Move your token!
- Hold SHIFT and using your W,A,S,D or ↑,←,↓,→ you can change the direction your token is facing without moving

### Disable for a specific Token
![Token Config Screenshot](https://github.com/League-of-Foundry-Developers/about-face/raw/master/screenshot.png)


## Known Issues / Limitations
- Assumes the token default facing direction is "down". Other artwork may respond differently.
- ~~Assumes the token default facing direction is "down". Other artwork may respond differently.~~
- If a token is not facing down just edit the rotation in Token Config > Image.
- ~~This has only been tested with square grids (not hexes) and uses 45 degree snapping for tokens.~~
- Tokens don't change directions immediately (takes a movement for updateToken to start firing)
- Have experienced an issue where locking a token makes it unusable until refresh
- Direction indicators are created using the other players' colors. Because of the way drawing works, players will need to refresh after connecting in order to see all the colors *BUG
- Unsure if 'facing' state carries from one session to another.
- May need to refresh if redrawing the scene or moving tokens to a new scene. *should be fixed
- ~~Tokens don't change directions immediately (takes a movement for updateToken to start firing)~~
- ~~Have experienced an issue where locking a token makes it unusable until refresh~~
- ~~Direction indicators are created using the other players' colors. Because of the way drawing works, players will need to refresh after connecting in order to see all the colors *BUG~~
- ~~Unsure if 'facing' state carries from one session to another.~~
- ~~May need to refresh if redrawing the scene or moving tokens to a new scene. *should be fixed~~

## Troubleshooting
- Refresh Foundry VTT webpage
Expand All @@ -30,7 +34,7 @@ Two options are available in the game settings module config. Otherwise, with ev


## Upcoming Features
- Support for tokens whose art faces a different direction by default
- ~~Support for tokens whose art faces a different direction by default~~
- Different / Configurable indicators
- Dynamic color-adjusting indicators based on the scene/tile

Expand All @@ -39,6 +43,6 @@ Two options are available in the game settings module config. Otherwise, with ev
Assistance from several Discord users, including @Forien and @Stan. Accepting translations for the few config options.

## License
This Foundry VTT module, writen by Eadorin, is licensed under [GNU GPLv3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), supplemented by [Commons Clause](https://commonsclause.com/).
This Foundry VTT module, writen by Eadorin & edzillion, is licensed under [GNU GPLv3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), supplemented by [Commons Clause](https://commonsclause.com/).

This work is licensed under Foundry Virtual Tabletop [EULA - Limited License Agreement for module development v 0.1.6](http://foundryvtt.com/pages/license.html).
Binary file added screenshot.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 96902cb

Please sign in to comment.