AstralTransRocketries/HMCL
1
0
Fork 0
mirror of https://github.com/HMCL-dev/HMCL.git synced 2025-09-13 05:46:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add link to hmcl documentation page

Browse Source
This commit is contained in:
huanghongxun 2018-09-16 14:12:52 +08:00
parent 9752dea0e1
commit bc3ae5cc7d
7 changed files with 84 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
HMCL/src/main/java/org/jackhuang/hmcl/Metadata.java
View File

@ -31,5 +31,6 @@ public final class Metadata {
public static final String UPDATE_URL = System.getProperty("hmcl.update_source.override", "https://hmcl.huangyuhui.net/api/update_link"); public static final String UPDATE_URL = System.getProperty("hmcl.update_source.override", "https://hmcl.huangyuhui.net/api/update_link");
public static final String CONTACT_URL = "https://hmcl.huangyuhui.net/contact"; public static final String CONTACT_URL = "https://hmcl.huangyuhui.net/contact";
public static final String HELP_URL = "https://hmcl.huangyuhui.net/help";
public static final String PUBLISH_URL = "http://www.mcbbs.net/thread-142335-1-1.html"; public static final String PUBLISH_URL = "http://www.mcbbs.net/thread-142335-1-1.html";
} }

4
HMCL/src/main/java/org/jackhuang/hmcl/ui/SVG.java
View File

@ -146,4 +146,8 @@ public final class SVG {
public static Node export(ObjectBinding<? extends Paint> fill, double width, double height) { public static Node export(ObjectBinding<? extends Paint> fill, double width, double height) {
return createSVGPath("M23,12L19,8V11H10V13H19V16M1,18V6C1,4.89 1.9,4 3,4H15A2,2 0 0,1 17,6V9H15V6H3V18H15V15H17V18A2,2 0 0,1 15,20H3A2,2 0 0,1 1,18Z", fill, width, height); return createSVGPath("M23,12L19,8V11H10V13H19V16M1,18V6C1,4.89 1.9,4 3,4H15A2,2 0 0,1 17,6V9H15V6H3V18H15V15H17V18A2,2 0 0,1 15,20H3A2,2 0 0,1 1,18Z", fill, width, height);
} }
public static Node openInNew(ObjectBinding<? extends Paint> fill, double width, double height) {
return createSVGPath("M14,3V5H17.59L7.76,14.83L9.17,16.24L19,6.41V10H21V3M19,19H5V5H12V3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V12H19V19Z", fill, width, height);
}
} }

6
HMCL/src/main/java/org/jackhuang/hmcl/ui/SettingsPage.java
View File

@ -28,6 +28,7 @@ import javafx.beans.property.*;
import javafx.scene.control.ToggleGroup; import javafx.scene.control.ToggleGroup;
import javafx.scene.paint.Color; import javafx.scene.paint.Color;
import javafx.scene.text.Font; import javafx.scene.text.Font;
import org.jackhuang.hmcl.Metadata;
import org.jackhuang.hmcl.setting.*; import org.jackhuang.hmcl.setting.*;
import org.jackhuang.hmcl.ui.construct.Validator; import org.jackhuang.hmcl.ui.construct.Validator;
import org.jackhuang.hmcl.ui.decorator.DecoratorPage; import org.jackhuang.hmcl.ui.decorator.DecoratorPage;
@ -247,4 +248,9 @@ public final class SettingsPage extends SettingsView implements DecoratorPage {
} }
UpdateHandler.updateFrom(target); UpdateHandler.updateFrom(target);
} }
@Override
protected void onHelp() {
FXUtils.openLink(Metadata.HELP_URL);
}
} }

102
HMCL/src/main/java/org/jackhuang/hmcl/ui/SettingsView.java
View File

