Release v1.2.2

CHANGELOG.md

@@ -1,3 +1,23 @@
+## v1.2.2
+### Bugfix
+- Disabled features are now less likely to interfere with other modules, increasing compatibility.
+  - This module can now be used together with the `Arms Reach` module if the `Toggle Secret Doors` feature is disabled in the settings.
+
+### Other
+- Warn the user about incompatibility if they use this module together with `Arms Reach` and have incompatible features enabled.
+
+## v1.2.1
+### Other
+- Verified compatibility with 0.7.9
+
+## v1.2.0
+### New features
+- Draw outlines around Door Control icons to increase their visibility
+
+### Other
+- Secret doors are now tinted black instead of dark grey.
+
+
 ## v1.1.0
 ### New features
 - Tint secret doors grey for the GM to differentiate them from regular doors

README.md

@@ -8,6 +8,11 @@ Makes doors smarter. Allows doors to synchronize across multiple scenes and send
 
 Door Control icons will be rendered the same size in every scene, regardless of the configured grid size. The size of the icons is configurable.
 
+### Door Control Outline
+![Door Control Outline demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/3b0018ddf424a2a369273029e0e1184a8bed848c/media/door_control_outline.webp)
+
+Door Control icons will be rendered with an outline to improve their visibility on bright backgrounds.
+
 ### Tint Secret Doors
 ![Tint Secret Doors demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/dc5d328cd9bc4a0e2aacc5c86ab59e15739cc6d1/media/tint_secret_doors.webp)
 

lang/en.json

