Skip to content

Commit

Permalink
Updates in screenshots and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cesar-rgon committed Oct 25, 2019
1 parent 13755d5 commit 0799b42
Show file tree
Hide file tree
Showing 20 changed files with 68 additions and 51 deletions.
52 changes: 29 additions & 23 deletions LEEME.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Aplicación para personalizar y lanzar fácilmente un servidor de Killing Floor
> 4. [Vista rapida](#vista-rapida)
> - [Pagina principal](#pagina-principal)
> - [Pagina WebAdmin](#pagina-webadmin)
> - [Pagina instalar o actualizar](#pagina-instalar-o-actualizar)
> - [Pagina mapas y mods](#pagina-mapas-y-mods)
> - [Pagina de la consola](#pagina-de-la-consola)
> - [Pagina instalar o actualizar](#pagina-instalar-o-actualizar)
> - [Configuracion-Perfiles](#configuracion-perfiles)
> - [Configuracion-Tipos de juegos](#configuracion-tipos-de-juegos)
> - [Configuracion-Dificultades](#configuracion-dificultades)
Expand All @@ -35,7 +36,7 @@ Aplicación para personalizar y lanzar fácilmente un servidor de Killing Floor
## Caracteristicas

```
Versión: 2.0.2 final
Versión: 2.0.3 final
S.O. soportados: Microsoft Windows y Linux (Ubuntu/Debian)
Autor: César Rodríguez González
Idiomas: Inglés, Español, Francés
Expand Down Expand Up @@ -122,21 +123,21 @@ $ java -jar SimpleKF2ServerLauncher.jar

* _Contraseña web_: Este campo es opcional. Permite proteger la página de WebAdmin con una contraseña para autenticarse.

* _Toma de control_: Si este check está habilitado, otras personas pueden tomar control del servidor, esto es, cambiar la contraseña y otras configuraciones, etc.

* _Puertos_: Los puertos son opcionales. Necesitas abrir los puertos en tu router y firewall. Si se lanza más de un servidor, los puertos deben ser diferentes entre ellos (una configuración por perfil).

* _Tu clan_: Este campo es opcional.
* _Parámetros personalizados_: Este campo es opcional. Define parámetros adicionales. El formato debe ser: [?]parametro1=valor1?parametror2=valor2?...?parametroN=valorN

* _Tu página web_: Este campo es opcional.
[?] significa: opcionalmente puedes comenzar los parámetros por "?"

* _URL imágen servidor_: Este campo es opcional. Este enlace debe corresponder a una imagen subida a internet que será usada como imágen de bienvenida en el servidor de Killing Floor 2. El formato y resolución debe ser PNG 512x256 píxeles.

* _Tu clan_: Este campo es opcional.

* _Mensaje de bienvenida_: Este campo es opcional. Es un mensaje de bienvenida en la pantalla iniciar del servidor.

* _Parámetros personalizados_: Este campo es opcional. Define parámetros adicionales. El formato debe ser: [?]parametro1=valor1?parametror2=valor2?...?parametroN=valorN

[?] significa: opcionalmente puedes comenzar los parámetros por "?"
* _Tu página web_: Este campo es opcional.

* _Consola_: Este campo es rellenado automáticamente cuando se ejecuta el servidor. Está compuesto por comandos de consola necesarios para ejecutar el servidor.
* _Mensaje de bienvenida_: Este campo es opcional. Es un mensaje de bienvenida en la pantalla iniciar del servidor.

* _Ejecutar servidor_: Ejecuta un servidor Killing Floor 2 con los filtros especificados. Todos los filtros obligatorios deben ser especificados. Los ficheros de configuración del servidor están ubicados en la carpeta: KFGame/Config/NOMBREPERFIL. De esta manera, los ficheros de configuración originales localizados en la carpeta: KFGame/Config nunca son modificados.
Si hay más de un perfil definido, puedes lanzar múltiples servidores a la vez (uno por perfil).
Expand All @@ -150,19 +151,6 @@ WebAdmin te permite gestionar y controlar el servidor de Killing Floor 2.

![Launcher screenshot](src/main/resources/images/documentation/screenshot02.png)

#### Pagina instalar o actualizar
En esta sección puedes instalar o actualizar el servidor de Killing Floor 2.

![Launcher screenshot](src/main/resources/images/documentation/screenshot03.png)

* _Carpeta de instalación_: Este campo es obligatorio. Necesario para encontrar la carpeta local donde el servidor debe ser instalado.

* _Validar ficheros_: Este campo es opcional. Si está activado, la operación de instalar/actualizar revisa la integridad de los ficheros del servidor. Es una operación lenta.

* _¿Actualizar a beta?_: Este campo es opcional. Si está activado, la operación actualiza a una versión beta del juego (si estuviera disponible).

* _Rama beta_: Este campo es opcional. El usuario especifica el nombre de la rama beta (sólamente usado cuando el check anterior ha sido activado).

#### Pagina Mapas y Mods
En esta sección puedes gestionar mapas personalizados, mods y mapas oficiales presentes en el servidor.

Expand All @@ -184,6 +172,24 @@ En esta sección puedes gestionar mapas personalizados, mods y mapas oficiales p

![Launcher screenshot](src/main/resources/images/documentation/screenshot05.png)

#### Pagina de la consola
En esta sección puedes ver los comandos generados por el lanzador cuando ejecutas o te unes a un servidor.

![Launcher screenshot](src/main/resources/images/documentation/screenshot11.png)

#### Pagina instalar o actualizar
En esta sección puedes instalar o actualizar el servidor de Killing Floor 2.

![Launcher screenshot](src/main/resources/images/documentation/screenshot03.png)

* _Carpeta de instalación_: Este campo es obligatorio. Necesario para encontrar la carpeta local donde el servidor debe ser instalado.

* _Validar ficheros_: Este campo es opcional. Si está activado, la operación de instalar/actualizar revisa la integridad de los ficheros del servidor. Es una operación lenta.

* _¿Actualizar a beta?_: Este campo es opcional. Si está activado, la operación actualiza a una versión beta del juego (si estuviera disponible).

* _Rama beta_: Este campo es opcional. El usuario especifica el nombre de la rama beta (sólamente usado cuando el check anterior ha sido activado).

#### Configuracion-Perfiles
En esta sección puedes gestionar perfiles desde el lanzador. Cada perfil es usado para personalizar tus parámetros del servidor.

Expand Down
49 changes: 27 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ Application to easily customize and launch a Killing Floor 2 server through a vi
> 4. [Quick view](#quick-view)
> - [Main page](#main-page)
> - [WebAdmin page](#webadmin-page)
> - [Install or update page](#install-or-update-page)
> - [Maps and Mods page](#maps-and-mods-page)
> - [Console page](#console-page)
> - [Install or update page](#install-or-update-page)
> - [Configuration-Profiles](#configuration-profiles)
> - [Configuration-Game types](#configuration-game-types)
> - [Configuration-Difficulties](#configuration-difficulties)
Expand All @@ -35,7 +36,7 @@ Application to easily customize and launch a Killing Floor 2 server through a vi
## Features

```
Version: 2.0.2 final
Version: 2.0.3 final
Supported OS: Microsoft Windows and Linux (Ubuntu/Debian)
Author: César Rodríguez González
Languages: English, Spanish, French
Expand Down Expand Up @@ -123,21 +124,21 @@ $ java -jar SimpleKF2ServerLauncher.jar

* _Web password_: This field is optional. It allows you to protect WebAdmin page with a password to login.

* _Takeover_: If this check is enabled other people can takeover the server, that means, change the password, change other configurations and take the control of the server.

* _Ports_: Ports are optional. You need to open ports in your router and firewall. If more than one server is launched, ports must be different between them (one configuration per profile).

* _Your clan_: This field is optional.
* _Custom parameters_: This field is optional. It defines additional parameters. The format must be: [?]parameter1=value1?parameter2=value2?...?parameterN=valueN

* _Your web link_: This field is optional.
[?] means: optionally you can start parameters by "?"

* _URL image server_: This field is optional. This link must return an uploaded image to internet and it will be used as the welcome image in your Killing Floor 2 server. Format and resolution must be PNG 512x256 pixels.

* _Welcome message_: This field is optional. It's a welcome message in starting screen of the server.

* _Custom parameters_: This field is optional. It defines additional parameters. The format must be: [?]parameter1=value1?parameter2=value2?...?parameterN=valueN
* _Your clan_: This field is optional.

[?] means: optionally you can start parameters by "?"
* _Your web link_: This field is optional.

* _Console_: This field is automatically filled when the server is running. It's composed by console commands to execute the server.
* _Welcome message_: This field is optional. It's a welcome message in starting screen of the server.

* _Run server_: Run a Killing Floor 2 server with the specified filters. All mandatory fields must be specified. Server config files are placed in folder: KFGame/Config/PROFILENAME. So, the original config files placed in folder: KFGame/Config are never modified.
If more than one profile, you can launch multiple servers at once (one per profile).
Expand All @@ -151,19 +152,6 @@ WebAdmin allows you to manage and control the Killing Floor 2 server.

![Launcher screenshot](src/main/resources/images/documentation/screenshot02.png)

#### Install or update page
In this section you can install or update the Killing Floor 2 server.

![Launcher screenshot](src/main/resources/images/documentation/screenshot03.png)

* _Installation folder_: This field is mandatory. Needed to find the local folder where the server must be installed.

* _Validate files_: This field is optional. If enabled, the install/update operation checks the integrity of the server's files. Slow operation.

* _Update to beta?_: This field is optional. If enabled, the operation updates to a beta version of the game (if available).

* _Beta brunch_: This field is optional. The user specifies the name of the beta brunch (only used when last check was enabled).

#### Maps and Mods page
In this section you can manage custom maps, mods and official maps present in the server.

Expand All @@ -185,6 +173,23 @@ In this section you can manage custom maps, mods and official maps present in th

![Launcher screenshot](src/main/resources/images/documentation/screenshot05.png)

#### Console page
In this section you can see the commands generated by the launcher when you run or join a server.

![Launcher screenshot](src/main/resources/images/documentation/screenshot11.png)

#### Install or update page
In this section you can install or update the Killing Floor 2 server.

![Launcher screenshot](src/main/resources/images/documentation/screenshot03.png)

* _Installation folder_: This field is mandatory. Needed to find the local folder where the server must be installed.

* _Validate files_: This field is optional. If enabled, the install/update operation checks the integrity of the server's files. Slow operation.

* _Update to beta?_: This field is optional. If enabled, the operation updates to a beta version of the game (if available).

* _Beta brunch_: This field is optional. The user specifies the name of the beta brunch (only used when last check was enabled).

#### Configuration-Profiles
In this section you can manage profiles from the launcher. Each profile is used to customize your server parameters.
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/stories/maincontent/MainContentController.java
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,9 @@ private void loadLanguageTexts(String languageCode) throws Exception {

String takeoverLabelText = propertyService.getPropertyValue("properties/languages/" + languageCode + ".properties","prop.label.takeover");
takeoverLabel.setText(takeoverLabelText);

String takeoverText = propertyService.getPropertyValue("properties/languages/" + languageCode + ".properties","prop.label.takeoverEnable");
takeover.setText(takeoverText);
loadTooltip(languageCode, "prop.tooltip.takeover", takeoverImg, takeoverLabel, takeover);

String portsLabelText = propertyService.getPropertyValue("properties/languages/" + languageCode + ".properties","prop.label.ports");
Expand Down
Binary file modified src/main/resources/images/documentation/screenshot00.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot05.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot07.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot09.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/main/resources/images/documentation/screenshot10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/main/resources/properties/config.properties
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CONFIG PROPERTIES
prop.config.applicationTitle=Simple Killing Floor 2 Server Launcher
prop.config.applicationVersion=2.0.3 final 20191024
prop.config.applicationVersion=2.0.3 final 20191025
prop.config.applicationMaximized=false
prop.config.selectedLanguageCode=en
prop.config.urlSteamcmd=https://steamcdn-a.akamaihd.net/client/installer/steamcmd.zip
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/properties/languages/en.properties
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ prop.label.serverName=SERVER NAME
prop.label.serverPassword=SERVER PASSWORD
prop.label.webPage=WEB ( Enable / Password )
prop.label.takeover=TAKEOVER
prop.label.takeoverEnable=Enable takeover
prop.label.ports=WEB/GAME/QUERY PORT
prop.label.clan=YOUR CLAN
prop.label.webLink=YOUR WEB LINK
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/properties/languages/es.properties
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ prop.label.serverName=NOMBRE SERVIDOR
prop.label.serverPassword=CONTRASE\u00d1A SERVIDOR
prop.label.webPage=WEB ( Activo / Contrase\u00f1a )
prop.label.takeover=TOMA DE CONTROL
prop.label.takeoverEnable=Activar toma de control
prop.label.ports=PUERTO WEB/GAME/QUERY
prop.label.clan=TU CLAN
prop.label.webLink=TU ENLACE WEB
Expand Down
3 changes: 2 additions & 1 deletion src/main/resources/properties/languages/fr.properties
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ prop.label.maxPlayers=JOUEURS MAX
prop.label.serverName=NOM DE SERVER
prop.label.serverPassword=MOT DE PASSE SERVER
prop.label.webPage=WEB ( Activer / Mot de passe )
prop.label.takeover=Prendre le contr\u00f4le
prop.label.takeover=PRENDRE LE CONTR\u00d4LE
prop.label.takeoverEnable=Activer la prise de contr\u00f4le
prop.label.ports=WEB/JEU/REQU\u00caTE PORT
prop.label.clan=TON CLAN
prop.label.webLink=TON LIEN WEB
Expand Down
8 changes: 4 additions & 4 deletions src/main/resources/views/mainContent.fxml
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
</Label>
<Label fx:id="mapLabel" text="MAP*" textFill="WHITE" GridPane.halignment="RIGHT" GridPane.rowIndex="4" GridPane.valignment="TOP">
<GridPane.margin>
<Insets right="10.0" top="8.0" />
<Insets right="10.0" top="11.0" />
</GridPane.margin>
</Label>
<Label fx:id="difficultyLabel" text="DIFFICULTY*" textFill="WHITE" GridPane.halignment="RIGHT" GridPane.rowIndex="5" GridPane.valignment="TOP">
Expand Down Expand Up @@ -227,7 +227,7 @@
</Label>
<Label fx:id="customParametersLabel" text="CUSTOM PARAMETERS" textFill="WHITE" GridPane.halignment="RIGHT" GridPane.rowIndex="13" GridPane.valignment="TOP">
<GridPane.margin>
<Insets right="10.0" top="8.0" />
<Insets right="10.0" top="11.0" />
</GridPane.margin>
</Label>
<TextField fx:id="serverName" maxWidth="350.0" GridPane.columnIndex="1" GridPane.rowIndex="8" GridPane.valignment="TOP">
Expand Down Expand Up @@ -270,7 +270,7 @@
<GridPane.margin>
<Insets top="2.0" />
</GridPane.margin></TextField>
<TextArea fx:id="customParameters" prefHeight="100.0" prefWidth="350.0" GridPane.columnIndex="1" GridPane.rowIndex="13" GridPane.rowSpan="3" GridPane.valignment="TOP">
<TextArea fx:id="customParameters" prefHeight="100.0" prefWidth="350.0" wrapText="true" GridPane.columnIndex="1" GridPane.rowIndex="13" GridPane.rowSpan="3" GridPane.valignment="TOP">
<GridPane.margin>
<Insets top="2.0" />
</GridPane.margin></TextArea>
Expand All @@ -290,7 +290,7 @@
<GridPane.margin>
<Insets top="2.0" />
</GridPane.margin></TextField>
<TextArea fx:id="welcomeMessage" opacity="0.75" prefHeight="120.0" GridPane.columnIndex="3" GridPane.columnSpan="2" GridPane.rowIndex="11" GridPane.rowSpan="5" GridPane.valignment="TOP">
<TextArea fx:id="welcomeMessage" opacity="0.75" prefHeight="120.0" wrapText="true" GridPane.columnIndex="3" GridPane.columnSpan="2" GridPane.rowIndex="11" GridPane.rowSpan="5" GridPane.valignment="TOP">
<GridPane.margin>
<Insets top="2.0" />
</GridPane.margin></TextArea>
Expand Down

0 comments on commit 0799b42

Please sign in to comment.