Files
Grasscutter/src/main/java/emu/grasscutter/tools/Tools.java
2023-08-27 23:23:01 -04:00

461 lines
21 KiB
Java

package emu.grasscutter.tools;
import static emu.grasscutter.utils.FileUtils.getResourcePath;
import static emu.grasscutter.utils.lang.Language.getTextMapKey;
import emu.grasscutter.*;
import emu.grasscutter.command.*;
import emu.grasscutter.data.*;
import emu.grasscutter.data.common.ItemUseData;
import emu.grasscutter.data.excels.*;
import emu.grasscutter.data.excels.achievement.AchievementData;
import emu.grasscutter.data.excels.avatar.AvatarData;
import emu.grasscutter.utils.*;
import emu.grasscutter.utils.lang.Language;
import emu.grasscutter.utils.lang.Language.TextStrings;
import it.unimi.dsi.fastutil.ints.*;
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.nio.file.*;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.*;
import java.util.function.Function;
import java.util.stream.*;
import lombok.*;
public final class Tools {
/**
* This generates the GM handbooks with a message by default.
*
* @throws Exception If an error occurs while generating the handbooks.
*/
public static void createGmHandbooks() throws Exception {
Tools.createGmHandbooks(true);
}
/**
* Generates a GM handbook for each language.
*
* @param message Should a message be printed to the console?
* @throws Exception If an error occurs while generating the handbooks.
*/
public static void createGmHandbooks(boolean message) throws Exception {
// Check if the GM Handbook directory exists.
val handbookDir = new File("GM Handbook");
if (handbookDir.exists()) return;
val languages = Language.TextStrings.getLanguages();
ResourceLoader.loadAll();
val mainQuestTitles =
new Int2IntRBTreeMap(
GameData.getMainQuestDataMap().int2ObjectEntrySet().stream()
.collect(
Collectors.toMap(
e -> e.getIntKey(), e -> (int) e.getValue().getTitleTextMapHash())));
// val questDescs = new
// Int2IntRBTreeMap(GameData.getQuestDataMap().int2ObjectEntrySet().stream().collect(Collectors.toMap(e -> (int) e.getIntKey(), e -> (int) e.getValue().getDescTextMapHash())));
val avatarDataMap = new Int2ObjectRBTreeMap<>(GameData.getAvatarDataMap());
val itemDataMap = new Int2ObjectRBTreeMap<>(GameData.getItemDataMap());
val monsterDataMap = new Int2ObjectRBTreeMap<>(GameData.getMonsterDataMap());
val sceneDataMap = new Int2ObjectRBTreeMap<>(GameData.getSceneDataMap());
val questDataMap = new Int2ObjectRBTreeMap<>(GameData.getQuestDataMap());
val achievementDataMap = new Int2ObjectRBTreeMap<>(GameData.getAchievementDataMap());
Function<SortedMap<?, ?>, String> getPad = m -> "%" + m.lastKey().toString().length() + "s : ";
// Create builders and helper functions
val handbookBuilders =
IntStream.range(0, TextStrings.NUM_LANGUAGES).mapToObj(i -> new StringBuilder()).toList();
var h =
new Object() {
void newLine(String line) {
handbookBuilders.forEach(b -> b.append(line + "\n"));
}
void newSection(String title) {
newLine("\n\n// " + title);
}
void newTranslatedLine(String template, TextStrings... textstrings) {
for (int i = 0; i < TextStrings.NUM_LANGUAGES; i++) {
String s = template;
for (int j = 0; j < textstrings.length; j++)
try {
s = s.replace("{" + j + "}", textstrings[j].strings[i]);
} catch (NullPointerException ignored) {
// TextMap cache is outdated.
j--; // Retry the action.
Language.loadTextMaps(true);
}
handbookBuilders.get(i).append(s + "\n");
}
}
void newTranslatedLine(String template, long... hashes) {
newTranslatedLine(
template,
LongStream.of(hashes)
.mapToObj(hash -> getTextMapKey(hash))
.toArray(TextStrings[]::new));
}
};
// Preamble
h.newLine("// Grasscutter " + GameConstants.VERSION + " GM Handbook");
h.newLine(
"// Created "
+ DateTimeFormatter.ofPattern("yyyy/MM/dd HH:mm:ss").format(LocalDateTime.now()));
// Commands
h.newSection("Commands");
final List<CommandHandler> cmdList = CommandMap.getInstance().getHandlersAsList();
final String padCmdLabel =
"%"
+ cmdList.stream()
.map(CommandHandler::getLabel)
.map(String::length)
.max(Integer::compare)
.get()
+ "s : ";
for (CommandHandler cmd : cmdList) {
final String label = padCmdLabel.formatted(cmd.getLabel());
final String descKey = cmd.getDescriptionKey();
for (int i = 0; i < TextStrings.NUM_LANGUAGES; i++) {
String desc =
languages.get(i).get(descKey).replace("\n", "\n\t\t\t\t").replace("\t", " ");
handbookBuilders.get(i).append(label + desc + "\n");
}
}
// Avatars
h.newSection("Avatars");
val avatarPre = getPad.apply(avatarDataMap);
avatarDataMap.forEach(
(id, data) ->
h.newTranslatedLine(avatarPre.formatted(id) + "{0}", data.getNameTextMapHash()));
// Items
h.newSection("Items");
val itemPre = getPad.apply(itemDataMap);
itemDataMap.forEach(
(id, data) -> {
val name = getTextMapKey(data.getNameTextMapHash());
switch (data.getMaterialType()) {
case MATERIAL_BGM:
val bgmName =
Optional.ofNullable(data.getItemUse())
.map(u -> u.get(0))
.map(ItemUseData::getUseParam)
.filter(u -> u.length > 0)
.map(u -> Integer.parseInt(u[0]))
.map(bgmId -> GameData.getHomeWorldBgmDataMap().get((int) bgmId))
.map(HomeWorldBgmData::getBgmNameTextMapHash)
.map(Language::getTextMapKey);
if (bgmName.isPresent()) {
h.newTranslatedLine(itemPre.formatted(id) + "{0} - {1}", name, bgmName.get());
return;
} // Fall-through
default:
h.newTranslatedLine(itemPre.formatted(id) + "{0}", name);
return;
}
});
// Monsters
h.newSection("Monsters");
val monsterPre = getPad.apply(monsterDataMap);
monsterDataMap.forEach(
(id, data) ->
h.newTranslatedLine(
monsterPre.formatted(id) + data.getMonsterName() + " - {0}",
data.getNameTextMapHash()));
// Scenes - no translations
h.newSection("Scenes");
val padSceneId = getPad.apply(sceneDataMap);
sceneDataMap.forEach((id, data) -> h.newLine(padSceneId.formatted(id) + data.getScriptData()));
// Quests
h.newSection("Quests");
val padQuestId = getPad.apply(questDataMap);
questDataMap.forEach(
(id, data) ->
h.newTranslatedLine(
padQuestId.formatted(id) + "{0} - {1}",
mainQuestTitles.get(data.getMainId()),
data.getDescTextMapHash()));
// Achievements
h.newSection("Achievements");
val padAchievementId = getPad.apply(achievementDataMap);
achievementDataMap.values().stream()
.filter(AchievementData::isUsed)
.forEach(
data -> {
h.newTranslatedLine(
padAchievementId.formatted(data.getId()) + "{0} - {1}",
data.getTitleTextMapHash(),
data.getDescTextMapHash());
});
// Write txt files
for (int i = 0; i < TextStrings.NUM_LANGUAGES; i++) {
File GMHandbookOutputpath = new File("./GM Handbook");
GMHandbookOutputpath.mkdir();
final String fileName =
"./GM Handbook/GM Handbook - %s.txt".formatted(TextStrings.ARR_LANGUAGES[i]);
try (PrintWriter writer =
new PrintWriter(
new OutputStreamWriter(new FileOutputStream(fileName), StandardCharsets.UTF_8),
false)) {
writer.write(handbookBuilders.get(i).toString());
}
}
if (message) Grasscutter.getLogger().info("GM Handbooks generated!");
}
public static List<String> createGachaMappingJsons() {
final int NUM_LANGUAGES = Language.TextStrings.NUM_LANGUAGES;
final Language.TextStrings CHARACTER = Language.getTextMapKey(4233146695L); // "Character" in EN
final Language.TextStrings WEAPON = Language.getTextMapKey(4231343903L); // "Weapon" in EN
final Language.TextStrings STANDARD_WISH =
Language.getTextMapKey(332935371L); // "Standard Wish" in EN
final Language.TextStrings CHARACTER_EVENT_WISH =
Language.getTextMapKey(2272170627L); // "Character Event Wish" in EN
final Language.TextStrings CHARACTER_EVENT_WISH_2 =
Language.getTextMapKey(3352513147L); // "Character Event Wish-2" in EN
final Language.TextStrings WEAPON_EVENT_WISH =
Language.getTextMapKey(2864268523L); // "Weapon Event Wish" in EN
final List<StringBuilder> sbs = new ArrayList<>(NUM_LANGUAGES);
for (int langIdx = 0; langIdx < NUM_LANGUAGES; langIdx++)
sbs.add(new StringBuilder("{\n")); // Web requests should never need Windows line endings
// Avatars
GameData.getAvatarDataMap()
.keySet()
.intStream()
.sorted()
.forEach(
id -> {
AvatarData data = GameData.getAvatarDataMap().get(id);
int avatarID = data.getId();
if (avatarID >= 11000000) { // skip test avatar
return;
}
String color =
switch (data.getQualityType()) {
case "QUALITY_PURPLE" -> "purple";
case "QUALITY_ORANGE" -> "yellow";
case "QUALITY_BLUE" -> "blue";
default -> "";
};
Language.TextStrings avatarName = Language.getTextMapKey(data.getNameTextMapHash());
for (int langIdx = 0; langIdx < NUM_LANGUAGES; langIdx++) {
sbs.get(langIdx)
.append("\t\"")
.append(avatarID % 1000 + 1000)
.append("\": [\"")
.append(avatarName.get(langIdx))
.append(" (")
.append(CHARACTER.get(langIdx))
.append(")\", \"")
.append(color)
.append("\"],\n");
}
});
// Weapons
GameData.getItemDataMap()
.keySet()
.intStream()
.sorted()
.forEach(
id -> {
ItemData data = GameData.getItemDataMap().get(id);
if (data.getId() <= 11101 || data.getId() >= 20000) {
return; // skip non weapon items
}
String color =
switch (data.getRankLevel()) {
case 3 -> "blue";
case 4 -> "purple";
case 5 -> "yellow";
default -> null;
};
if (color == null) return; // skip unnecessary entries
Language.TextStrings weaponName = Language.getTextMapKey(data.getNameTextMapHash());
for (int langIdx = 0; langIdx < NUM_LANGUAGES; langIdx++) {
sbs.get(langIdx)
.append("\t\"")
.append(data.getId())
.append("\": [\"")
.append(weaponName.get(langIdx).replaceAll("\"", "\\\\\""))
.append(" (")
.append(WEAPON.get(langIdx))
.append(")\", \"")
.append(color)
.append("\"],\n");
}
});
for (int langIdx = 0; langIdx < NUM_LANGUAGES; langIdx++) {
sbs.get(langIdx)
.append("\t\"200\": \"")
.append(STANDARD_WISH.get(langIdx))
.append("\",\n\t\"301\": \"")
.append(CHARACTER_EVENT_WISH.get(langIdx))
.append("\",\n\t\"400\": \"")
.append(CHARACTER_EVENT_WISH_2.get(langIdx))
.append("\",\n\t\"302\": \"")
.append(WEAPON_EVENT_WISH.get(langIdx))
.append("\"\n}");
}
return sbs.stream().map(StringBuilder::toString).toList();
}
public static void createGachaMappings(Path location) throws IOException {
ResourceLoader.loadResources();
List<String> jsons = createGachaMappingJsons();
var usedLocales = new HashSet<String>();
StringBuilder sb = new StringBuilder("mappings = {\n");
for (int i = 0; i < Language.TextStrings.NUM_LANGUAGES; i++) {
String locale =
Language.TextStrings.ARR_GC_LANGUAGES[i]
.toLowerCase(); // TODO: change the templates to not use lowercased locale codes
if (usedLocales.add(
locale)) { // Some locales fallback to en-us, we don't want to redefine en-us with
// vietnamese strings
sb.append("\t\"%s\": ".formatted(locale));
sb.append(jsons.get(i).replace("\n", "\n\t") + ",\n");
}
}
sb.setLength(sb.length() - 2); // Delete trailing ",\n"
sb.append("\n}");
Files.createDirectories(location.getParent());
Files.writeString(location, sb);
Grasscutter.getLogger().debug("Mappings generated to " + location);
}
public static List<String> getAvailableLanguage() {
List<String> availableLangList = new ArrayList<>();
try {
Files.newDirectoryStream(getResourcePath("TextMap"), "TextMap*.json")
.forEach(
path -> {
availableLangList.add(
path.getFileName()
.toString()
.replace("TextMap", "")
.replace(".json", "")
.toLowerCase());
});
} catch (IOException e) {
Grasscutter.getLogger().error("Failed to get available languages:", e);
}
return availableLangList;
}
@Deprecated(forRemoval = true, since = "1.2.3")
public static String getLanguageOption() {
List<String> availableLangList = getAvailableLanguage();
// Use system out for better format
if (availableLangList.size() == 1) {
return availableLangList.get(0).toUpperCase();
}
StringBuilder stagedMessage = new StringBuilder();
stagedMessage.append(
"The following languages mappings are available, please select one: [default: EN] \n");
StringBuilder groupedLangList = new StringBuilder(">\t");
String input;
int groupedLangCount = 0;
for (String availableLanguage : availableLangList) {
groupedLangCount++;
groupedLangList.append(availableLanguage).append("\t");
if (groupedLangCount == 6) {
stagedMessage.append(groupedLangList).append("\n");
groupedLangCount = 0;
groupedLangList = new StringBuilder(">\t");
}
}
if (groupedLangCount > 0) {
stagedMessage.append(groupedLangList).append("\n");
}
stagedMessage.append("\nYour choice: [EN] ");
input = Grasscutter.getConsole().readLine(stagedMessage.toString());
if (availableLangList.contains(input.toLowerCase())) {
return input.toUpperCase();
}
Grasscutter.getLogger().info("Invalid option. Will use EN (English) as fallback.");
return "EN";
}
/**
* Parses the 'resources.info' file found in resources.
*
* @return A {@link ResourceInfo} object containing the parsed data.
*/
public static ResourceInfo resourcesInfo() {
var file = FileUtils.getResourcePath("resources.info");
try (var reader = Files.newBufferedReader(file, StandardCharsets.UTF_8)) {
var resourceInfo = ResourceInfo.builder();
reader
.lines()
.forEach(
line -> {
var split = line.split(":");
if (split.length != 2) return;
var key = split[0].trim();
var value = split[1].trim();
// Apply the value to the correct field.
switch (key) {
case "repo" -> resourceInfo.repository(value);
case "ver" -> resourceInfo.version(value);
case "patches" -> resourceInfo.patches(value);
case "scripts" -> resourceInfo.scripts(ScriptsType.valueOf(value.toUpperCase()));
case "hasnolocals" -> resourceInfo.hasNoLocals(Boolean.parseBoolean(value));
case "hasserverres" -> resourceInfo.hasServerResources(
Boolean.parseBoolean(value));
case "hasscenescriptdata" -> resourceInfo.hasSceneScriptData(
Boolean.parseBoolean(value));
}
});
return resourceInfo.build();
} catch (Exception ignored) {
return new ResourceInfo(null, null, null, ScriptsType.UNKNOWN, false, false, false);
}
}
@AllArgsConstructor
@Builder
public static class ResourceInfo {
private final String repository;
private final String version;
private final String patches;
private final ScriptsType scripts;
private final boolean hasNoLocals;
private final boolean hasServerResources;
private final boolean hasSceneScriptData;
@Override
public String toString() {
return JsonUtils.encode(this);
}
}
public enum ScriptsType {
OFFICIAL,
DUMPED,
UNKNOWN
}
}