Skip to content

Commit

Permalink
initial
Browse files Browse the repository at this point in the history
  • Loading branch information
Teshynil committed Nov 1, 2021
1 parent baef34a commit c063781
Show file tree
Hide file tree
Showing 54 changed files with 181 additions and 2,258 deletions.
57 changes: 3 additions & 54 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,5 @@
# CHANGELOG

## [1.4.1] 2021-09-18

* Fix of unpause sometimes does not continue timer

## [1.4.0] 2021-09-18

* Added option to autoend the current turn if the timer runs out
> Feature suggested by [remiverdel](https://github.com/remiverdel)
* Added option to change the color of the timer
* Added option to change the location of the timer
* Some changes and cleaning in the code
* Removing the stopwatch icon and styles

## [1.3.0] 2021-09-17

### The after adoption update

* Added some fields from Manifest+ to module.json
* Added option to remove the 'Next up' Notification after its clicked
> Takes care of #8 Original [#6](https://github.com/smilligan93/combatready/issues/14)
* Added option to control the animations of the module
> Takes care of #7 Original [#14](https://github.com/smilligan93/combatready/issues/14)
* Added option to manual activate the timer on a player turn
> Takes care of #6 Original [#18](https://github.com/smilligan93/combatready/issues/18)
* Added multiple options to control who can listen the sounds notifications
> Takes care of #3 Original [#23](https://github.com/smilligan93/combatready/issues/23)
* Added option to disable the timer on non owned characters
> Takes care of #2 Original [#25](https://github.com/smilligan93/combatready/issues/25)
* Added option to disable 'Next up' Notification on round change
> Takes care of #1 Original [#26](https://github.com/smilligan93/combatready/issues/26)
## [1.2.2] 2021-09-12

* Update, cleaning and changing to TypeScript
* Added function to set at wich time to start the ticking sound

## [1.2.1] 2021-06-16

* Updated module.json for 0.8.7 (Compatible 0.8.x & 0.7.x)

## [1.2.0] 2021-05-18

* Updated module.json for 0.7.9
* Removed unnecessary images
* Added option to avoid the timer on non-owned NPC (GM NPC)
* Reduced size in half to avoid cluttering the window
* Changed animation to a fluid one instead of a step-like
* Added verification to avoid negative values in timer
## [1.0.0] 2021-10-31
* Initial launch
* Added timer based on Darkest Dungeon, suggestions welcome
50 changes: 13 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,25 @@
# Combat Ready module for FVTT,
# Combat Ready Themes Set

Shows a graphic + sound for players a round just before a player's turn (Next Up) and
during their turn.
A set of Animation themes and Timers for the module Combat Ready!

It uses a light-box style darkening of the canvas to catch their attention as
well as an animated graphic + sound. The player then needs to click the banner to
either acknowledge their turn is coming up, or take their turn. If they somehow
*still* don't know its their turn then that's a problem between chair and keyboard.

Note that for "Next UP" rather than having the graphic go away entirely, it just
puts opacity on the banner as a constant reminder for the player to plan for
their turn for when it does come up. Works with hidden combatants too, such that
even if there's a block of hidden enemies you're working on as GM, they'll know
when their turn is 'next' due to the graphic as to not catch them by surprise.

The combat timer is simply a bar along the bottom of the screen. By default it is
configured for 3m, but this can be changed in the settings. When the bar
reaches 3m, or the custom value, an 'expired' sound will play, but it does not
automatically advance the turn. Shame is good enough in my opinion. If you need
to pause the timer, it responds to FVTT's pause mechanic.

Combat Ready is currently spected to work with FVTT version 0.8.9
## Usage

## Note
Install it, and select which theme or timer to use in the settings menu

This module was made by Ken L. Then taken care by Jacob McAuley, later by Shawn Milligan now this is an attempt to give maitenance to the module.
### Themes availables

## Usage
* None just yet

Just install it, start a combat and ejoy.
### Timers available

For aditional settings see below.
* LightMeter
> Timer based in the game darkest dungeon light meter feature.
### Module
![Combat](https://raw.githubusercontent.com/Teshynil/combatready/master/support/Combat.png)
![NextUp](https://raw.githubusercontent.com/Teshynil/combatready/master/support/NextUp.png)
![YourTurn](https://raw.githubusercontent.com/Teshynil/combatready/master/support/YourTurn.png)
![Settings](https://raw.githubusercontent.com/Teshynil/combatready/master/support/Settings.png)
# Copyright
For the copyright details you can check the [Copyright file](https://github.com/Teshynil/combatreadythemes/blob/master/src/COPYRIGHT.md)

## Installation Instructions
# For developers

Copy https://raw.githubusercontent.com/Teshynil/combatready/master/src/module.json into the module installer
inside foundry when it asks for the manifest.
If you are a develeper you can use this module as a base for your own theme or timer.

OR

Download the zip in the release section, create a folder in Data/modules called 'combatready' and extract
the contents of "combatready-v-x.x.x.zip" there.
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ function buildSASS() {
* Copy static files
*/
async function copyFiles() {
const statics = ['lang', 'fonts','css','sounds','graphics', 'assets', 'icons', 'templates', 'packs', 'module.json', 'system.json', 'template.json'];
const statics = ['lang', 'fonts','css','sounds','graphics','themes', 'assets', 'icons', 'templates', 'packs', 'module.json', 'system.json', 'template.json'];
try {
for (const file of statics) {
if (fs.existsSync(path.join('src', file))) {
Expand Down
12 changes: 10 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"private": true,
"name": "combatready",
"version": "1.5.0",
"description": "",
"name": "combatreadythemes",
"version": "1.0.0",
"description": "A pack of basic themes for the Combat Ready! module",
"scripts": {
"package": "gulp clean && gulp build && gulp package",
"test": "jest",
Expand All @@ -28,6 +28,7 @@
"@typhonjs-fvtt/eslint-config-foundry.js": "^0.8.0",
"archiver": "^5.2.0",
"chalk": "^4.1.2",
"combatready": "github:teshynil/combatready#1.5.0",
"eslint": "^7.32.0",
"eslint-config-airbnb": "^18.2.1",
"eslint-config-jquery": "^3.0.0",
Expand Down
9 changes: 9 additions & 0 deletions src/COPYRIGHT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Credits
The next list is the icons used inside each theme or timer.

| light-meter\sword.svg | |
|---|---|
|Original name|Sword |
|Author|[franc11s](https://thenounproject.com/franc11s/)|
|Source|https://thenounproject.com/term/sword/3376430 |
|License|[Creative Commons - Attribution 3.0 United States](https://creativecommons.org/licenses/by/3.0/us/legalcode)|
Loading

0 comments on commit c063781

Please sign in to comment.