Skip to content

Commit

Permalink
Updates in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cesar-rgon committed Aug 18, 2023
1 parent f8b19c0 commit 95b1c4d
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 17 deletions.
2 changes: 1 addition & 1 deletion LEEME.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ _[Click here to open documentation in english | Pulse aquí para abrir documenta
Aplicación para personalizar y lanzar fácilmente un servidor de Killing Floor 2 a través de una interfaz visual en lugar de editar ficheros batch o de configuración del servidor. Ha sido desarrollado en Java y la interfaz es compatible con los S.O. Windows y Linux.

```
Versión: 2.1.4 alpha
Versión: 2.1.4 final
S.O. soportados: Microsoft Windows y Linux (Ubuntu/Debian)
Plataformas soportadas: Steam y Epic Games
Desarrollado por: César Rodríguez González
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ _[Click here to open documentation in spanish | Pulse aquí para abrir documenta
Application to easily customize and launch a Killing Floor 2 server through a visual interface instead of edditing batch files or server's config files. It has been developed with Java, so the interface is compatible on Windows and Linux OS.

```
Version: 2.1.4 alpha
Version: 2.1.4 final
Supported OS: Microsoft Windows and Linux (Ubuntu/Debian)
Supported platforms: Steam and Epic Games
Developed by: César Rodríguez González
Expand Down
24 changes: 18 additions & 6 deletions doc/BASIC-CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ If more than one profile, you can select wich server you want to join (one per p

#### Basic parameters

* _Language_: This combo is mandatory. It allows to select a language for the launcher's interface. List of available languages are described in the [Features](#features) section of this document.

* _Map_: This combo is mandatory. It allows you to select one specific official map or custom map. *NOTE: Custom maps are visible in this field only if they were already downloaded before*.

* _Language_: This combo is mandatory. It allows to select a language for the launcher's interface. List of available languages are described in the [Features](#features) section of this document.

* _Game Type_: This combo is mandatory. It allows you to select one specific game type.

* _Difficulty_: This combo is mandatory. It allows you to select one specific difficulty level.
Expand All @@ -33,19 +33,31 @@ If more than one profile, you can select wich server you want to join (one per p

* _Server password_: This field is optional. It allows you to protect your server with a password (needed to known to be able to join the game).

* _URL image server_: This field is optional. This is a local image uploaded to an embedded http web server. The image resolution must be 512x256 and format PNG. If defined, it will be visible in the welcome screen of the server game but only if "Your clan", "Your web link" and "Welcome message" parameters are defined too.

* _Your clan_: This field is optional.

* _Your web link_: This field is optional.

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

* _Web page_: If web page check is enabled you can manage the server through WebAdmin page. Killing Floor 2 server must be launched before you can access WebAdmin page.

* _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.

* _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.

* _Your clan_: This field is optional.
#### Custom Image Server
You can upload a custom image to the embedded http web server to be visible in KF2's server.
Not all the images are supported in the game. Only images that meet image resolution must be 512x256, format PNG and color in 16 bits depth.

* _Your web link_: This field is optional.
*An example*
![Launcher screenshot](images/screenshot14.png)

*In game lobby*
![Launcher screenshot](images/screenshot-in-game2.jpg)

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

#### Advanced parameters

Expand Down
25 changes: 18 additions & 7 deletions doc/es/CONFIGURACION-BASICA.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Si hay más de un perfil definido, puedes lanzar múltiples servidores a la vez
Si hay más de un perfil definido, puedes seleccionar a qué servidor quieres unirte (uno por perfil).

#### Parametros basicos

* _Idioma_: Este combo es obligatorio. Permite seleccionar un idioma para la interfaz del lanzador. La lista de idiomas disponibles están en el apartado [Caracteristicas](#caracteristicas) de este documento.

* _Mapa_: Este combo es obligatorio. Permite seleccionar un mapa oficial o personalizado específico. *NOTA: Los mapas personalizados son visibles en este campo sólamente si han sido descargados previamente.*

* _Idioma_: Este combo es obligatorio. Permite seleccionar un idioma para la interfaz del lanzador. La lista de idiomas disponibles están en el apartado [Caracteristicas](#caracteristicas) de este documento.

* _Tipo de juego_: Este combo es obligatorio. Permite seleccionar un tipo de juego específico.

* _Dificultad_: Este combo es obligatorio. Permite seleccionar un nivel de dificultad específico.
Expand All @@ -34,19 +34,30 @@ Si hay más de un perfil definido, puedes seleccionar a qué servidor quieres un

* _Contraseña de servidor_: Este campo es opcional. Permite proteger tu servidor con una contraseña (se necesita conocer para poder unirse al juego).

* _URL imágen servidor_: Este campo es opcional. Esta es una imágen local subida a un servidor web http embebido. La resolución de la imágen debe ser 512x256 y el formato PNG. Si es definido, será visible en la pantalla de bienvenida del servidor pero sólo si los parámetros "Tu clan", "Tu enlace web" y "Mensaje de bienvenida" son definidos también.

* _Tu clan_: Este campo es opcional.

* _Tu página web_: Este campo es opcional.

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

* _Página web_: Si el check de página web está activo, puedes gestionar el servidor mediante la página WebAdmin. El servidor de Killing Floor 2 debe haberse lanzado previamente a acceder a la página de WebAdmin.

* _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.

* _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.
#### Imágen de Servidor Personalizada
Puedes subir una imágen personalizada al servidor web http embebido para ser visible en el servidor de KF2.
No todas las imágenes son soportadas por el juego. Sólanente las imágenes que cumplen tener resolución 512x256, formato PNG y profundidad de color en 16 bits.

* _Tu página web_: Este campo es opcional.
*Un ejemplo*
![Launcher screenshot](../images/screenshot14.png)

*En la sala de espera del juego*
![Launcher screenshot](../images/screenshot-in-game2.jpg)

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

#### Parámetros avanzados

Expand Down
Binary file added doc/images/screenshot-in-game2.jpg
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 doc/images/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 added doc/images/screenshot14.png
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.1.4 beta 230817
prop.config.applicationVersion=2.1.4 final 230818
prop.config.applicationResolution=1024x724
prop.config.applicationMaximized=false
prop.config.selectedLanguageCode=en
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/properties/languages/en.properties
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ prop.tooltip.ports=These fields indicate ports used by the server. They have to
prop.tooltip.clan=This field indicates your Clan's alias. If defined, it will be visible in the welcome screen of the server game. It is optional
prop.tooltip.weblink=This field indicates your web link site. If defined, it will be visible in the welcome screen of the server game. It is optional
prop.tooltip.urlImage=This field indicates an image URL. The image must be stored in internet and accessible through a link. The image resolution must be 512x256 and format PNG. If defined, it will be visible in the welcome screen of the server game. It is an optional parameter of the server, but it's mandatory if you want to see the welcome screen
prop.tooltip.welcomeMessage=This field indicates an welcome message. If defined, it will be visible in the welcome screen of the server game. It is an optional parameter of the server, but it's mandatory if you want to see the welcome screen
prop.tooltip.welcomeMessage=This field indicates a welcome message. If defined, it will be visible in the welcome screen of the server game. It is an optional parameter of the server, but it's mandatory if you want to see the welcome screen
prop.tooltip.customParameters=This field indicates other parameters used by the server as well as custom parameters used by MODs. They must be separated by ? character each other. This field is optional
prop.tooltip.runServer=This button runs one or multiple KF2 servers. If more than one profile, run one server per selected profile at once
prop.tooltip.joinServer=This button starts client game and joins to a running server. If more than one profile, you can select the server that you want to join
Expand Down

0 comments on commit 95b1c4d

Please sign in to comment.