Skip to content

Commit

Permalink
Rebaseing my fork (#1)
Browse files Browse the repository at this point in the history
* Spotless applied

* Add new Server Option for GM to Reveal FoW for Unowned Tokens

 * Closes RPTools#665 and Closes RPTools#663
 * Added abeille-maptool-forms.jfpr project file to buil-resources

* Add playStream, stopStream, and editStream functions to stream audio

- Add playStream(uri, cycleCount, volume) to play audio from url or local file.
- cycleCount: number of times to play the resource. -1 for infinite loop. Default: 1.
- volume: volume value from 0-1. Default: 1.
- Add stopStream(uri, remove) to stop a stream. If remove is set to 1, unload the stream from memory. Default: 1. If no uri specified, stop all sounds.
- Add editStream(uri, cycleCount, volume) to change the cycleCount or volume of stream.
- Add AppPreference playStreams to enable/disable playing streams
- Ex:

[playStream("https://www.fesliyanstudios.com/musicfiles/2019-05-01_-_Undercover_Spy_Agent_-_David_Fesliyan.mp3", -1, 0.8)]

* Fix disabling streams, and make stream functions thread-safe

- Fix access HashMap to be thread safe (now accessed solely from the JavaFX app single thread)
- Fix so that disabling streams in settings also stops all streams

* Add features to playStream functions

- Move streaming methods to class MediaPlayerAdapter, as discussed in RPTools#668
- Add new parameters: startTime and stopTime to playStream & editStream
- playStream with cycleCount 0 preloads the stream but does not play it
- Add function getStreamProperties as suggested in RPTools#667
- Add support for volume slider through setGlobalVolume, but the slider needs to be created

* Fix getStreamProperties wrongly returning "PLAYING" , change ms to secs

- Fix getStreamProperties to return status "STOPPED" after song finished playing
- Change parameters startTime and stopTime to take seconds instead of ms

* Add Volume Slider and Mute Button to Toolbar

- Icons provided by @JamzTheMan

Co-Authored-By: Jamz <jamz@nerps.net>

* Add "fadeout" parameter to stopStream

- Add optional fadeout (in seconds) before closing a stream
- 0: no fadeout (default)
- Stream will stop once the fadeout period is over
- Suggested by @dorpond in RPTools#615

* Add DebounceExecutor, update ZoneRenderer.java to use debounced repaint (RPTools#611)

dispatcher.

* Add sound icons to the github directory

- Add back,forward,next,pause,play,previous,record,record_on,repeat,shuffle,shuffle_on, and stop icons
- Move mute & volume icons to correct directory
- Icons will be used for RPTools#615
- Icons provided by @JamzTheMan

Co-Authored-By: Jamz <jamz@nerps.net>

* Add support for space in uri for stream functions

- Add conversion of string to uri, replacing space into %20
- Add "FILE/:" at the start of uri if it is missing
- Fix issues raised in RPTools#667

* Fix PRs automatically failed

- Change to using jitpack for clientserver
- Fix RPTools#679

* Fix bug: "*" stop working as path in stopStream, getStreamProperties (RPTools#682)

- Add special case so that "*" isn't modified
- Fix regression created by RPTools#678
- Fix RPTools#681

* Add propertyType option for getTokens(), improve getTokens() (RPTools#677)

- Add new option "propertyType" to conditions in getTokens()
- Value can be a single type as string, or an array of types
- Simplify getTokens() code by removing the second loop. Now include/exclude is a filter property ("match")
- Improve performance of getTokens() by trimming the list continuously instead of constantly filtering the list of all tokens
- Close RPTools#676

* Json, store "null" "false" and "true" as their revelant java type internally (RPTools#672)

* jsonify "null", "true" and "false" into null true and false

* fix null handling, using the library Null object

* jsonify should be static and public

* Change getTokens to be much faster with area option (RPTools#686)

- Change so overlap is computed explicitely instead of using A*
- Much better performance
- Solves RPTools#683 for "area" but not for "range"

* ImagePanel QOL improvements (RPTools#691)

- Request only images in view from ImageManager
- Trigger repaint() from paint-affecting properties only if property
actually changes
- Calculate truncated caption heuristically
- Improve spacing
- Include caption in mouse capture area
- Antialias text
- Use interpolation when rendering scaled images

* Fix Manhattan distance, metric distance parameter with iso maps (RPTools#690)

- Fix manhattan distance while moving tokens & in distance functions
- Fix getDistance, getDistanceToXY, getTokens ignoring metric parameter for isometric maps
- Close RPTools#688

* Fix json.path functions adding extra / and \ to json objects (RPTools#693)

- Fix issue raised in RPTools#612

* Resolve RPTools#694 -- Fix asset panel scaling (RPTools#695)

* RPTools#696 Implement dragTheshold in DefaultTool

* Fix NullPointer exception when closing maptool

Fix RPTools#700

* Change getDistance to use explicit closed-form

- Improve speed dramatically while using getTokens() with a distance option
- Previous walker-based approach kept as it could be extended to take VBL & terrain into account
- Distance returned tested to be the same as previous code
- Close RPTools#683

* Fix two issues from moving token when "Snap Token While Dragging" is off

- Fix token "jumping" to a different spot once Snap-to-Grid is disabled
- Fix getDistance returning incorrect distance with NO_GRID metric
- Close RPTools#699

* Fix to getDistanceToXY and getDistance with NO_GRID metric

- Change so that getDistanceToXY and getDistance now calculate the distance from the center of the token when the token is large
- Add new "pixel" parameter to getDistanceToXY. It indicates if the x,y are for a cell or pixel (pixel: false by default)
- pixel false: getDistanceToXY gets the distance from the center of the token to the center of the specified cell
- Close RPTools#684

* Fix bug in RPTools#699 (RPTools#711)

- Fix incorrect boolean check
- Fix missing CellPoint to ZonePoint conversion

* Change volume slider to affect system sounds

- Change system sounds to be affected by volume slider & mute button
- Change system sounds to use JavaFX
- Close RPTools#709

* Fix campaign macro changes not received when connecting to server

- Fix so macro changes are now properly updated to the server
- Close RPTools#713

* Fix bug introduced by RPTools#707 with default metrics

- Fix bug where the default metric is the user's preferred one instead of the server's.
- Function affected: getDistance, getDistanceToXY, getTokens
- Fix issue mentioned in RPTools#684

* Add option "gm-self", "self", & "all" to broadcast

Close RPTools#718

* Fix getViewArea and getViewCenter returning incorrect pixels

- Change so getViewArea and getViewCenter return the actual pixels as used in setViewArea, for example.
- Close RPTools#724

Co-Authored-By: Phergus <phergus@users.noreply.github.com>

* Add parameter "players" and "delim" to execLink (RPTools#721)

- Add new parameter "players" to execLink. All players specified will have the macro run for them. Default: self.
- The parameter "players" can be a string, a list, or json array. Use new delim parameter for list or array (defaults to ",").
- execLink also accepts "gm", "gm-self", "self", "all", and "none".
- Close RPTools#716

* Add scrolling to Select Map menu (RPTools#723)

- Add new class "JScrollPopupMenu" to handle scrolling
- Class is fully functional but not complete.  Other methods relying on indexes of the components should be reimplemented before they are used
- Maximum of maps displayed at a time: 20 (scrolling will reveal them all)
- Close RPTools#356

* Add function json.toVars to turn jsonObject into variables

- keys become variable names
- values become the content of the variables
- Close RPTools#591

* Improvement to json.toVars

- Change: parameter "suffixed" is now replaced by "prefix" and "suffix", which can add a prefix and/or suffix to the names.
- Change: spaces in keys are now turned into underscore
- Change: characters not alpha-numerical other than "." and "_" are deleted from var names
- Change: function now return a JSONArray with the variable names

* Fix javadocs errors

- Fix javadocs errors; it's now possible to generate the full javaDocs
- No actual code changed
- Warnings still present, but the errors should be fixed
- Close RPTools#731

* Update ChangeLog for 1.5.5 release (RPTools#736)

First pass.

* More updates to ChangeLog plus updated credits. (RPTools#737)

* Update ChangeLog for 1.5.5 release

First pass.

* Fix ChangeLog and update credits.html

Fixed typos and missing linkage in ChangeLog.
Updated credits.html file.

Issue RPTools#735

* Changed getInfo("server") macro to use ServerPolicy.toJSON directly (RPTools#738)

Updated getInfo("server") macro function to pull JSON object from ServerPolicy instead of having duplicated code.
Updated ServerPolicy.toJSON() to include isAutoRevealMovement and isUseIndividualFOW.

* Junit tests for Json function (RPTools#741)

* jsonify "null", "true" and "false" into null true and false

* fix null handling, using the library Null object

* jsonify should be static and public

* json unitary tests

* use a resource fiel for json rather that constructed within the test code

* spotless on json tests

* Updated with Issue RPTools#670 (RPTools#743)

* Update ChangeLog for 1.5.5 release

First pass.

* Fix ChangeLog and update credits.html

Fixed typos and missing linkage in ChangeLog.
Updated credits.html file.

Issue RPTools#735

* Add missing issue 670

Updated with issue 670.

* Update parser to 1.5.5

Removed self dependency in Parser project.

* Update build.gradle to pull dicelib v1.5.5 (RPTools#749)

build.gradle updated to pull in dicelib v1.5.5
Completes issue RPTools#746.

* Closes RPTools#751

Due to how the uberJar is packaged, we need to register JAI imageIO for jpeg2000
The same fix was applied to TokenTool for the same issue.

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Updates to Change Log and Credits (RPTools#754)

* Update ChangeLog for 1.5.5 release

First pass.

* Fix ChangeLog and update credits.html

Fixed typos and missing linkage in ChangeLog.
Updated credits.html file.

Issue RPTools#735

* Add missing issue 670

Updated with issue 670.

* Update ChangeLog and Credits

Updated Change Log for issues 731, 746 & 751.  Updated MapTool credits  with recent contributor and missing `</td>` tags.

* Fix prompt to "update" to old version when on pre-release (RPTools#757)

* Fix prompt to "update" to old release when on pre-release

- Fix so that a release candidate / alpha / beta no longer gives prompt to "update" to an older release
- Change: users on a pre-release now get a prompt to update to the newest version, such as a newer release candidate
- No change for those on releases
- Close RPTools#627

* Change pre-release detection to use github API

- Change so that pre-release status is detected by parsing the json of all releases and finding the one corresponding to the commit SHA

* blah

* Add Panel for GM macros

- Add a new panel to hold GM macros
- Macros in this panel are only visible to GMs
- Campaign panel left as-is
- Close RPTools#642

* Remove putTokens in macro functions

- Change so that many token functions now only update the relevant information instead of sending the whole token
- Close RPTools#761
- Function affected: addToInitiative, setInitiative, setInitiativeHold, setBar, setBarVisible, setName, setGMName, setHalo, setTokenOpacity, setImageAsset, setPortraitImage, setCharsheetImage, setLabel, resetProperty, setTerrainModifier, setVisible, setOwnerOnlyVisible, setAlwaysVisible, setTokenVBL

* Fix copyToken so copy can be modified in the same macro

- Fix: tokens created by copyToken no longer have their changes reverted at the end of the macro
- Exception: z order is reverted at end of macro
- Fix RPTools#769

* Add "light" option to getTokens and getTokenNames

- light option can be a JSONObject with "value", "category" and "name" fields
- value can be a 0 or a 1, determining if the tokens need to have a light or not
- category and name determine what type of lights the tokens need to have (or not, if value is 0)
- light can also be a 1 or 0 instead of a JSONObject, in which case all tokens with a light (or no lights) are returned
- Close RPTools#745

* Fix json.path.read returning bad JSON object from array

- Change json provider from JsonSmart to Gson
- Close RPTools#775

* Add options not-gm, not-self, and not-gm-self to broadcast

- Close RPTools#782

* Add json.toVars support for JSONArrays

- Change json.toVars to take the elements of a JSONArray and put them into a variable, using the method

json.toVars(jsonArray, variablePrefix)

- Variables will take the names variablePrefix0, variablePrefix1, ...
- Close RPTools#784

* Fix bar functions returning wrong values if bar not defined

- Change to throw exception if the name of the bar is not valid
- Change getBar to return an empty string instead of a null if the bar is defined but isn't visible
- Close RPTools#786

* Release 1.5.6 (RPTools#777)

* Emergency fix for NPE on Mac OS (RPTools#765)

* Update Change Log for 1.5.6

Added notes for 1.5.6 release.

* Added noise rendering to background textures

* Ability to add noise to background tiled textures

* Spoltess apply

* ignore .gradletasknamecache

* removed .gradletasknamecache

* removed unwated files

* Background texture noise (RPTools#791)

* blah

* Added noise rendering to background textures

* Ability to add noise to background tiled textures

* Spoltess apply

* ignore .gradletasknamecache

* removed .gradletasknamecache

* removed unwated files

* Added ability to turn off noise and comments

* Redraw background when noise toggled

* Renamed DrableNoise to make it clearer it doesnt subclass Pant

* Add preferences setting for frame rate cap used in debouncer

Preference setting Frame Rate Cap added for the debouncer. Default of 60 fps.  Issue RPTools#767

* Fix broken smileys

- Remove \b (word boundary) in regular expression as it doesn't work with non-word characters such as smileys
- Add negative lookbehind/ahead instead to prevent unwanted characters near smileys
- Only space, tab, and newline are allowed before/after smiley
- Close RPTools#529

* Update CHANGE_LOG.md

First pass on updating change log for 1.5.7 release.

* Update TaskBarFlasher.java

Chat notification flash now determines the flash color based on the brightness level of the task bar.  This will improve visibility on different color schemes.  Issue RPTools#804.

* Fix getStreamProps() returning malformed JSON

- Remove incorrect space in front of getStreamProperties values
- Close RPTools#803

* Update TaskBarFlasher.java

Spotless pass.

* Update CHANGE_LOG.md

More updates 800, 803, 804

* Add token & mapname parameters to getTokenStates

- New token parameter: if specified, getTokenStates returns the list of all states of the specified group that are enabled on the token
- Set group to "*" to get all states of the token
- If no token parameter specified, the function returns the list of all campaign states
- Close RPTools#801

* Fix Incorrect tooltip for Show Chat Notification Background

- Change tooltip to "If enabled, shows a background frame underneath the typing notification."
- Change name to "Typing Notification Background"
- Close RPTools#800

* Update CHANGE_LOG.md

Missed linkage for 800.

* Fix getTokenStates returning wrong list of states

- Fix issue disclosed by @Phergus in PR RPTools#809

* Add execFunction : functions can now be ran on clients

- Add execFunction(functionName,args,defer, targets, delim)
- args is a json array containing the arguments to the function
- defer, targets and delim work as in execLink
- Close RPTools#790

* Fix exception when copyToken is used

- Fix updates x, y, layer, tokenImage, portraitImage, & handoutImage so they no longer throw an exception
- Close RPTools#814

* Update CHANGE_LOG.md

Typo fixed.

Co-Authored-By: Guillaume F. <filteau.guillaume@gmail.com>

* Update CHANGE_LOG.md

Typos, missing links and other tweaks.

* Change copyToken options to tokenHandout, tokenPortrait

- Change handoutImage update field to tokenHandout
- Change portraitImage update field to tokenPortrait
- Legacy: old values still work
- Fix null pointer exception to propert error message if the image token cannot be found
- Solve issues raised by @Phergus in RPTools#814

* Updating code style and guidelines

First past at incorporating updates and changes per issue RPTools#813.

* More updates

Dumped the ambiguous rule 3.
Allowed some slack on rule 2.

* Update CHANGE_LOG.md

Added issue RPTools#814 and changed list markers to dashes.

* Fix NPE thrown in MapToolFrame

Fixes issue RPTools#740.  ImagePanel getImageIDAt() wasn't checking return value of getIndex().

* Fix for issue RPTools#687

For Table functions `addTableEntry`, `createTable`,  `setTableImage` and `setTableEntry`,  passing an empty AssetID string will no longer apply the bad "Asset://" string to the relevant image entry.  Also fixed: getTableImage() was throwing an NPE if no table image was set.

* Update LookupTableFunction.java

spotlessApply pass

* Fix execLink / execFunction not running locally immediately

- Change so execLink / execFunction are ran immediately for the current player when defer is set to 0.
- Add target options "not-self", "not-gm", and "not-gm-self".
- Fix RPTools#820

* Add playClip, stopClip and getClipProperties functions

- playClip works much like playStream, but preloads the decompresssed sound in memory. This leads to better performances for short sounds.
- playCount of 0: preload the sound
- clips are "fire and forget", and can't be edited once played
- The same clip can be played multiple times simultaneously
- Close RPTools#810

* Change stopStream/getStreamProperties to work with clips

- Change names of stopStream and getStreamProperties to stopSound and getSoundProperties. The new functions work with both streams and clips.
- Add function "defineAudioSource". You can now define a nickname for an audio file, with defineAudioSource(nickname, uri).
- Add already included sounds Dink and Clink as defined audio sources. They can now be played with playClip("Dink") and playClip("Clink")
- Resolve issues discussed in RPTools#810

* Update CHANGE_LOG.md

Added issues 687, 740, 790, 810.

* Fix stream / clip issues

- Change so that playClip / playStream have their default parameter values be those used during the previous play of the clip/stream, or the values changed by editStream
- Add parameter "preload" to defineAudioSource. If set to "stream", preload the sound as stream; if set to "clip", preload the sound as clip.
- Add parameters to defineAudioSource: cycleCount, volume, start and stop. These parameters will be used as default until they are replaced by using playStream/playClip
- Add list of nicknames to getSoundProperties
- Internal change: start and stop are now defined in seconds everywhere
- Fix issues discussed in RPTools#810 and RPTools#822

* Fix incorrect Campaign Name in Title Bar for clients

- Fix so clients see the proper campaign name instead of the name of the last campaign file they loaded
- Close RPTools#788

* Update CHANGE_LOG.md

Add 788, 820, 822

* Added titleCase() macro function

* spotless apply

* Bump sentry from 1.7.5 to 1.7.28

Bumps sentry from 1.7.5 to 1.7.28.

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Bump commons-net from 3.2 to 3.6

Bumps commons-net from 3.2 to 3.6.

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Bump autocomplete from 3.0.0 to 3.0.2

Bumps [autocomplete](https://github.com/bobbylight/AutoComplete) from 3.0.0 to 3.0.2.
- [Release notes](https://github.com/bobbylight/AutoComplete/releases)
- [Commits](bobbylight/AutoComplete@3.0.0...3.0.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Bump gson from 2.8.5 to 2.8.6

Bumps [gson](https://github.com/google/gson) from 2.8.5 to 2.8.6.
- [Release notes](https://github.com/google/gson/releases)
- [Changelog](https://github.com/google/gson/blob/master/CHANGELOG.md)
- [Commits](google/gson@gson-parent-2.8.5...gson-parent-2.8.6)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Bump xstream from 1.4.9 to 1.4.11.1

Bumps [xstream](https://github.com/x-stream/xstream) from 1.4.9 to 1.4.11.1.
- [Release notes](https://github.com/x-stream/xstream/releases)
- [Commits](https://github.com/x-stream/xstream/commits)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* renamed titleCase to capitalize

* Revert "Bump xstream from 1.4.9 to 1.4.11.1"

* Revert "Bump commons-net from 3.2 to 3.6"

* Update ServerPolicy.java (RPTools#847)

Set "hosting server" JSON returned by `toJSON()` to BigDecimal instead of Boolean for consistency with other settings and compatibility with parser.

* Closes RPTools#848

Add missing "file sync directory" to client info.develop.

Documentation/Wiki should be updated to reflect changes. *Side note: file sync directory preference technically can be ANY directory on the users system. It's used internally for HeroLab portfolio linking and but can be used for other uses such as streaming audio or exportData macro's*

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Closes RPTools#850 - Add log.trace to log macro group

Add log.trace(message) to macro function log group.

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Revert "Bump gson from 2.8.5 to 2.8.6" (RPTools#853)

* Revert "Bump sentry from 1.7.5 to 1.7.28" (RPTools#854)

* Added lastest commits. (RPTools#852)

Added 829, 846, 848 and 850.

* Workaround for RPTools#640 Error which would (previously) cause a bunch of scary errors to appear due to a bug in the jdk when using three monitors.

* Updated changelog

* Updated comments

* Add mapname parameter to getTokens and getTokenNames

- Add optional mapname parameters (defaults to current map)
- Add error message for incorrect number of parameters for FindToken functions
- Close RPTools#867

* Change getTokens "mapName" parameter to condition

- Change so that getTokens/getTokenNames parameter "mapName" added by RPTools#868 is instead specified as a condition
- Discussed in RPTools#867

* Add metadata to getMacroProps function, fixes RPTools#872

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Changed REST.delete to follow post, patch, put format, fixes RPTools#874

It now accepts body/payload.

This changes the signature of the macro a bit so Wiki update is needed as it no long follows REST.get signature.
This fixes an issue where some API's (like GitHub API) require data to be posted in the body.

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Add metadata to getMacroProps function, fixes RPTools#872

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Applied Google Code Formatting

Signed-off-by: Lee Foster <Jamz@Nerps.net>

* Update CHANGE_LOG.md (RPTools#876)

Added RPTools#872, RPTools#874.

* Adds ISO Formatted time with UTC offset

Signed-off-by: JamzTheMan <JamzTheMan@gmail.com>

* Fix for strings being returned with quotes (RPTools#881)

Fixes RPTools#775.  Strings were being returned with quotes.

* Work around JDK bug https://bugs.openjdk.java.net/browse/JDK-8208712

* Add fix for introduced NPE on quit using accel key

* Phergus change log patch 3 (RPTools#889)

* Update CHANGE_LOG.md

* Update CHANGE_LOG.md

Added info on 831 and 883.  Cleanup.

* Fix for RPTools#831 - numbers being returned as strings. (RPTools#888)

* Fix for RPTools#831 - numbers being returned as strings.

json.path.read() was returning numbers as strings.  Fixed.

* Forgot to run spotless

Gotta have that space in there. lol

* Update Crowdin configuration file

* Added badge for localization.
  • Loading branch information
BearFather authored Nov 16, 2019
1 parent f020ee4 commit f008c3d
Show file tree
Hide file tree
Showing 100 changed files with 3,471 additions and 1,333 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Thumbs.db
# Others
################################################################################
.gradle
.gradletasknamecache
build/
/bin/
target/
Expand Down
97 changes: 92 additions & 5 deletions CHANGE_LOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,90 @@
Maptool 1.5.7
=====

**Highlights**
- New accessibility features allows the user to apply [Perlin noise](https://en.wikipedia.org/wiki/Perlin_noise) to tiled textures to reduce obvious patterning.
- New user preference (Edit -> Preferences -> Application -> Performance) for Max Frame Rate allows users to set a desired Max Frame Rate.
- More updated macro functions for improved performance and reliability.
- New GM macro panel for GM only macros. These macros are saved as part of the campaign.
- Bug fixes!

Enhancements
-----
- [#878][i878] ISO 8601 time date field added to result of `getInfo("client")`.
- [#872][i872] Metadata added to JSON returned from `getMacroProps` function to add in external managment of macros.
- [#850][i850] New macro function `log.trace` added for log messages at `TRACE` level.
- [#848][i848] File Sync Directory preference setting adding to `getInfo("client")` result.
- [#829][i829] New macro function `capitalize` will change the first character at each word break to upper case. e.g. "jolly green giant" -> "Jolly Green Giant".
- [#810][i810] New macro function `playClip` more suited for short sound FX clips. New convenience function `defineAudioSource` to allow you to assign a nickname to audio sources and refer to the nickname in the audio functions. Two existing audio functions were renamed as part of the other changes: `stopStream` -> `stopSound`, `getStreamProperties` -> `getSoundProperties`.
- [#804][i804] Chat notification flash now picks flash color based on task bar color.
- [#801][i801] Macro function `getTokenStates` now accepts Token ID and Map Name parameters.
- [#790][i790] New `execFunction` macro that works like `execLink` but is used for built-in macro functions and UDFs.
- [#784][i784] Macro function `json.toVars` now accepts JSON arrays as well as objects.
- [#782][i782] Macro function `broadcast` no accepts "not-gm", "not-self" and "not-gm-self" as targets.
- [#766][i766] New perlin noise overlay on tiled textures to reduce visible repetition.
- [#761][i761] Bulk macro function changes.
- These functions no longer force whole token updates when used: addToInitiative, setInitiative, setInitiativeHold, setBar, setBarVisible, setName, setGMName, setHalo, setTokenOpacity, setTokenImage, setTokenPortrait, getTokenHandout, setLabel, resetProperty, setTerrainModifier, setVisible, setOwnerOnlyVisible, setAlwaysVisible, setTokenVBL
- These functions now accept additional Token ID and Map Name parameters: setBar, getBar, isBarVisible, setBarVisible, addToInitiative, setInitiative, setInitiativeHold
- [#745][i745] Macro functions `getTokens` and `getTokenNames` now take optional Light condition for getting tokens with lights.
- [#642][i642] New GM macro panel can be opened from the Window menu. Macros on the GM panel are not visible to players.

Bug Fixes
-----
- [#883][i883] Command key shortcuts on MacOS not working. Fixed.
- [#874][i874] `REST.delete` did not support a header and payload. Fixed.
- [#846][i846] `getInfo("server")` was returning true/false instead of 1/0 for "hosting server". Fixed.
- [#831][i831] Macro function `json.path.read` was returning numbers as strings. Fixed.
- [#822][i822] `playStream` was ignoring stream parameters set with `editStream`. Fixed.
- [#820][i820] Functions `execLink` and `execFunction` were not running immediately on local client. Fixed.
- [#814][i814] Some `update` keywords for `copyToken` were producing exceptions. Fixed. Alternate keywords *tokenPortrait* and *tokenHandout* added
- [#803][i803] `getStreamProps` was returning malformed JSON. Fixed.
- [#800][i800] Incorrect tooltip on Chat Notification Background preference. Fixed.
- [#788][i788] Player clients were showing the last campaign file they had loaded in the title bar when connected to servers. Fixed.
- [#786][i786] Bugs with the various bar functions returning incorrect error messages or no error when passed a bad bar name. Fixed.
- [#775][i775] `json.path.read` was returning invalid JSON for JSON arrays of objects. Fixed.
- [#769][i769] Tokens created with `copyToken` could not be modified in same macro without jumping through hoops. Fixed.
- [#767][i767] A recent change to improve program responsiveness had capped frame rate at 30 fps making for jerky map panning. Default is now 60 fps and can be adjusted in preferences under Application -> Performance -> Max Frame Rate. Note either reloading the current campaign or restarting MapTool is required after making a change.
- [#740][i740] Selecting New Map in the Library image pane with no image underneath would thrown an exception. Fixed.
- [#687][i687] The table functions `addTableEntry`, `createTable`, `setTableImage` and `setTableEntry` if passed an empty `AssetID` string would incorrectly put an empty "Asset://" into the entries asset id field. Fixed. `getTableImage` would thrown an exeption if no table image was set. Fixed.
- [#640][i640] Workaround for errors which occured when three monitors are in use. Related exceptions caught and information is logged.
- [#627][i627] Version check on MapTool startup should no longer prompt for updates when using release candidates.
- [#529][i529] Smileys are now working again.

[i883]: https://github.com/RPTools/maptool/issues/883
[i878]: https://github.com/RPTools/maptool/issues/878
[i874]: https://github.com/RPTools/maptool/issues/874
[i872]: https://github.com/RPTools/maptool/issues/872
[i850]: https://github.com/RPTools/maptool/issues/850
[i848]: https://github.com/RPTools/maptool/issues/848
[i846]: https://github.com/RPTools/maptool/issues/846
[i831]: https://github.com/RPTools/maptool/issues/831
[i829]: https://github.com/RPTools/maptool/issues/829
[i822]: https://github.com/RPTools/maptool/issues/822
[i820]: https://github.com/RPTools/maptool/issues/820
[i814]: https://github.com/RPTools/maptool/issues/814
[i810]: https://github.com/RPTools/maptool/issues/810
[i804]: https://github.com/RPTools/maptool/issues/804
[i803]: https://github.com/RPTools/maptool/issues/803
[i801]: https://github.com/RPTools/maptool/issues/801
[i800]: https://github.com/RPTools/maptool/issues/800
[i790]: https://github.com/RPTools/maptool/issues/790
[i788]: https://github.com/RPTools/maptool/issues/788
[i786]: https://github.com/RPTools/maptool/issues/786
[i784]: https://github.com/RPTools/maptool/issues/784
[i782]: https://github.com/RPTools/maptool/issues/782
[i775]: https://github.com/RPTools/maptool/issues/775
[i769]: https://github.com/RPTools/maptool/issues/769
[i767]: https://github.com/RPTools/maptool/issues/767
[i766]: https://github.com/RPTools/maptool/issues/766
[i761]: https://github.com/RPTools/maptool/issues/761
[i745]: https://github.com/RPTools/maptool/issues/745
[i740]: https://github.com/RPTools/maptool/issues/740
[i687]: https://github.com/RPTools/maptool/issues/687
[i642]: https://github.com/RPTools/maptool/issues/642
[i640]: https://github.com/RPTools/maptool/issues/640
[i627]: https://github.com/RPTools/maptool/issues/627
[i529]: https://github.com/RPTools/maptool/issues/529

Maptool 1.5.6
=====
Emergency fix for MacOS. Otherwise the same as 1.5.5.
Expand Down Expand Up @@ -318,7 +405,7 @@ Enhancements
* [getRolled][igrd]()
* [getNewRolls][ignr]()
* [clearRolls][icrl]()
* [#406][i406] - New [dice expression](http://www.lmwcs.com/rptools/wiki/Dice_Expressions) **XdYdhZ** (drop highest) and 7 others.
* [#406][i406] - New [dice expression](http://www.lmwcs.com/rptools/wiki/Dice_Expressions) **XdYdhZ** (drop highest) and 7 others.
* [#355][i355] - Macro Editor details tab reorganized to give some fields more room. Macro button tooltip entry field made into a larger text area with HTML highlighting. Checkbox to enable/disable hotkey display on button. UDFs now show in auto-complete of macro editor with their tooltip as help text.
* [#426][i426] - New Line & Radius templates that start at cells. New icons for all template types.
* [#424][i424] - Auto-completion in macro editor now works even if complete function name has already been entered.
Expand All @@ -330,7 +417,7 @@ Enhancements
* [#106][i106] - Reset Size added to right-click menu for tokens/stamps.
* [#299][i299] - Mouse pointer now visible when dragging tokens.
* [#389][i389] - File -> Export -> Campaign File As... now supports converting back to non-decimal map units-per-cell values.
* [#332][i332] - Added support for multiple personal lights and setting color for personal lights.
* [#332][i332] - Added support for multiple personal lights and setting color for personal lights.

[igrd]: http://www.lmwcs.com/rptools/wiki/getRolled
[ignr]: http://www.lmwcs.com/rptools/wiki/getNewRolls
Expand Down Expand Up @@ -389,8 +476,8 @@ Enhancements



[i50]: https://github.com/RPTools/maptool/issues/50
[i107]: https://github.com/RPTools/maptool/issues/107
[i50]: https://github.com/RPTools/maptool/issues/50
[i107]: https://github.com/RPTools/maptool/issues/107
[i189]: https://github.com/RPTools/maptool/issues/189
[i255]: https://github.com/RPTools/maptool/issues/255
[i278]: https://github.com/RPTools/maptool/issues/278
Expand Down Expand Up @@ -461,7 +548,7 @@ A new shift+ctrl+spacebar command along with a new pointer image is now availabl
* New RESTful functions getRequest & postRequest to send GET & POST requests to a URI. *Note: You must first turn access on in Preferences for these macro functions to work.
* New function exportData exportData(FilePath file, String data, boolean appendToFile) which saves string data to external file.
* New function getEnvironmentVariable(String name), Returns the value stored in the Environment Variable.
* New menu option added to the "Connections" window. Right clicking a player will offer a "Whisper" command that prepopulates the chat window with a whisper macro.
* New menu option added to the "Connections" window. Right clicking a player will offer a "Whisper" command that prepopulates the chat window with a whisper macro.
* [#237][i237] - Added support to use shift-enter to insert newlines into the command entry box (also known as the chat entry box)
* [#239][i239] - MapToolScriptTokenMaker now handles function names with . notation and dynamically pulls in all functions names. TokenMakerMaker no longer needs to be ran upon changes to MTScript.
* [#240][i240] - Macro Editor now has Auto-Completion for macro functions! A brief description and summary can be displayed (these will be added as time permits)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
| Branch | Travis | AppVeyor |
| :--- | :--: | :--: |
| Branch | Travis | AppVeyor | Localization |
| :--- | :--: | :--: | :--: |
| master | [![Build Status](https://travis-ci.org/RPTools/maptool.svg?branch=master)](https://travis-ci.org/RPTools/maptool) | [![Build status](https://ci.appveyor.com/api/projects/status/1fccyq1tqp8py6c5/branch/master?svg=true)](https://ci.appveyor.com/project/rptools-automation/maptool/branch/master)
| develop | [![Build Status](https://travis-ci.org/RPTools/maptool.svg?branch=develop)](https://travis-ci.org/RPTools/maptool) | [![Build status](https://ci.appveyor.com/api/projects/status/1fccyq1tqp8py6c5/branch/develop?svg=true)](https://ci.appveyor.com/project/rptools-automation/maptool/branch/develop)
| develop | [![Build Status](https://travis-ci.org/RPTools/maptool.svg?branch=develop)](https://travis-ci.org/RPTools/maptool) | [![Build status](https://ci.appveyor.com/api/projects/status/1fccyq1tqp8py6c5/branch/develop?svg=true)](https://ci.appveyor.com/project/rptools-automation/maptool/branch/develop) | [![Crowdin](https://badges.crowdin.net/maptool/localized.svg)](https://crowdin.com/project/maptool)|



Expand Down
7 changes: 6 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ dependencies {
// For syntax highlighting in macro editor
implementation group: 'com.fifesoft', name: 'rsyntaxtextarea', version: '3.0.2' // https://mvnrepository.com/artifact/com.fifesoft/rsyntaxtextarea
implementation group: 'com.fifesoft', name: 'rstaui', version: '3.0.0' // https://mvnrepository.com/artifact/com.fifesoft/rstaui
implementation group: 'com.fifesoft', name: 'autocomplete', version: '3.0.0' // https://mvnrepository.com/artifact/com.fifesoft/autocomplete
implementation group: 'com.fifesoft', name: 'autocomplete', version: '3.0.2' // https://mvnrepository.com/artifact/com.fifesoft/autocomplete

// For simple xml work in Hero Lab integration
implementation group: 'com.jcabi', name: 'jcabi-xml', version: '0.18.1' // https://mvnrepository.com/artifact/com.jcabi/jcabi-xml
Expand Down Expand Up @@ -265,6 +265,11 @@ dependencies {
// using jitpack.io for now
// compile ('net.rptools.dicelib:dicelib:1.5.2')
implementation 'com.github.RPTools:dicelib:1.5.5'


// Noise Generator
implementation 'com.github.cwisniew:NoiseLib:1.0.0-rc3'

}


Expand Down
3 changes: 3 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
files:
- source: /src/main/resources/net/rptools/maptool/language/i18n.properties
translation: /%original_path%/%file_name%_%two_letters_code%.%file_extension%
34 changes: 20 additions & 14 deletions doc/Code_Style_and_Guidelines.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,26 @@
# Code Style and Guidelines

Please follow the following rules when working on MapTool. Failure to follow these will typically result in your patch being rejected.
Please observe the following rules when working on MapTool. Failure to do so will typically result in your pull request being rejected.

For now patches should be posted to the Testers forum. Access to that forum is by request only; send a PM to [jfrazierjr](http://forums.rptools.net/memberlist.php?mode=viewprofile&u=773) here on the [forums](http://forums.rptools.net/) and he'll add you to the group. You may then visit that hidden forum and review information on how to post patches for submission.

1. Thou shalt always highlight the content of any Java source code thee hath modified and select **Source -> Format**. Note: this requires that the user reset the line length in the Eclipse properties: Trevor wants the line length set to 200 characters. *(But see the attached preferences import file as the formatting settings are implemented there.)*
2. Thou shalt always select **Source -> Reorganize Imports.**
3. Thou shalt always submit code that includes Javadoc comments for public classes and methods. (T'would be nice to require full Javadoc for everything, but alas, that is unlikely.)
4. Thou shalt always use the `/* */` style of comments in front of classes and methods and may use single-line comments in front of member variables and small snippets of code, but **See Rule #3**!
5. Thou shalt always use parameter names different from member field names so that disambiguation using **this** is not necessary. *(Exception: code generated by Eclipse's Source menu items is exempt from this requirement as a productivity enhancement.)*
6. Thou shalt always clearly delineate private constructors with comments so that those who come after thee may retain thy sanity.
7. Thou shalt never use hard-coded strings in code when a property from an external file can be used. (In MapTool's case, this means calling `I18N.getText(propertyKey)` and adding a definition for the `propertyKey` to `i18n.properties`. Also, all of the `show*()` methods in MapTool, such as `showError()` and `showWarning()`, take `propertyKeys` as well as strings -- only use `propertyKeys`!)
8. Thou shalt always use `static final String` when hard-coded strings _are_ appropriate. Examples include resources that are embedded inside the MapTool JAR, such as **unknown.png** -- the question mark image. Other image names that may be considered part of the "theme", such as toolbar images, button images, and so forth, should be retrieved from an images property file; I propose `images.properties` since we already have `sounds.properties`. A string in the code should reference a pathname in the property file.
9. Thou shalt report all exceptions that are true errors. `InterruptedException` while waiting for a timer can be ignored, for example. But all other errors should be handled by calling `MapTool.showError(propertyKey)` or similar and passing both a `propertyKey` and the `Throwable` object representing the exception. Note that the various "show" methods already provide logging to the `.maptool/log.txt` file, but separate logging should be performed in the class if possible, since the XML configuration is an all-or-nothing for `net.rptools.maptool.client.MapTool`.
10. Thou shalt always use defined properties instead of hard-coded strings when possible. Such as `File.separator` instead of **"/"** and now `AppActions.menuShortcut` instead of **"ctrl"**.
1. The [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) is incorporated by reference. Submitted code shall follow those guidelines unless modified by one or more of the following rules.
2. Use parameter names different from member field names so that disambiguation using **this** is not necessary. This rule is relaxed for simple short methods (e.g. setters).
3. Avoid hard-coded strings in code when a property from an external file can be used. In MapTool's case, this means calling `I18N.getText(propertyKey)` and adding a definition for the `propertyKey` to `i18n.properties`. Also, all of the `show*()` methods in MapTool, such as `showError()` and `showWarning()`, take `propertyKeys` as well as strings -- only use `propertyKeys`!)
4. Use `static final String` when hard-coded strings _are_ appropriate. Examples include resources that are embedded inside the MapTool JAR, such as **unknown.png** -- the question mark image.
5. Report to the user all exceptions that are true errors. `InterruptedException` while waiting for a timer can be ignored, for example. But all other errors should be handled by calling `MapTool.showError(propertyKey)` or similar and passing both a `propertyKey` and the `Throwable` object representing the exception. Note that the various "show" methods already provide logging to the `.maptool/log.txt` file.
6. Use the language-defined static variables instead of hard-coded strings when possible. Examples include `File.separator` instead of **"/"** and `AppActions.menuShortcut` instead of **"ctrl"**.

There are surely others that you (the contributors) may want added and that we (the dev team) determine to be acceptable. Please speak up. :)

An exported set of Eclipse Preferences as a ZIP file is available [here](http://forums.rptools.net/download/file.php?id=4151). Unpack the ZIP and use **File > Import...** to read them. These preferences only include Java appearance and style-related settings, plus Task tag definitions. (Keyboard shortcuts and other settings are left untouched.)
## Formatting Source Files

### Formatting with your IDE
Most IDEs include some Source Formatting functionality and using that functionality can make following the guidelines easier. You will need to ensure that using any such functionality does follow the guidelines.

Example for Eclipse:
* Source -> Format
* Source -> Reorganize Imports

An exported set of Eclipse Preferences can be found in the GitHub repo under `build-resources/eclipse`. Other IDEs/editors may be able to import those preference files. If you create one for your preferred environment, you can always create a Pull Request to submit it to the MapTool repo.

### Formatting with Spotless
The gradle build file for MapTool includes the Spotless targets: spotlessCheck and spotlessApply. Make use of them by doing a `gradlew spotlessCheck` and/or `spotlessApply` prior to committing or pushing your changes. Spotless will enforce the majority of the rules but not all.
Loading

0 comments on commit f008c3d

Please sign in to comment.