Skip to content

Commit

Permalink
Readme and chatinfo evolvement
Browse files Browse the repository at this point in the history
  • Loading branch information
coffiarts committed Dec 15, 2023
1 parent 4a96274 commit 44c6279
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 21 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@
# Sheet Locker for Foundry VTT
<table style="border:0">
<tr>
<td><img src="src/sheet-locker/artwork/user-lock-solid.svg" width="600" alt="Sheet Locker Logo"/></td>
<td><img src="src/sheet-locker/artwork/user-lock-solid.svg" width="200" alt="Sheet Locker Logo"/></td>
<td><span style="color:#da6502"></span><br/>
<br/>
<i><strong>"Here goes ...<br/>
... some fancy ...<br/>
... slogan"</strong></i>
<i><strong>Be the gatekeeper!</strong><br/>
<br/>
Lock and unlock all character sheets at once with just one click.<br/>
Never ever watch your players accidentally delete that beloved item from their inventory again ("Uuuugh... NOOOOO!")...
or let that nasty cheater among them mess around secretly with his hitpoints ("AAAAArrrrgh!").</i>
</td>
</tr>
</table>
Expand All @@ -24,14 +26,21 @@
- [Changelog](#changelog)
- [Upcoming features](#upcoming-features)
- [Tech stuff](#tech-stuff)
* [Adjustable module settings (i.e. game settings)](#adjustable-module-settings--ie-game-settings-)
* [Control it by macro!](#control-it-by-macro-)
* [Adjustable module settings](#adjustable-module-settings)
* [Control it by macro!](#control-it-by-macro)
* [Compatibility and Dependencies](#compatibility-and-dependencies)

<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>

## What does it do ...
With this nice little helper module the Game Master can block and unblock any edits to character sheets by the players.
This helps, for instance, to protect them from accidental changes.
And of course, if you're of the paranoid type, it prevents cheating.

***BE AWARE, though***: As long as the lock is active, it also suppresses automatic (game-induced) changes, given that they're triggered by the players themselves - such as applying damage by chat message button, or picking up items from loot chests.
Such changes can still be applied from within the GM's session. But the lock should not be kept active at all times. Use it with some care.

Toggling on/off works in various ways: By game settings, or with a nice UI Button (optional), or by macro code or macro button. Please refer to the various module preferences under game settings.

## Changelog
See [CHANGELOG.md](CHANGELOG.md)
Expand All @@ -45,20 +54,22 @@ Some things I am *considering* to do (feedback welcome!):
- `big`: some big feature

## Tech stuff
### Adjustable module settings (i.e. game settings)
### Adjustable module settings
This screenshot shows the default values.

<img src="src/sheet-locker/artwork/sheet-locker-settings.png" alt="sheet-locker settings"/>

### Control it by macro!
### Control it by macro
Use the exposed `class MyModuleMacroAPI` - just like this, it's a no-brainer:

<img src="src/sheet-locker/artwork/sheet-locker-toggle-macro.png" alt="sheet-locker macro example"/>

Some more variants:

// Toggle specifically on and off (pretty obvious)
MyModuleMacroAPI.someFunction();
SheetLocker.toggle();
SheetLocker.switchOn();
SheetLocker.switchOff();

### Compatibility and Dependencies
- some dependencies
- Sheet Locker uses [socketlib](https://github.com/manuelVo/foundryvtt-socketlib) for sending sync messages between the GM's session and the clients.
10 changes: 5 additions & 5 deletions src/sheet-locker/lang/de.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@
}
},
"chatInfoContent": {
"title": "Herzlich willkommen zu<br/>Sheet Locker<br/>(by coffiarts)",
"text1": "Alle Charakterbögen mit einem Klick sperren und entsperren!",
"text2": "Mit diesem kleinen, aber nützlichen Hilfsmodul kann der Game Master auf Knopfdruck jegliche Änderungen am Inhalt von Charakterbögen durch die Spieler sperren und entsperren. Dadurch können z.B. die Spieler vor unbeabsichtigten \"Fehlklicks\" geschützt werden (wie etwa das versehentliche Löschen von Ausrüstungsgegenständen). Für paranoide Game Masters mag es auch als Schutz gegen Schummelei dienen.<br/><br/>ACHTUNG: Die Sperrung verhindert auch jegliche automatischen (spielgesteuerten) Änderungen, sofern sie durch die Spieler selbst in ihrer lokalen Session ausgelöst werden: so z.B. das Anwenden von Kampfschaden via Chat oder das Aufnehmen von Items aus Schätzen! Bei Sperrung können solche Aktionen aber immer noch durch den GM durchgeführt werden. Das Locking sollte jedenfalls mit Bedacht eingesetzt und nicht permanent aktiviert werden.",
"text3": "Funktioniert wahlweise per Spielinstellungen, mit einem (optionalen) UI Button, oder via Macro Code und Macro Button. Bitte Konfigurationsoptionen in den Spieleinstellungen beachten.<br/><br/>Mehr Details außerdem auf GitHub.",
"title": "Sheet Locker<br/>(by coffiarts)",
"text1": "Sei der Türsteher!<br/>Alle Charakterbögen mit einem Klick sperren und entsperren!",
"text2": "Mit diesem kleinen, aber nützlichen Hilfsmodul kann der Game Master auf Knopfdruck jegliche Änderungen am Inhalt von Charakterbögen durch die Spieler sperren und entsperren.",
"text3": "Ein- und ausschaltbar wahlweise per Spielinstellungen, mit einem (optionalen) UI Button, oder via Macro Code und Macro Button.<br/>Bitte Konfigurationsoptionen in den Spieleinstellungen beachten.<br/><br/>Mehr Details auf GitHub.",
"footer": "Diese Nachricht wird nur einmal angezeigt. Zum Wiederanzeigen bitte die entsprechende Option in den Moduleinstellungen verwenden."
},
"onOffUIMessage": {
Expand All @@ -60,7 +60,7 @@
"gmMsgItemDeleted": "[{userName}] versucht, auf einem Charakterbogen den Item [{itemName}] zu löschen."
},
"controlButton": {
"label": "Sheet Locker ein- und ausschalten"
"label": "Sheet Locker EIN/AUS"
}
}
}
10 changes: 5 additions & 5 deletions src/sheet-locker/lang/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@
}
},
"chatInfoContent": {
"title": "Welcome to<br/>Sheet Locker<br/>(by coffiarts)",
"text1": "Lock and unlock all character sheets at once with just one click!",
"text2": "With this nice little helper module the Game Master can block and unblock any edits to character sheets by the players. This helps, for instance, to protect them from accidental changes. And of course, if you're of the paranoid type, it prevents cheating.<br/><br/>BE AWARE: Locking also suppresses any automatic (game-induced) changes, as long as they're triggered by the players themselves - such as applying damage by chat message button, or picking up items from loot chests. Such changes can still be applied from within the GM's session. But the lock should not be kept active at all times. Use it with some care.",
"text3": "Toggling on/off works in various ways: By game settings, or with a nice UI Button (optional), or by macro code or macro button. Please refer to the various module preferences under game settings.<br/><br/>Find even more details on GitHub",
"title": "Sheet Locker<br/>(by coffiarts)",
"text1": "Be the gatekeeper!<br/>Lock and unlock all character sheets at once with just one click!",
"text2": "With this nice little helper module the Game Master can block and unblock any edits to character sheets by the players.",
"text3": "Toggling on/off works in various ways: By game settings, or with a nice UI Button (optional), or by macro code or macro button. <br/><br/>Refer to the module preferences under game settings.<br/><br/>Find more details on GitHub",
"footer": "This chat card will only be shown once. Activate once more in the module settings if needed."
},
"onOffUIMessage": {
Expand All @@ -60,7 +60,7 @@
"gmMsgItemDeleted": "[{userName}] is attempting to delete item [{itemName}] from character sheet."
},
"controlButton": {
"label": "Toggle Sheet Locker on/off"
"label": "Sheet Locker ON/OFF"
}
}
}
2 changes: 1 addition & 1 deletion src/sheet-locker/scripts/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export class Config {
}
},
isActive: {
scope: 'world', config: true, type: Boolean, default: true,
scope: 'world', config: true, type: Boolean, default: false,
},
showUIButton: {
scope: 'world', config: true, type: Boolean, default: true,
Expand Down

0 comments on commit 44c6279

Please sign in to comment.