Gives all players the option to show a customizable cursor on demand, as well as ping any location with a custom ping! Hotkeys, pings, pointer, everything customizable! As GM you can also move your players view to your pin on demand.
WHY THIS MODULE IS IN BETA ? Don't get too excited, I just took the module maintenance and did some minor bug fixing, the module requires considerable rewriting especially with the new API of v12
There is a open commission on the Discord League Server for anyone interested on help to save this module from the void.
It's always easiest to install modules from the in game add-on browser.
To install this module manually:
- Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
- Click "Install Module"
- In the "Manifest URL" field, paste the following url:
https://raw.githubusercontent.com/p4535992/foundryvtt-pointer/master/src/module.json - Click 'Install' and wait for installation to complete
- Don't forget to enable the module in game using the "Manage Module" button
Press buttons, stuff happens! Press a button and a pointer will follow your mouse, while the button is pressed. Press another button and a stationary ping will appear at your cursors position, which will disappear after some time. As GM you can even press another different button and a stationary ping will appear and every players view will get moved to that ping!
The pointer, pings and buttons are customizable using the settings menu. Here you can choose different images, or videos and apply some basic transformations as well as animations to them. To make setup easier for players the GM can decide to force his settings onto all players! (This will not stop them from changing those afterwards.)
GM View of the design studio (1). 2. Here you can which custom pointer you want to use as pointer or as ping. Just click on one of the checkboxes. The GM can also create new custom pointer or delete any existing. 3. A small preview of your custom pointer. the red X in the center is the location of your mouse pointer when displaying the pointer on the canvas. This view help to properly position your chosen image relative to your mouse pointer. Clicking on the canvas lets you also choose the image or video file used for the custom pointer. You can choose of all file types compatible with core FVTTs canvas. 4. Configuration panel for your pointer. Configure some basic transformations, like position, rotation and add some animations.
Due to core FVTT limitations it is currently only possible for users allowed to edit world settings to create and delete custom pointer. (Screenshot below)
Beware that this allows them to edit most FVTT settings. It is up to you, the GM, whether you trust your players with that much power!
## Important Information : Maintenance Mode
This repository is no longer receiving active attention. In my opinion this module is complete and stable, and i'll be focusing my efforts on other modules/stuff. PR's are welcome and i'll try to investigate bugs and keep this module up to date with Foundry, when i find the time to do so.
That said, feel free to keep suggesting features, if i find something interesting i may end up implementing it.
npm installdev will let you develop you own code with hot reloading on the browser
npm run devbuild will build and set up a symlink between dist and your dataPath.
npm run buildbuild-watch will build and watch for changes, rebuilding automatically.
npm run build-watchprettier-format launch the prettier plugin based on the configuration here
npm run-script prettier-formatlint launch the eslint process based on the configuration here
npm run-script lintlint:fix launch the eslint process with the fix argument
npm run-script lint:fixAny issues, bugs, or feature requests are always welcome to be reported directly to the Issue Tracker, or using the Bug Reporter Module.
- The images used are from www.game-icons.net, all licensed under CC BY 3.0:
- Pointer (MIT)
- Pointer (fork farling42) (MIT)
This package is under an MIT and the Foundry Virtual Tabletop Limited License Agreement for module development.
- Thank you to Moerill for the module Pointer original project
- Thank you to farling42 for the module Pointer (fork farling42) for bug fix v11
The arrow pointer made by Iga from the Noun Project and modified by ayan and me for compatibility. The Focus was made by Creative Stall from the Noun Project. Both are licensed under Creative Commons.
The following items are from www.game-icons.net, all licensed under CC BY 3.0:
- Pin
- Triangle
- Plain Arrow
- Convergence Target All were slightly modified to fully fill their square and width/height attributes were added so they're compatible with FVTT as SVG.