Skip to content

Commit

Permalink
Updates in documentation and screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
cesar-rgon committed Oct 11, 2022
1 parent 2294aaa commit 4277c3c
Show file tree
Hide file tree
Showing 19 changed files with 55 additions and 20 deletions.
6 changes: 4 additions & 2 deletions LEEME.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ _[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.0.7 final
Versión: 2.1.0 final
S.O. soportados: Microsoft Windows y Linux (Ubuntu/Debian)
Plataformas soportadas: Steam y Epic Games
Desarrollado por: César Rodríguez González
Idiomas: Inglés, Español, Francés
Traducción a inglés y español: César Rodríguez González
Expand All @@ -24,7 +25,8 @@ Traducción a francés por: -foG.Nox

## Características

- Instalar/actualizar el servidor a la última versión oficial o beta.
- Instalar/actualizar el servidor a la última versión oficial o beta.
- Las plataformas soportadas son: Steam y Epic Games.
- Lanzar el servidor con los parámetros especificados por el usuario en la página principal del lanzador.
- Unirse a la partida en curso del servidor.
- Abrir la página WebAdmin para administrar el servidor en ejecución.
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ _[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.0.7 final
Version: 2.1.0 final
Supported OS: Microsoft Windows and Linux (Ubuntu/Debian)
Supported platforms: Steam and Epic Games
Developed by: César Rodríguez González
Languages: English, Spanish, French
Translation to english and spanish: César Rodríguez González
Expand All @@ -25,6 +26,7 @@ Translation to french by: -foG.Nox
## Features

- Install/Update server to the latest official or beta version.
- Supported platforms are: Steam and Epic Games.
- Launch the server with specified parameters by the user in launcher's main page.
- Join the running server's match.
- Open WebAdmin page to administrate the running server.
Expand Down
9 changes: 5 additions & 4 deletions doc/ANNEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@ The launcher allows to execute servers through terminal parameters without user

Accepted parameters are: *For example*
```
java -jar SimpleKF2ServerLauncher.jar --profiles profileName1 [profileName2 profileName3 ... ]
java -jar SimpleKF2ServerLauncher.jar --pp platformName/profileName [platformName2/profileName2 ... ]
```
*NOTE: [ ] means that these parameters are optional*

- This command executes one or multiple servers, one per profileName.
- The profile names must be separated by whitespace.
- The profile names must exist in launcher's database.
- This command executes one or multiple servers, one per platformName and profileName.
- The plarform/profile names must be separated by whitespace.
- The platform names must exist in launcher's database. Valid values are: Steam and Epic.
- The profile names must exist in launcher's database (case sensitive).

---
Back to main page [here](../README.md).
3 changes: 3 additions & 0 deletions doc/BASIC-CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
## Main page
![Launcher screenshot](images/screenshot00.png)

* _Platform_: This combo is mandatory. It allows to select the platform where the server is installed.

* _Profile_: This combo is mandatory. It allows to customize filter values by profile name.

* _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.
Expand Down Expand Up @@ -46,6 +48,7 @@ If more than one profile, you can select wich server you want to join (one per p
* _Welcome message_: This field is optional. It's a welcome message in starting screen of the server.

#### Advanced parameters

![Launcher screenshot](images/screenshot01.png)

* _Map voting_: This check enables or disables map voting screen after a game ends.
Expand Down
2 changes: 1 addition & 1 deletion doc/CUSTOM-MAPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Under Maps/Mods page you can manage custom maps, mods and official maps present

* _Search filter_: It allows to filter maps and mods by name while you are writing the text.

* _Select all_: It allows to select all maps to perform an action over them. Furthermore it allows to unselect them.
* _Select all per tab_: It allows to select all maps to perform an action over them. Furthermore it allows to unselect them.

* _Columns slider_: It allows to change the thumbnail size of the maps by the specific number of columns.

Expand Down
2 changes: 0 additions & 2 deletions doc/INSTALL-LAUNCHER.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,5 @@ $ java -jar SimpleKF2ServerLauncher.jar
```
*NOTE: Replace SimpleKF2ServerLauncher-local-folder for the local folder that you want.*

*NOTE: The JRE must be the Oracle version (not the OpenJDK available in repositories).*

---
Back to main page [here](../README.md).
14 changes: 14 additions & 0 deletions doc/INSTALL-SERVER.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

Under Install/Update page you can install or update the Killing Floor 2 server.

## Steam installation

![Launcher screenshot](images/screenshot03.png)

* _Installation folder_: This field is mandatory. Needed to find the local folder where the server must be installed.
Expand All @@ -14,5 +16,17 @@ Under Install/Update page you can install or update the Killing Floor 2 server.

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

* _Install/Update button_: To do the install or update operation over the server. Farthermore, in Linux OS, it aplies a patch to be able to downloanload Steam WorkShop's maps.

## Epic Games installation

Epic Games's server is installed by default when the client is installed in the computer, so, the launcher doesn't install the server but it is used for specify the folder where it is installed.

![Launcher screenshot](images/screenshot13.png)

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

* _Install/Update button_: To do the update operation over the server. Farthermore, it aplies a patch to be able to downloanload Steam WorkShop's maps.

---
Back to main page [here](../README.md).
2 changes: 1 addition & 1 deletion doc/PRE-REQUISITES.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
| Steam Port | 20560 | UDP | |
| NTP Port | 123 | UDP | Weekly Outbreak Only - Internet time lookup to determine correct Outbreak |

- Install Oracle JDK 17 or later (Java Development Kit) or OpenJDK in order to be able to execute the launcher.
- Install Oracle JDK 17 or a newer one (Java Development Kit) or OpenJDK in order to be able to execute the launcher.
- JDK can be downloaded from [here](https://www.oracle.com/java/technologies/downloads/).
- OpenJDK can be downloaded from [here](https://openjdk.java.net/).

Expand Down
9 changes: 5 additions & 4 deletions doc/es/ANEXO.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@ El lanzador permite ejecutar servidores a través de parámetros de terminal sin
Los parámetros aceptados son: *Por ejemplo*:

```
java -jar SimpleKF2ServerLauncher.jar --profiles nombrePerfil1 [nombrePerfil2 nombrePerfil3 ... ]
java -jar SimpleKF2ServerLauncher.jar --pp platformName/profileName [platformName2/profileName2 ... ]
```
*NOTE: [ ] significa que estos parámetros son opcionales*

- Este comando ejecuta uno o varios servidores, uno por nombre de perfil.
- Los nombres de perfiles deben estar separados por espacio en blanco.
- Los nombres de perfiles deben existir en la base de datos del lanzador.
- Este comando ejecuta uno o varios servidores, uno por nombre de plataforma y perfil.
- Los nombres de plataforma/perfil deben estar separados por espacio en blanco.
- Los nombres de plataformas deben existir en la base de datos del lanzador. Los valores válidos son: Steam y Epic.
- Los nombres de perfiles deben existir en la base de datos del lanzador (sensible a mayúsculas).

---
Back to main page [here](../../LEEME.md).
3 changes: 3 additions & 0 deletions doc/es/CONFIGURACION-BASICA.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,11 @@
# Configuración básica

## Página principal

![Launcher screenshot](../images/screenshot00.png)

* _Plataforma_: Este combo es obligatorio. Permite seleccionar la plataforma donde está instalado el servidor.

* _Perfil_: Este combo es obligatorio. Permite personalizar los valores de los filtros por nombre de perfil.

* _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.
Expand Down
3 changes: 0 additions & 3 deletions doc/es/INSTALAR-LANZADOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,5 @@ $ java -jar SimpleKF2ServerLauncher.jar
```
*NOTA: Reemplaza SimpleKF2ServerLauncher-local-folder por la carpeta local que quieras.*

*NOTA: JRE debe ser la versión de Oracle (no OpenJDK disponible en los repositorios).*


---
Back to main page [here](../../LEEME.md).
14 changes: 14 additions & 0 deletions doc/es/INSTALAR-SERVIDOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

En la página de Instalar/Actualizar puedes instalar o actualizar el servidor de Killing Floor 2.

## Instalación de Steam

![Launcher screenshot](../images/screenshot03.png)

* _Carpeta de instalación_: Este campo es obligatorio. Necesario para encontrar la carpeta local donde el servidor debe ser instalado.
Expand All @@ -14,5 +16,17 @@ En la página de Instalar/Actualizar puedes instalar o actualizar el servidor de

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

* _Botón de instalar/Actualizar_: Hace la operación de instalar o actualizar el servidor. Además, en el SO Linux, aplica un parche para poder descargar mapas de Steam WorkShop.

## Instalación de Epic Games

El servidor de Epic Games es instalado por defecto cuando el cliente es instalado en el ordenador, así que, el lanzador no instala el servidor sino que es usado para especificar la carpeta donde está instalado.

![Launcher screenshot](../images/screenshot13.png)

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

* _Botón de instalar/Actualizar_: Hace la operación de instalar o actualizar el servidor. Además, aplica un parche para poder descargar mapas de Steam WorkShop.

---
Back to main page [here](../../LEEME.md).
2 changes: 1 addition & 1 deletion doc/es/MAPAS-PERSONALIZADOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ En la página Mapas/Mods puedes gestionar mapas personalizados, mods y mapas ofi

* _Filtro buscador_: Permite filtrar mapas y mods por nombre mientras vas escribiendo el texto.

* _Selecciona todos_: Permite seleccionar todos los mapas para realizar una acción sobre ellos. Además permite deseleccionarlos.
* _Selecciona todos por pestaña_: Permite seleccionar todos los mapas para realizar una acción sobre ellos. Además permite deseleccionarlos.

* _Barra de columnas_: Permite cambiar el tamaño de las miniaturas de los mapas según un número de columnas determinado.

Expand Down
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 modified doc/images/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 doc/images/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 doc/images/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 added doc/images/screenshot13.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.0 beta 221010
prop.config.applicationVersion=2.1.0 final 221011
prop.config.applicationResolution=1024x724
prop.config.applicationMaximized=false
prop.config.selectedLanguageCode=en
Expand Down

0 comments on commit 4277c3c

Please sign in to comment.