Skip to content

Token Stack Selector is a modern module for Foundry VTT that solves the problem of stacked (overlapping) tokens. When multiple tokens occupy the same position on the grid, this module adds an elegant and intuitive interface to easily select the desired token.

License

Notifications You must be signed in to change notification settings

Sub-Dev/token-stack-selector

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

12 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Token Stack Selector

Token Stack Selector Demo

Foundry VTT Version License

๐Ÿ‡ง๐Ÿ‡ท Portuguese speakers: Check out README.pt-BR.md for the Portuguese version.

๐Ÿ“‹ Description

Token Stack Selector is a modern module for Foundry VTT that solves the problem of stacked (overlapping) tokens. When multiple tokens occupy the same position on the grid, this module adds an elegant and intuitive interface to easily select the desired token.

โœจ Features

๐ŸŽฏ Modern Interface

  • Premium Design: Interface similar to Foundry's native condition panel
  • Unique Icon: Visual combination of user group + crosshairs for quick identification
  • Smooth Animations: Elegant transitions and visual feedback
  • Visual Counter: Badge showing how many tokens are stacked

๐Ÿ–ฑ๏ธ Advanced Features

  • Hover Preview: Shows stacked tokens when hovering over them (800ms delay)
  • Smart Selection: Selected token automatically comes to front
  • Detailed Information: Shows name, actor type and HP when available
  • Smart Positioning: Panel automatically adjusts to not go off screen
  • Multiple Ways to Close: Click outside, ESC or automatic selection

๐Ÿ”ง User Experience

  • Correct Drag & Drop: Selected token can be moved immediately
  • Visual Feedback: Notifications confirming actions
  • Automatic Restoration: Z-index returns to normal after deselection
  • Custom Scrollbar: Design consistent with Foundry theme

๐Ÿš€ Installation

Method 1: Automatic Installation

  1. Open Foundry VTT
  2. Go to Setup โ†’ Add-on Modules
  3. Click Install Module
  4. Paste this manifest: https://github.com/Sub-Dev/token-stack-selector/releases/latest/download/module.json
  5. Click Install

Method 2: Manual Installation

  1. Download the ZIP file from the latest release
  2. Extract to your Foundry VTT Data/modules/ folder
  3. Restart Foundry VTT
  4. Enable the module in the desired world

๐ŸŽฎ How to Use

  1. Hover Preview: Simply hover your mouse over stacked tokens to see a preview of all tokens (appears after 800ms)
  2. Stacked Tokens: When two or more tokens occupy the same position, the button automatically appears in the Token HUD
  3. Open Selector: Click the button with crosshairs + user group icon
  4. Choose Token: Click the desired token in the panel that appears
  5. Interact: The selected token automatically comes to front and can be moved normally

๐Ÿ–ผ๏ธ Screenshots

๐ŸŽฌ Demo in Action

Token Stack Selector Demo

Complete workflow: hover preview โ†’ HUD button โ†’ selection panel โ†’ token selection


๐Ÿ–ฑ๏ธ Hover Preview

Hover Preview

Modern preview showing stacked tokens when hovering (800ms delay)


๐ŸŽฏ Selection Panel

Selection Panel

Elegant selection interface with token details and smart positioning


๐Ÿ“š Token Menu

Token Menu

Complete interface showing all module features in action

๐Ÿ”ง Compatibility

  • Foundry VTT: v11 - v13
  • Systems: Compatible with all systems
  • Modules: No known conflicts

๐Ÿ“ Release Notes

v1.0.0

  • โœ… Modern interface with premium design
  • โœ… Smart selection of stacked tokens
  • โœ… Automatic z-index system
  • โœ… Animations and visual feedback
  • โœ… Support for multiple interaction methods

๐Ÿ—๏ธ Module Architecture

This module uses a modular architecture for better maintainability and scalability:

src/
โ”œโ”€โ”€ components/           # UI components
โ”‚   โ”œโ”€โ”€ token-hooks-manager.js
โ”‚   โ”œโ”€โ”€ token-selection-panel.js
โ”‚   โ””โ”€โ”€ token-stack-button.js
โ”œโ”€โ”€ utils/               # Utilities and helpers
โ”‚   โ”œโ”€โ”€ token-detector.js
โ”‚   โ””โ”€โ”€ token-layer-manager.js
โ”œโ”€โ”€ styles/              # CSS styles
โ”‚   โ””โ”€โ”€ token-stack-styles.js
โ””โ”€โ”€ token-stack-selector.js  # Main orchestrator

Debug Commands

Open browser console and use:

TokenStackSelector.debug(); // Debug information
TokenStackSelector.getStats(); // Module statistics
TokenStackSelector.reload(); // Reload module
TokenStackSelector.shutdown(); // Shutdown module

๐Ÿค Contributing

Contributions are welcome! Please:

  1. Fork the project
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

See CONTRIBUTING.md for detailed guidelines.

๐Ÿ“ธ Contributing Screenshots

Help improve the documentation by adding screenshots:

  1. Check screenshots/README.md for needed images
  2. Take high-quality screenshots showing the module in action
  3. Follow the naming conventions specified
  4. Submit via Pull Request with descriptive commit messages

๐Ÿ› Bug Reports

Found a problem? Open an issue with:

  • Foundry VTT version
  • Module version
  • Steps to reproduce the bug
  • Screenshots (if applicable)

๐Ÿ“„ License

Distributed under the MIT License. See LICENSE for more information.

๐Ÿ™ Acknowledgments

  • Foundry VTT Brazil Community
  • Foundry VTT Developers
  • All users who tested and provided feedback

Developed with โค๏ธ for the Foundry VTT community

About

Token Stack Selector is a modern module for Foundry VTT that solves the problem of stacked (overlapping) tokens. When multiple tokens occupy the same position on the grid, this module adds an elegant and intuitive interface to easily select the desired token.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •