|
1 | | -# Turnmarker-alt |
2 | | -Split branch of Turnmarker after it was no longer actively maintained |
| 1 | +# Turn Marker |
| 2 | +**Turn Marker** is a module for [Foundry VTT](https://foundryvtt.com/ "Foundry VTT") that adds an image under a token who is currently active in the combat tracker. This is completely system agnostic, and fully customizable to fit right into your game. |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +## Installation |
| 9 | +It's always better and easier to install modules through in in app browser. Just search for "Turn Marker" |
| 10 | + |
| 11 | +To install this module manually: |
| 12 | +1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules" |
| 13 | +2. Click "Install Module" |
| 14 | +3. In the "Manifest URL" field, paste the following url: |
| 15 | +`https://raw.githubusercontent.com/kckaiwei/TurnMarker/master/dist/module.json` |
| 16 | +4. Click 'Install' and wait for installation to complete |
| 17 | +5. Don't forget to enable the module in game using the "Manage Module" button |
| 18 | + |
| 19 | +## Usage |
| 20 | +The turn marker will move to the active token on their turn, and move with them as they move: |
| 21 | + |
| 22 | + |
| 23 | +### Settings |
| 24 | +#### Image ratio |
| 25 | +The image ratio is related to the size of the token. 1 will be the same size as the active token, 2 will be double the size, etc. |
| 26 | +#### Animate Marker |
| 27 | +If enabled, the marker will use a rotational animation as defined by "Animation Speed" and "Animation Degrees". |
| 28 | +#### Animation Speed |
| 29 | +Defines in milliseconds how often the animation should apply a rotation. The lower the number the faster the animation. |
| 30 | +#### Animation Degrees |
| 31 | +Defines in degrees how much the marker should rotate on each tick. |
| 32 | +#### Marker Image |
| 33 | +Select from a number of included images provided by the Foundry Community: |
| 34 | + |
| 35 | +Marker images by [Rin](https://foundryvtt.com/community/rin) |
| 36 | + |
| 37 | +|Runes of the Cultist |Runes of Regeneration |Runes of the Cosmos |Runes of Earthly Dust | |
| 38 | +|--|--|--|--| |
| 39 | +|<img src="src/assets/cultist.png" width="150" />|<img src="src/assets/regeneration.png" width="150" />|<img src="src/assets/cosmos.png" width="150" />|<img src="src/assets/earthlydust.png" width="150" />| |
| 40 | + |
| 41 | +|Runes of Reality |Runes of Incendium |Runes of the Believer |Runes of the Mad Mage | |
| 42 | +|--|--|--|--| |
| 43 | +|<img src="src/assets/reality.png" width="150" />|<img src="src/assets/incendium.png" width="150" />|<img src="src/assets/believer.png" width="150" />|<img src="src/assets/madmage.png" width="150" />| |
| 44 | + |
| 45 | +|Runes of the Blue Sky |Runes of the Universe |Runes of Prosperity | |
| 46 | +|--|--|--| |
| 47 | +|<img src="src/assets/bluesky.png" width="150" />|<img src="src/assets/universe.png" width="150" />|<img src="src/assets/prosperity.png" width="150" />| |
| 48 | + |
| 49 | +#### Custom Image Path |
| 50 | +Sets the path to an image to be used instead of the included images |
| 51 | + |
| 52 | +#### Announce Turns |
| 53 | +If enabled, a chat message will be sent when the turn in combat changes (unless the combatant is hidden in the combat tracker). |
| 54 | + |
| 55 | +## Compatibility |
| 56 | +Most recently tested on [Foundry VTT](https://foundryvtt.com/ "Foundry VTT") version 0.6.6. |
| 57 | + |
| 58 | +I've been developing on it on version 0.7.9, but haven't used it enough to deem it stable. |
| 59 | + |
| 60 | +## Feedback |
| 61 | +All feedback and suggestions are welcome. Please contact me on Discord (Brunhine#2182). |
| 62 | + |
| 63 | +Any issues, bugs, or feature requests are always welcome to be reported directly to the [Issue Tracker](https://github.com/kckaiwei/TurnMarker/issues "Issue Tracker") |
| 64 | + |
| 65 | +## Support Development |
| 66 | +Want to help improve the module? Send a pull request. |
| 67 | + |
| 68 | +Want to show support another way? Recommend this module to other users. |
| 69 | + |
| 70 | +### Getting started |
| 71 | + |
| 72 | +`src` is the folder you want to work with. Make sure you have [npm](https://www.npmjs.com/ "NPM") installed. |
| 73 | +Run `npm install` to install `gulp` |
| 74 | + |
| 75 | +When you're done making changes, run `gulp build` to recompile the `dist` folder |
| 76 | + |
| 77 | +## Licensing |
| 78 | +**Turn Msrker** is a module for [Foundry VTT](https://foundryvtt.com/ "Foundry VTT") by Jeremiah Altepeter and is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). |
| 79 | + |
| 80 | +This work is licensed under Foundry Virtual Tabletop [EULA - Limited License Agreement for module development v 0.1.6](https://foundryvtt.com/article/license/). |
| 81 | + |
| 82 | +The included images are created by [Rin](https://foundryvtt.com/community/rin) (rin#0002 on Discord) |
0 commit comments