Translate docs and helpers to English, add GPLv3

This commit is contained in:
Dasemu
2025-12-16 09:11:33 +01:00
parent 9e22454750
commit fa3281d2b3
3 changed files with 706 additions and 13 deletions

19
README.md Normal file
View File

@@ -0,0 +1,19 @@
# Bluemap Simple Hidder
JavaScript snippet to hide and show the player-icon container in BlueMap's web viewer. On load it hides the container and exposes global helpers to toggle visibility.
## How it works
- Uses the CSS selector `#map-container > div > div:nth-child(2)` to find the container that renders player icons.
- Hides the container as soon as the script runs.
- Exposes two global functions: `close_sesame` to hide and `open_sesame` to show the icon container.
## Quick start
1. Open your BlueMap web instance.
2. Inject `PlayerHidder.js` into the page (for example, as an extra script in BlueMap's web folder or by pasting the code into the browser console with the map open).
3. Player markers will hide automatically. Run `close_sesame()` or `open_sesame()` in the console to toggle visibility.
## Customizing
- If your DOM differs, adjust the `selector` value in `PlayerHidder.js` to target the correct container.
## License
- This project is licensed under the GNU General Public License v3.0. See `LICENSE` for details.