Merge branch 'master' of https://github.com/runelite/runelite into upstream_0712

This commit is contained in:
Justin
2021-12-07 12:19:59 +11:00
4 changed files with 143 additions and 44 deletions

View File

@@ -74,6 +74,28 @@ public interface ScreenshotConfig extends Config
return true;
}
@ConfigItem(
keyName = "uploadScreenshot",
name = "Upload",
description = "Configures whether or not screenshots are uploaded to Imgur, or placed on your clipboard",
position = 3
)
default ImageUploadStyle uploadScreenshot()
{
return ImageUploadStyle.NEITHER;
}
@ConfigItem(
keyName = "hotkey",
name = "Screenshot hotkey",
description = "When you press this key a screenshot will be taken",
position = 4
)
default Keybind hotkey()
{
return Keybind.NOT_SET;
}
@ConfigItem(
keyName = "rewards",
name = "Screenshot Rewards",
@@ -122,17 +144,6 @@ public interface ScreenshotConfig extends Config
return true;
}
@ConfigItem(
keyName = "uploadScreenshot",
name = "Upload",
description = "Configures whether or not screenshots are uploaded to Imgur, or placed on your clipboard",
position = 7
)
default ImageUploadStyle uploadScreenshot()
{
return ImageUploadStyle.NEITHER;
}
@ConfigItem(
keyName = "kills",
name = "Screenshot PvP Kills",
@@ -278,13 +289,14 @@ public interface ScreenshotConfig extends Config
}
@ConfigItem(
keyName = "hotkey",
name = "Screenshot hotkey",
description = "When you press this key a screenshot will be taken",
position = 20
keyName = "combatAchievements",
name = "Screenshot combat achievements",
description = "Take a screenshot when completing a combat achievement task",
position = 20,
section = whatSection
)
default Keybind hotkey()
default boolean screenshotCombatAchievements()
{
return Keybind.NOT_SET;
return true;
}
}

View File

@@ -112,6 +112,7 @@ public class ScreenshotPlugin extends Plugin
private static final Pattern DUEL_END_PATTERN = Pattern.compile("You have now (won|lost) ([0-9,]+) duels?\\.");
private static final Pattern QUEST_PATTERN_1 = Pattern.compile(".+?ve\\.*? (?<verb>been|rebuilt|.+?ed)? ?(?:the )?'?(?<quest>.+?)'?(?: [Qq]uest)?[!.]?$");
private static final Pattern QUEST_PATTERN_2 = Pattern.compile("'?(?<quest>.+?)'?(?: [Qq]uest)? (?<verb>[a-z]\\w+?ed)?(?: f.*?)?[!.]?$");
private static final Pattern COMBAT_ACHIEVEMENTS_PATTERN = Pattern.compile("Congratulations, you've completed an? (?<tier>\\w+) combat task: <col=[0-9a-f]+>(?<task>(.+))</col>\\.");
private static final ImmutableList<String> RFD_TAGS = ImmutableList.of("Another Cook", "freed", "defeated", "saved");
private static final ImmutableList<String> WORD_QUEST_IN_NAME_TAGS = ImmutableList.of("Another Cook", "Doric", "Heroes", "Legends", "Observatory", "Olaf", "Waterfall");
private static final ImmutableList<String> PET_MESSAGES = ImmutableList.of("You have a funny feeling like you're being followed",
@@ -134,6 +135,7 @@ public class ScreenshotPlugin extends Plugin
private static final String SD_COLLECTION_LOG = "Collection Log";
private static final String SD_PVP_KILLS = "PvP Kills";
private static final String SD_DEATHS = "Deaths";
private static final String SD_COMBAT_ACHIEVEMENTS = "Combat Achievements";
private String clueType;
private Integer clueNumber;
@@ -494,6 +496,15 @@ public class ScreenshotPlugin extends Plugin
String fileName = "Collection log (" + entry + ")";
takeScreenshot(fileName, SD_COLLECTION_LOG);
}
if (chatMessage.contains("combat task") && config.screenshotCombatAchievements() && client.getVar(Varbits.COMBAT_ACHIEVEMENTS_POPUP) == 1)
{
String fileName = parseCombatAchievementWidget(chatMessage);
if (!fileName.isEmpty())
{
takeScreenshot(fileName, SD_COMBAT_ACHIEVEMENTS);
}
}
}
@Subscribe
@@ -652,6 +663,12 @@ public class ScreenshotPlugin extends Plugin
String fileName = "Collection log (" + entry + ")";
takeScreenshot(fileName, SD_COLLECTION_LOG);
}
if (topText.equalsIgnoreCase("Combat Task Completed!") && config.screenshotCombatAchievements() && client.getVar(Varbits.COMBAT_ACHIEVEMENTS_POPUP) == 0)
{
String entry = Text.removeTags(bottomText).substring("Task Completed: ".length());
String fileName = "Combat task (" + entry.replaceAll("[:?]", "") + ")";
takeScreenshot(fileName, SD_COMBAT_ACHIEVEMENTS);
}
notificationStarted = false;
break;
}
@@ -752,6 +769,24 @@ public class ScreenshotPlugin extends Plugin
return "High Gamble(count not found)";
}
/**
* Parses a combat achievement success chat message into a filename-safe string.
*
* @param text A received chat message which may or may not be from completing a combat achievement.
* @return A formatted string of the achieved combat task name, or the empty string if the passed message
* is not a combat achievement completion message.
*/
@VisibleForTesting
static String parseCombatAchievementWidget(final String text)
{
final Matcher m = COMBAT_ACHIEVEMENTS_PATTERN.matcher(text);
if (m.matches())
{
String task = m.group("task").replaceAll("[:?]", "");
return "Combat task (" + task + ")";
}
return "";
}
/**
* Saves a screenshot of the client window to the screenshot folder as a PNG,
@@ -760,7 +795,8 @@ public class ScreenshotPlugin extends Plugin
* @param fileName Filename to use, without file extension.
* @param subDir Subdirectory to store the captured screenshot in.
*/
private void takeScreenshot(String fileName, String subDir)
@VisibleForTesting
void takeScreenshot(String fileName, String subDir)
{
if (client.getGameState() == GameState.LOGIN_SCREEN)
{