@ -29,6 +29,7 @@ import javafx.scene.text.TextAlignment;
import static org.jackhuang.hmcl.setting.ConfigHolder.config; import static org.jackhuang.hmcl.setting.ConfigHolder.config;
import static org.jackhuang.hmcl.ui.FXUtils.stringConverter; import static org.jackhuang.hmcl.ui.FXUtils.stringConverter;
import static org.jackhuang.hmcl.util.i18n.I18n.i18n;
import org.jackhuang.hmcl.setting.EnumBackgroundImage; import org.jackhuang.hmcl.setting.EnumBackgroundImage;
import org.jackhuang.hmcl.setting.EnumCommonDirectory; import org.jackhuang.hmcl.setting.EnumCommonDirectory;
@ -78,12 +79,12 @@ public abstract class SettingsView extends StackPane {
ComponentList settingsPane = new ComponentList(); ComponentList settingsPane = new ComponentList();
{ {
ComponentSublist updatePane = new ComponentSublist(); ComponentSublist updatePane = new ComponentSublist();
updatePane.setTitle(I18n.i18n("update")); updatePane.setTitle(i18n("update"));
updatePane.setHasSubtitle(true); updatePane.setHasSubtitle(true);
{ {
VBox headerLeft = new VBox(); VBox headerLeft = new VBox();
lblUpdate = new Label(I18n.i18n("update")); lblUpdate = new Label(i18n("update"));
lblUpdateSub = new Label(); lblUpdateSub = new Label();
lblUpdateSub.getStyleClass().setAll("subtitle-label"); lblUpdateSub.getStyleClass().setAll("subtitle-label");
@ -104,12 +105,12 @@ public abstract class SettingsView extends StackPane {
VBox content = new VBox(); VBox content = new VBox();
content.setSpacing(8); content.setSpacing(8);
chkUpdateStable = new JFXRadioButton(I18n.i18n("update.channel.stable")); chkUpdateStable = new JFXRadioButton(i18n("update.channel.stable"));
chkUpdateDev = new JFXRadioButton(I18n.i18n("update.channel.dev")); chkUpdateDev = new JFXRadioButton(i18n("update.channel.dev"));
VBox noteWrapper = new VBox(); VBox noteWrapper = new VBox();
noteWrapper.setStyle("-fx-padding: 10 0 0 0;"); noteWrapper.setStyle("-fx-padding: 10 0 0 0;");
lblUpdateNote = new Text(I18n.i18n("update.note")); lblUpdateNote = new Text(i18n("update.note"));
noteWrapper.getChildren().setAll(lblUpdateNote); noteWrapper.getChildren().setAll(lblUpdateNote);
content.getChildren().setAll(chkUpdateStable, chkUpdateDev, noteWrapper); content.getChildren().setAll(chkUpdateStable, chkUpdateDev, noteWrapper);
@ -119,11 +120,35 @@ public abstract class SettingsView extends StackPane {
settingsPane.getContent().add(updatePane); settingsPane.getContent().add(updatePane);
} }
{
BorderPane updatePane = new BorderPane();
{
VBox headerLeft = new VBox();
Label help = new Label(i18n("help"));
Label helpSubtitle = new Label(i18n("help.detail"));
helpSubtitle.getStyleClass().setAll("subtitle-label");
headerLeft.getChildren().setAll(help, helpSubtitle);
updatePane.setLeft(headerLeft);
}
{
JFXButton btnExternal = new JFXButton();
btnExternal.setOnMouseClicked(e -> onHelp());
btnExternal.getStyleClass().setAll("toggle-icon4");
btnExternal.setGraphic(SVG.openInNew(Theme.blackFillBinding(), -1, -1));
updatePane.setRight(btnExternal);
}
settingsPane.getContent().add(updatePane);
}
{ {
fileCommonLocation = new MultiFileItem<>(true); fileCommonLocation = new MultiFileItem<>(true);
fileCommonLocation.setTitle(I18n.i18n("launcher.common_directory")); fileCommonLocation.setTitle(i18n("launcher.common_directory"));
fileCommonLocation.setDirectory(true); fileCommonLocation.setDirectory(true);
fileCommonLocation.setChooserTitle(I18n.i18n("launcher.common_directory.choose")); fileCommonLocation.setChooserTitle(i18n("launcher.common_directory.choose"));
fileCommonLocation.setHasSubtitle(true); fileCommonLocation.setHasSubtitle(true);
fileCommonLocation.setCustomText("settings.custom"); fileCommonLocation.setCustomText("settings.custom");
@ -132,10 +157,10 @@ public abstract class SettingsView extends StackPane {
{ {
backgroundItem = new MultiFileItem<>(true); backgroundItem = new MultiFileItem<>(true);
backgroundItem.setTitle(I18n.i18n("launcher.background")); backgroundItem.setTitle(i18n("launcher.background"));
backgroundItem.setChooserTitle(I18n.i18n("launcher.background.choose")); backgroundItem.setChooserTitle(i18n("launcher.background.choose"));
backgroundItem.setHasSubtitle(true); backgroundItem.setHasSubtitle(true);
backgroundItem.setCustomText(I18n.i18n("settings.custom")); backgroundItem.setCustomText(i18n("settings.custom"));
settingsPane.getContent().add(backgroundItem); settingsPane.getContent().add(backgroundItem);
} }
@ -143,7 +168,7 @@ public abstract class SettingsView extends StackPane {
{ {
BorderPane borderPane = new BorderPane(); BorderPane borderPane = new BorderPane();
Label left = new Label(I18n.i18n("settings.launcher.enable_game_list")); Label left = new Label(i18n("settings.launcher.enable_game_list"));
BorderPane.setAlignment(left, Pos.CENTER_LEFT); BorderPane.setAlignment(left, Pos.CENTER_LEFT);
borderPane.setLeft(left); borderPane.setLeft(left);
@ -160,14 +185,14 @@ public abstract class SettingsView extends StackPane {
{ {
BorderPane downloadSourcePane = new BorderPane(); BorderPane downloadSourcePane = new BorderPane();
{ {
Label label = new Label(I18n.i18n("settings.launcher.download_source")); Label label = new Label(i18n("settings.launcher.download_source"));
BorderPane.setAlignment(label, Pos.CENTER_LEFT); BorderPane.setAlignment(label, Pos.CENTER_LEFT);
downloadSourcePane.setLeft(label); downloadSourcePane.setLeft(label);
} }
{ {
cboDownloadSource = new JFXComboBox<>(); cboDownloadSource = new JFXComboBox<>();
cboDownloadSource.setConverter(stringConverter(key -> I18n.i18n("download.provider." + key))); cboDownloadSource.setConverter(stringConverter(key -> i18n("download.provider." + key)));
downloadSourcePane.setRight(cboDownloadSource); downloadSourcePane.setRight(cboDownloadSource);
} }
settingsPane.getContent().add(downloadSourcePane); settingsPane.getContent().add(downloadSourcePane);
@ -176,7 +201,7 @@ public abstract class SettingsView extends StackPane {
{ {
BorderPane languagePane = new BorderPane(); BorderPane languagePane = new BorderPane();
Label left = new Label(I18n.i18n("settings.launcher.language")); Label left = new Label(i18n("settings.launcher.language"));
BorderPane.setAlignment(left, Pos.CENTER_LEFT); BorderPane.setAlignment(left, Pos.CENTER_LEFT);
languagePane.setLeft(left); languagePane.setLeft(left);
@ -190,13 +215,13 @@ public abstract class SettingsView extends StackPane {
{ {
ComponentList proxyList = new ComponentList(); ComponentList proxyList = new ComponentList();
proxyList.setTitle(I18n.i18n("settings.launcher.proxy")); proxyList.setTitle(i18n("settings.launcher.proxy"));
VBox proxyWrapper = new VBox(); VBox proxyWrapper = new VBox();
proxyWrapper.setSpacing(10); proxyWrapper.setSpacing(10);
{ {
chkDisableProxy = new JFXCheckBox(I18n.i18n("settings.launcher.proxy.disable")); chkDisableProxy = new JFXCheckBox(i18n("settings.launcher.proxy.disable"));
proxyWrapper.getChildren().add(chkDisableProxy); proxyWrapper.getChildren().add(chkDisableProxy);
} }
@ -209,8 +234,8 @@ public abstract class SettingsView extends StackPane {
{ {
HBox hBox = new HBox(); HBox hBox = new HBox();
chkProxyHttp = new JFXRadioButton(I18n.i18n("settings.launcher.proxy.http")); chkProxyHttp = new JFXRadioButton(i18n("settings.launcher.proxy.http"));
chkProxySocks = new JFXRadioButton(I18n.i18n("settings.launcher.proxy.socks")); chkProxySocks = new JFXRadioButton(i18n("settings.launcher.proxy.socks"));
hBox.getChildren().setAll(chkProxyHttp, chkProxySocks); hBox.getChildren().setAll(chkProxyHttp, chkProxySocks);
proxyPane.getChildren().add(hBox); proxyPane.getChildren().add(hBox);
} }
@ -224,7 +249,7 @@ public abstract class SettingsView extends StackPane {
gridPane.getRowConstraints().setAll(new RowConstraints(), new RowConstraints()); gridPane.getRowConstraints().setAll(new RowConstraints(), new RowConstraints());
{ {
Label host = new Label(I18n.i18n("settings.launcher.proxy.host")); Label host = new Label(i18n("settings.launcher.proxy.host"));
GridPane.setRowIndex(host, 1); GridPane.setRowIndex(host, 1);
GridPane.setColumnIndex(host, 0); GridPane.setColumnIndex(host, 0);
GridPane.setHalignment(host, HPos.RIGHT); GridPane.setHalignment(host, HPos.RIGHT);
@ -240,7 +265,7 @@ public abstract class SettingsView extends StackPane {
} }
{ {
Label port = new Label(I18n.i18n("settings.launcher.proxy.port")); Label port = new Label(i18n("settings.launcher.proxy.port"));
GridPane.setRowIndex(port, 2); GridPane.setRowIndex(port, 2);
GridPane.setColumnIndex(port, 0); GridPane.setColumnIndex(port, 0);
GridPane.setHalignment(port, HPos.RIGHT); GridPane.setHalignment(port, HPos.RIGHT);
@ -253,7 +278,7 @@ public abstract class SettingsView extends StackPane {
GridPane.setRowIndex(txtProxyPort, 2); GridPane.setRowIndex(txtProxyPort, 2);
GridPane.setColumnIndex(txtProxyPort, 1); GridPane.setColumnIndex(txtProxyPort, 1);
FXUtils.setValidateWhileTextChanged(txtProxyPort, true); FXUtils.setValidateWhileTextChanged(txtProxyPort, true);
txtProxyHost.getValidators().setAll(new NumberValidator(I18n.i18n("input.number"), false)); txtProxyHost.getValidators().setAll(new NumberValidator(i18n("input.number"), false));
gridPane.getChildren().add(txtProxyPort); gridPane.getChildren().add(txtProxyPort);
} }
proxyPane.getChildren().add(gridPane); proxyPane.getChildren().add(gridPane);
@ -263,7 +288,7 @@ public abstract class SettingsView extends StackPane {
VBox vBox = new VBox(); VBox vBox = new VBox();
vBox.setStyle("-fx-padding: 20 0 20 5;"); vBox.setStyle("-fx-padding: 20 0 20 5;");
chkProxyAuthentication = new JFXCheckBox(I18n.i18n("settings.launcher.proxy.authentication")); chkProxyAuthentication = new JFXCheckBox(i18n("settings.launcher.proxy.authentication"));
vBox.getChildren().setAll(chkProxyAuthentication); vBox.getChildren().setAll(chkProxyAuthentication);
proxyPane.getChildren().add(vBox); proxyPane.getChildren().add(vBox);
@ -278,7 +303,7 @@ public abstract class SettingsView extends StackPane {
authPane.getRowConstraints().setAll(new RowConstraints(), new RowConstraints()); authPane.getRowConstraints().setAll(new RowConstraints(), new RowConstraints());
{ {
Label username = new Label(I18n.i18n("settings.launcher.proxy.username")); Label username = new Label(i18n("settings.launcher.proxy.username"));
GridPane.setRowIndex(username, 0); GridPane.setRowIndex(username, 0);
GridPane.setColumnIndex(username, 0); GridPane.setColumnIndex(username, 0);
authPane.getChildren().add(username); authPane.getChildren().add(username);
@ -293,7 +318,7 @@ public abstract class SettingsView extends StackPane {
} }
{ {
Label password = new Label(I18n.i18n("settings.launcher.proxy.password")); Label password = new Label(i18n("settings.launcher.proxy.password"));
GridPane.setRowIndex(password, 1); GridPane.setRowIndex(password, 1);
GridPane.setColumnIndex(password, 0); GridPane.setColumnIndex(password, 0);
authPane.getChildren().add(password); authPane.getChildren().add(password);
@ -318,7 +343,7 @@ public abstract class SettingsView extends StackPane {
{ {
BorderPane themePane = new BorderPane(); BorderPane themePane = new BorderPane();
Label left = new Label(I18n.i18n("settings.launcher.theme")); Label left = new Label(i18n("settings.launcher.theme"));
BorderPane.setAlignment(left, Pos.CENTER_LEFT); BorderPane.setAlignment(left, Pos.CENTER_LEFT);
themePane.setLeft(left); themePane.setLeft(left);
@ -338,7 +363,7 @@ public abstract class SettingsView extends StackPane {
BorderPane borderPane = new BorderPane(); BorderPane borderPane = new BorderPane();
fontPane.getChildren().add(borderPane); fontPane.getChildren().add(borderPane);
{ {
Label left = new Label(I18n.i18n("settings.launcher.log_font")); Label left = new Label(i18n("settings.launcher.log_font"));
BorderPane.setAlignment(left, Pos.CENTER_LEFT); BorderPane.setAlignment(left, Pos.CENTER_LEFT);
borderPane.setLeft(left); borderPane.setLeft(left);
} }
@ -385,65 +410,65 @@ public abstract class SettingsView extends StackPane {
gridPane.getRowConstraints().setAll(row, row, row, row, row, row); gridPane.getRowConstraints().setAll(row, row, row, row, row, row);
{ {
Label label = new Label(I18n.i18n("about.copyright")); Label label = new Label(i18n("about.copyright"));
GridPane.setRowIndex(label, 0); GridPane.setRowIndex(label, 0);
GridPane.setColumnIndex(label, 0); GridPane.setColumnIndex(label, 0);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.copyright.statement")); Label label = new Label(i18n("about.copyright.statement"));
label.setWrapText(true); label.setWrapText(true);
GridPane.setRowIndex(label, 0); GridPane.setRowIndex(label, 0);
GridPane.setColumnIndex(label, 1); GridPane.setColumnIndex(label, 1);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.author")); Label label = new Label(i18n("about.author"));
GridPane.setRowIndex(label, 1); GridPane.setRowIndex(label, 1);
GridPane.setColumnIndex(label, 0); GridPane.setColumnIndex(label, 0);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.author.statement")); Label label = new Label(i18n("about.author.statement"));
label.setWrapText(true); label.setWrapText(true);
GridPane.setRowIndex(label, 1); GridPane.setRowIndex(label, 1);
GridPane.setColumnIndex(label, 1); GridPane.setColumnIndex(label, 1);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.thanks_to")); Label label = new Label(i18n("about.thanks_to"));
GridPane.setRowIndex(label, 2); GridPane.setRowIndex(label, 2);
GridPane.setColumnIndex(label, 0); GridPane.setColumnIndex(label, 0);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.thanks_to.statement")); Label label = new Label(i18n("about.thanks_to.statement"));
label.setWrapText(true); label.setWrapText(true);
GridPane.setRowIndex(label, 2); GridPane.setRowIndex(label, 2);
GridPane.setColumnIndex(label, 1); GridPane.setColumnIndex(label, 1);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.dependency")); Label label = new Label(i18n("about.dependency"));
GridPane.setRowIndex(label, 3); GridPane.setRowIndex(label, 3);
GridPane.setColumnIndex(label, 0); GridPane.setColumnIndex(label, 0);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.dependency.statement")); Label label = new Label(i18n("about.dependency.statement"));
label.setWrapText(true); label.setWrapText(true);
GridPane.setRowIndex(label, 3); GridPane.setRowIndex(label, 3);
GridPane.setColumnIndex(label, 1); GridPane.setColumnIndex(label, 1);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.claim")); Label label = new Label(i18n("about.claim"));
GridPane.setRowIndex(label, 4); GridPane.setRowIndex(label, 4);
GridPane.setColumnIndex(label, 0); GridPane.setColumnIndex(label, 0);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.claim.statement")); Label label = new Label(i18n("about.claim.statement"));
label.setWrapText(true); label.setWrapText(true);
label.setTextAlignment(TextAlignment.JUSTIFY); label.setTextAlignment(TextAlignment.JUSTIFY);
GridPane.setRowIndex(label, 4); GridPane.setRowIndex(label, 4);
@ -451,13 +476,13 @@ public abstract class SettingsView extends StackPane {
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.open_source")); Label label = new Label(i18n("about.open_source"));
GridPane.setRowIndex(label, 5); GridPane.setRowIndex(label, 5);
GridPane.setColumnIndex(label, 0); GridPane.setColumnIndex(label, 0);
gridPane.getChildren().add(label); gridPane.getChildren().add(label);
} }
{ {
Label label = new Label(I18n.i18n("about.open_source.statement")); Label label = new Label(i18n("about.open_source.statement"));
label.setWrapText(true); label.setWrapText(true);
GridPane.setRowIndex(label, 5); GridPane.setRowIndex(label, 5);
GridPane.setColumnIndex(label, 1); GridPane.setColumnIndex(label, 1);
@ -473,4 +498,5 @@ public abstract class SettingsView extends StackPane {
} }
protected abstract void onUpdate(); protected abstract void onUpdate();
protected abstract void onHelp();
} }

3
HMCL/src/main/resources/assets/lang/I18N.properties
View File

@ -111,6 +111,9 @@ folder.screenshots=Screenshots
general.prompt.empty=(None) general.prompt.empty=(None)
help=Documentations
help.detail=For datapacks, modpacks, etc. makers.
input.email=The username must be an e-mail. input.email=The username must be an e-mail.
input.number=Must be a number. input.number=Must be a number.
input.not_empty=Required field input.not_empty=Required field

3
HMCL/src/main/resources/assets/lang/I18N_zh.properties
View File

@ -111,6 +111,9 @@ folder.screenshots=截圖資料夾
general.prompt.empty=(無) general.prompt.empty=(無)
help=HMCL 幫助文檔
help.detail=可查閱資料包、整合包製作指南等內容。
input.email=「使用者名稱」必須是電子信箱格式 input.email=「使用者名稱」必須是電子信箱格式
input.number=必須是數字 input.number=必須是數字
input.not_empty=必填 input.not_empty=必填

3
HMCL/src/main/resources/assets/lang/I18N_zh_CN.properties
View File

@ -111,6 +111,9 @@ folder.screenshots=截图文件夹
general.prompt.empty=（无） general.prompt.empty=（无）
help=HMCL 帮助文档
help.detail=可查阅数据包、整合包制作指南等内容。
input.email=用户名必须是邮箱 input.email=用户名必须是邮箱
input.number=必须是数字 input.number=必须是数字
input.not_empty=必填项 input.not_empty=必填项