@@ -1,6 +1,10 @@
 {
     "smart-doors": {
 		"settings": {
+			"doorControlOutline": {
+				"name": "Door Control Outline",
+				"hint": "Draw outlines around Door Control icons to increase their visiblity"
+			},
 			"doorControlSizeFactor": {
 				"name": "Door Control Size Factor",
 				"hint": "Defines by which factor the size of the door control icons should be scaled up"
@@ -24,6 +28,7 @@
 		},
 		"ui": {
 			"messages": {
+				"armsReachIncompatiblilty": "You have the modules Smart Doors and Arms Reach activated. Those modules are known to conflict with each other. To resolve the conflict please disable either the \"Toggle Secret Doors\" setting of Smart Doors or the \"Hotkey 'e' for interaction\" setting of Arms Reach.",
 				"migrating": "Migrating Smart Doors to version {version}. Please don't close the application.",
 				"migrationDone": "Smart Doors successfully migrated to version {version}.",
 				"unknownVersion": "Smart Doors migration failed with the error: Unkown Version {version}. Please report this to the Smart Doors issue tracker. To prevent possible data loss don't use this plugin until this error is fixed."

lib/outline_filter/outline_filter.js

@@ -0,0 +1,152 @@
+/*
+
+This is a modified version of the PIXI outline filter (https://github.com/pixijs/pixi-filters/tree/master/filters/outline)
+and is licensed under the MIT license.
+
+The MIT License
+
+Copyright (c) 2013-2017 Mathew Groves, Chad Engler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+*/
+
+const vertex = `attribute vec2 aVertexPosition;
+attribute vec2 aTextureCoord;
+
+uniform mat3 projectionMatrix;
+
+varying vec2 vTextureCoord;
+
+void main(void)
+{
+    gl_Position = vec4((projectionMatrix * vec3(aVertexPosition, 1.0)).xy, 0.0, 1.0);
+    vTextureCoord = aTextureCoord;
+}`
+
+const fragment = `varying vec2 vTextureCoord;
+uniform sampler2D uSampler;
+
+uniform vec2 thickness;
+uniform vec4 outlineColor;
+uniform vec4 filterClamp;
+
+const float DOUBLE_PI = 3.14159265358979323846264 * 2.;
+
+void main(void) {
+    vec4 ownColor = texture2D(uSampler, vTextureCoord);
+    vec4 curColor;
+    float maxAlpha = 0.;
+    vec2 displaced;
+    for (float angle = 0.; angle <= DOUBLE_PI; angle += \${angleStep}) {
+        displaced.x = vTextureCoord.x + thickness.x * cos(angle);
+        displaced.y = vTextureCoord.y + thickness.y * sin(angle);
+        curColor = texture2D(uSampler, clamp(displaced, filterClamp.xy, filterClamp.zw));
+        maxAlpha = max(maxAlpha, curColor.a);
+    }
+    float resultAlpha = max(maxAlpha, ownColor.a);
+	// Original line:
+	// gl_FragColor = vec4((ownColor.rgb + outlineColor.rgb * (1. - ownColor.a)) * resultAlpha, resultAlpha);
+    gl_FragColor = vec4(ownColor.rgb + outlineColor.rgb * (resultAlpha - ownColor.a), resultAlpha);
+}
+`
+
+/**
+ * OutlineFilter, originally by mishaa
+ * http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966
+ * http://codepen.io/mishaa/pen/emGNRB<br>
+ * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/outline.png)
+ *
+ * @class
+ * @extends PIXI.Filter
+ * @memberof PIXI.filters
+ * @see {@link https://www.npmjs.com/package/@pixi/filter-outline|@pixi/filter-outline}
+ * @see {@link https://www.npmjs.com/package/pixi-filters|pixi-filters}
+ * @param {number} [thickness=1] The tickness of the outline. Make it 2 times more for resolution 2
+ * @param {number} [color=0x000000] The color of the outline.
+ * @param {number} [quality=0.1] The quality of the outline from `0` to `1`, using a higher quality
+ *        setting will result in slower performance and more accuracy.
+ *
+ * @example
+ *  someSprite.filters = [new OutlineFilter(2, 0x99ff99)];
+ */
+class OutlineFilter extends PIXI.Filter {
+
+    constructor(thickness = 1, color = 0x000000, quality = 0.1) {
+        const samples =  Math.max(
+            quality * OutlineFilter.MAX_SAMPLES,
+            OutlineFilter.MIN_SAMPLES
+        );
+        const angleStep = (Math.PI * 2 / samples).toFixed(7);
+
+        super(vertex, fragment.replace(/\$\{angleStep\}/, angleStep));
+        this.uniforms.thickness = new Float32Array([0, 0]);
+
+        /**
+         * The thickness of the outline.
+         * @member {number}
+         * @default 1
+         */
+        this.thickness = thickness;
+
+        this.uniforms.outlineColor = new Float32Array([0, 0, 0, 1]);
+        this.color = color;
+
+        this.quality = quality;
+    }
+
+    apply(filterManager, input, output, clear) {
+        this.uniforms.thickness[0] = this.thickness / input._frame.width;
+        this.uniforms.thickness[1] = this.thickness / input._frame.height;
+
+        filterManager.applyFilter(this, input, output, clear);
+    }
+
+    /**
+     * The color of the glow.
+     * @member {number}
+     * @default 0x000000
+     */
+    get color() {
+        return PIXI.utils.rgb2hex(this.uniforms.outlineColor);
+    }
+    set color(value) {
+        PIXI.utils.hex2rgb(value, this.uniforms.outlineColor);
+    }
+}
+
+/**
+ * The minimum number of samples for rendering outline.
+ * @static
+ * @member {number} MIN_SAMPLES
+ * @memberof PIXI.filters.OutlineFilter
+ * @default 1
+ */
+OutlineFilter.MIN_SAMPLES = 1;
+
+/**
+ * The maximum number of samples for rendering outline.
+ * @static
+ * @member {number} MAX_SAMPLES
+ * @memberof PIXI.filters.OutlineFilter
+ * @default 100
+ */
+OutlineFilter.MAX_SAMPLES = 100;
+
+export { OutlineFilter };

module.json

@@ -2,10 +2,16 @@
 	"name": "smart-doors",
 	"title": "Smart Doors",
 	"description": "Makes doors smarter. Allows doors to synchronize across multiple scenes and sends chat messages when players try to open locked doors.",
-	"version": "1.1.0",
+	"version": "1.2.2",
 	"minimumCoreVersion" : "0.7.7",
-	"compatibleCoreVersion" : "0.7.8",
+	"compatibleCoreVersion" : "0.7.9",
-	"author": "Manuel Vögele",
+	"authors": [
+		{
+			"name": "Manuel Vögele",
+			"email": "develop@manuel-voegele.de",
+			"discord": "Stäbchenfisch#5107"
+		}
+	],
 	"esmodules": [
 		"src/main.js"
 	],
@@ -18,7 +24,7 @@
 	],
 	"url": "https://github.com/manuelVo/foundryvtt-smart-doors",
 	"manifest": "https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/master/module.json",
-	"download": "https://github.com/manuelVo/foundryvtt-smart-doors/archive/v1.1.0.zip",
+	"download": "https://github.com/manuelVo/foundryvtt-smart-doors/archive/v1.2.2.zip",
 	"readme": "https://github.com/manuelVo/foundryvtt-smart-doors/blob/master/README.md",
 	"changelog": "https://github.com/manuelVo/foundryvtt-smart-doors/blob/master/CHANGELOG.md",
 	"bugs": "https://github.com/manuelVo/foundryvtt-smart-doors/issues"

src/features/door_control_icon_scale.js

@@ -10,15 +10,6 @@ export function hookDoorControlReposition() {
 	}
 }
 
-export function hookDoorControlDraw() {
-	const originalHandler = DoorControl.prototype.draw
-	DoorControl.prototype.draw = async function () {
-		const result = await originalHandler.call(this)
-		onDoorControlPostDraw.call(this)
-		return result
-	}
-}
-
 // Set the size of all door controls in relation to the grid size so it'll have a constant percieved size
 export function onCanvasReady(currentCanvas) {
 	const doors = currentCanvas.controls.doors.children
@@ -26,7 +17,7 @@ export function onCanvasReady(currentCanvas) {
 }
 
 // Set the size of the door control in relation to the grid size so it'll have a constant percieved size
-function onDoorControlPostDraw() {
+export function onDoorControlPostDraw() {
 	// If the canvas isn't ready we'll do this after the "canvasReady" event is fired instead
 	if (!canvas.ready)
 		return

src/features/door_control_outline.js

@@ -0,0 +1,24 @@
+import {settingsKey} from "../settings.js"
+import {OutlineFilter} from "../../lib/outline_filter/outline_filter.js"
+
+export function onDoorControlPostDraw() {
+	if (!game.settings.get(settingsKey, "doorControlOutline"))
+		return
+
+	const types = CONST.WALL_DOOR_TYPES
+	if (this.wall.data.door === types.NONE)
+		return
+
+	// Remove all OutlineFilters from current filters
+	let pixiFilters = this.icon.filters || []
+	pixiFilters = pixiFilters.filter(pixiFilter => !(pixiFilter instanceof OutlineFilter))
+
+	let outlineFilter;
+	if (this.wall.data.door === types.SECRET && game.settings.get(settingsKey, "highlightSecretDoors"))
+		outlineFilter = new OutlineFilter(1, 0xFFFFFF)
+	else
+		outlineFilter = new OutlineFilter(1, 0x000000)
+
+	pixiFilters.push(outlineFilter)
+	this.icon.filters = pixiFilters
+}

src/features/highlight_secret_doors.js

@@ -1,6 +1,6 @@
 import {settingsKey} from "../settings.js"
 
-const SECRET_DOOR_TINT = 0x222222
+const SECRET_DOOR_TINT = 0x000000
 
 // Tint all secret doors dark grey
 export function onCanvasReady(currentCanvas) {

src/features/locked_door_alert.js

@@ -26,13 +26,13 @@ export function onRenderChatMessage(message, html, data) {
 
 // Creates a chat message stating that a player tried to open a locked door
 export function onDoorLeftClick() {
-	const state = this.wall.data.ds
-	const states = CONST.WALL_DOOR_STATES
-
 	// Check if this feature is enabled
 	if (!game.settings.get(settingsKey, "lockedDoorAlert"))
 		return false
 
+	const state = this.wall.data.ds
+	const states = CONST.WALL_DOOR_STATES
+
 	// Only create messages when the door is locked.
 	if (state != states.LOCKED)
 		return false

src/features/synchronized_doors.js

@@ -3,7 +3,7 @@ import * as Util from "../util.js"
 
 // Inject settings for synchronized doors
 export function onRederWallConfig(wallConfig, html, data) {
-	if (data.isDoor && game.settings.get(settingsKey, "synchronizedDoors")) {
+	if (game.settings.get(settingsKey, "synchronizedDoors") && data.isDoor) {
 		// Inject settings
 		const synchronizedSettings = `
 			<p class="notes">${game.i18n.localize("smart-doors.ui.synchronizedDoors.description")}</p>

src/features/toggle_secret_door.js

@@ -2,7 +2,7 @@ import {settingsKey} from "../settings.js"
 
 // Toggles between normal and secret doors
 export function onDoorLeftClick(event) {
-	if (event.data.originalEvent.ctrlKey && game.user.isGM && game.settings.get(settingsKey, "toggleSecretDoors")) {
+	if (game.settings.get(settingsKey, "toggleSecretDoors") && event.data.originalEvent.ctrlKey && game.user.isGM) {
 		const types = CONST.WALL_DOOR_TYPES
 		const newtype = this.wall.data.door === types.DOOR ? types.SECRET : types.DOOR
 		this.wall.update({door: newtype})

src/main.js

@@ -1,30 +1,41 @@
 "use strict";
 
 import * as DoorControlIconScale from "./features/door_control_icon_scale.js"
+import * as DoorControlOutline from "./features/door_control_outline.js"
 import * as HighlightSecretDoors from "./features/highlight_secret_doors.js"
 import * as LockedDoorAlert from "./features/locked_door_alert.js"
 import * as SynchronizedDoors from "./features/synchronized_doors.js"
 import * as ToggleSecretDoor from "./features/toggle_secret_door.js"
 
 import {performMigrations} from "./migration.js"
-import {registerSettings} from "./settings.js"
+import {registerSettings, settingsKey} from "./settings.js"
 
 Hooks.once("init", () => {
 	registerSettings()
 	hookDoorEvents()
 	hookWallConfigUpdate()
-	DoorControlIconScale.hookDoorControlDraw()
+	hookDoorControlDraw()
 	DoorControlIconScale.hookDoorControlReposition()
 })
 
 Hooks.once("ready", () => {
 	performMigrations()
+
+	// Check if arms-reach module is active and conflicting features are enabled
+	if (game.user.isGM && game.modules.get("arms-reach")?.active) {
+		// Our toggle-secret-door and arms-reach's hotkeyDoorInteraction conflict. Check if both are enabled.
+		if (game.settings.get(settingsKey, "toggleSecretDoors") && game.settings.get("arms-reach", "hotkeyDoorInteraction")) {
+			// Inform the user that they have incompatible features enabled
+			const incopatibilityMessage = game.i18n.localize("smart-doors.ui.messages.armsReachIncompatiblilty")
+			console.warn("Smart Doors | " + incopatibilityMessage)
+			ui.notifications.warn(incopatibilityMessage, {permanent: true})
+		}
+	}
 })
 
 Hooks.on("renderChatMessage", LockedDoorAlert.onRenderChatMessage)
 
 Hooks.on("canvasReady", DoorControlIconScale.onCanvasReady)
-
 Hooks.on("canvasReady", HighlightSecretDoors.onCanvasReady)
 
 Hooks.on("updateWall", HighlightSecretDoors.onUpdateWall)
@@ -42,6 +53,16 @@ function hookWallConfigUpdate() {
 	}
 }
 
+function hookDoorControlDraw() {
+	const originalHandler = DoorControl.prototype.draw
+	DoorControl.prototype.draw = async function () {
+		const result = await originalHandler.call(this)
+		DoorControlIconScale.onDoorControlPostDraw.call(this)
+		DoorControlOutline.onDoorControlPostDraw.call(this)
+		return result
+	}
+}
+
 // Hook mouse events on DoorControls to perform our logic.
 // If we successfully handled the event block the original handler. Forward the event otherwise.
 function hookDoorEvents() {

src/settings.js

@@ -21,6 +21,15 @@ export function registerSettings() {
 		default: 1.5,
 		onChange: () => location.reload()
 	})
+	game.settings.register(settingsKey, "doorControlOutline", {
+		name: "smart-doors.settings.doorControlOutline.name",
+		hint: "smart-doors.settings.doorControlOutline.hint",
+		scope: "client",
+		config: true,
+		type: Boolean,
+		default: true,
+		onChange: () => location.reload(),
+	})
 	game.settings.register(settingsKey, "highlightSecretDoors", {
 		name: "smart-doors.settings.highlightSecretDoors.name",
 		hint: "smart-doors.settings.highlightSecretDoors.hint",