Updates in documentation

cesar-rgon · Jun 9, 2024 · d478915 · d478915
1 parent 746c9ef
commit d478915
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 4 deletions.
diff --git a/LEEME.md b/LEEME.md
@@ -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.7 final
+Versión: 2.2.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

diff --git a/README.md b/README.md
@@ -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.7 final
+Version: 2.2.0 final
 Supported OS: Microsoft Windows and Linux (Ubuntu/Debian)
 Supported platforms: Steam and Epic Games
 Developed by: César Rodríguez González

diff --git a/doc/BASIC-CONFIGURATION.md b/doc/BASIC-CONFIGURATION.md
@@ -107,6 +107,14 @@ Not all the images are supported in the game. Only images that meet image resolu
 
 * _Ports_: These fields 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).
 
+* _Tickrate_: These parameters mean how many times the server updates per second. The higher the better. Manimum value admited is 60.
+
+* _Max client rate_: These parameters mean bandwith cap in bytes.
+
+#### Custom parameters
+
+![Launcher screenshot](images/screenshot15.png)
+
 * _Custom parameters_: This field is optional. It defines additional parameters. The format must be: [?]parameter1=value1?parameter2=value2?...?parameterN=valueN
 
   [?] means: optionally you can start parameters by "?"

diff --git a/doc/CUSTOM-MAPS.md b/doc/CUSTOM-MAPS.md
@@ -11,14 +11,18 @@ Under Maps/Mods page you can manage custom maps, mods and official maps present
 * _Actions menu_: It has several options to manage custom or official maps.
   * _Add new maps by URL/Id WorkShop_: It allows to add new custom maps and mods from Steam's WorkShop by WorkShop's Id or URL. If more than one element, use comma as separator.
   * _Search maps in WorkShop_: It allows to browse in Workshop's pages looking for new maps and mods. Then you can choose wich of them add to the launcher.
+  * _Download selected maps_: It allows to download all maps and mods previously selected.
   * _Edit selected maps_: It allows to edit all maps and mods previously selected.
   * _Delete selected maps_: It allows to delete all maps and mods previously selected.
   * _Import maps from server_: It allows to import all custom maps, mods and official maps from the server to the launcher. Only the elements not present already in the launcher.
+  * _Add selected maps to maps cycle_: It allows to add all selected official/custom maps to voting list displayed at the end of each match in-game.
+  * _Remove selected maps from maps cycle_: It allows to remove all selected official/custom maps from voting list displayed at the end of each match in-game.
   * _Order maps by alias_: It allows to sort the maps alphabetically by alias (ascendent or descendent).
   * _Order maps by name_: It allows to sort the maps alphabetically by name (ascendent or descendent).
   * _Order maps by release date_: It allows to sort the maps by release date (ascendent or descendent).
   * _Order maps by imported date_: It allows to sort the maps by imported date to the launcher (ascendent or descendent).
   * _Order maps by download_: It allows to sort the maps by download state (ascendent or descendent).
+  * _Order maps by maps cycle_: It allows to sort the maps by in maps cycle state (ascendent or descendent).
 
 * _Search filter_: It allows to filter maps and mods by name while you are writing the text.
 

diff --git a/doc/PRE-REQUISITES.md b/doc/PRE-REQUISITES.md
@@ -2,6 +2,7 @@
 
 # Pre-requisites
 - Internet connection to download, update and publish a Killing Floor 2 server.
+
 - Open needed ports in your router and firewall if you want your server be visible on internet.
 
   | Port       | Default | Protocol | What this option controls                                                   |
@@ -17,5 +18,9 @@
   - JDK can be downloaded from [here](https://www.oracle.com/java/technologies/downloads/).
   - OpenJDK can be downloaded from [here](https://openjdk.java.net/).
 
+- Install Git in your OS.
+  - Windows: https://gitforwindows.org/
+  - Linux: ```$ sudo apt install git```
+
 ---
 Back to main page [here](../README.md).
diff --git a/doc/es/CONFIGURACION-BASICA.md b/doc/es/CONFIGURACION-BASICA.md
@@ -107,7 +107,15 @@ No todas las imágenes son soportadas por el juego. Sólanente las imágenes que
 
 * _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).
 
-* _Parámetros opcionales_: Este campo es opcional. Define parámetros adicionales. El formato debe ser: [?]parametro1=valor1?parametror2=valor2?...?parametroN=valorN
+* _Tickrate_: Estos parámetros significan cuántas veces el servidor actualiza por segundo. Mayor valor es mejor. El valor máximo permitido es 60.
+
+* _Max client rate_: Estos parámetros significan límite de ancho de banda en bytes.
+
+#### Parámetros personalizados
+
+![Launcher screenshot](../images/screenshot15.png)
+
+* _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 "?"
 

diff --git a/doc/es/MAPAS-PERSONALIZADOS.md b/doc/es/MAPAS-PERSONALIZADOS.md
@@ -11,14 +11,18 @@ En la página Mapas/Mods puedes gestionar mapas personalizados, mods y mapas ofi
 * _Menú acciones_: Tiene varias opciones para manejar mapas personalizados y oficiales.
   * _Añadir nuevos mapas por URL/Id WorkShop_: Permite añadir nuevos mapas personalizados y mods desde el WorkShop de Steam mediante id de WorkShop o URL. Si hay más de un elemento, usa comas como separador.
   * _Buscar mapas en WorkShop_: Permite navegar en las páginas de WorkShop buscando nuevos mapas y mods. Luego puedes seleccionar cuál de ellos añadir al lanzador.
+  * _Descargar mapas seleccionados_: Permite descargar todos los mapas y mods previamente seleccionados.
   * _Editar los mapas seleccionados_: Permite editar todos los mapas y mods previamente seleccionados.
   * _Elimina los mapas seleccionados_: Permite eliminar todos los mapas y mods previamente seleccionados.
   * _Importa mapas del servidor_: Permite importar todos los mapas personalizados, mods y mapas oficiales del servidor al lanzador. Sólamente los elementos que no está aún presentes en el lanzador.
+  * _Añadir mapas seleccionados al ciclo de mapas_: Permite añadir todos los mapas oficiales/personalizados seleccionados a la lista de votos mostrado al final de cada partida dentro del juego.
+  * _Eliminar mapas seleccionados del ciclo de mapas_: Permite eliminar todos los mapas oficiales/personalizados seleccionados de la lista de votos mostrado al final de cada partida dentro del juego.
   * _Ordenar mapas por alias_: Permite ordenar los mapas alfabéticamente por alias (ascendente o descendente).
   * _Ordenar mapas por nombre_: Permite ordenar los mapas alfabéticamente por nombre (ascendente o descendente).
   * _Ordenar mapas por fecha de lanzamiento_: Permite ordenar los mapas por fecha de lanzamiento (ascendente or descendente).
   * _Ordenar mapas por fecha de importación_: Permite ordenar los mapas por fecha de importación al lanzador (ascendente or descendente).
   * _Ordenar mapas por descarga_: Permite ordenar los mapas por estado de descarga (ascendente or descendente).
+  * _Ordenar mapas por ciclo de mapas_: Permite ordenar los mapas por estado "en ciclo de mapas" (ascendente or descendente).
 
 * _Filtro buscador_: Permite filtrar mapas y mods por nombre mientras vas escribiendo el texto. 
 

diff --git a/doc/es/PRE-REQUISITOS.md b/doc/es/PRE-REQUISITOS.md
@@ -17,5 +17,8 @@
   - JDK puede ser descargado desde [aquí](https://www.oracle.com/java/technologies/downloads/).
   - OpenJDK puede ser descargado desde [aquí](https://openjdk.java.net/).
 
+- Instalar Git en tu SO.
+  - Windows: https://gitforwindows.org/
+  - Linux: ```$ sudo apt install git```
 ---
 Back to main page [here](../../LEEME.md).
diff --git a/doc/images/screenshot-in-game.jpg b/doc/images/screenshot-in-game.jpg
diff --git a/doc/images/screenshot-in-game2.jpg b/doc/images/screenshot-in-game2.jpg
diff --git a/doc/images/screenshot00.png b/doc/images/screenshot00.png
diff --git a/doc/images/screenshot01.png b/doc/images/screenshot01.png
diff --git a/doc/images/screenshot04.png b/doc/images/screenshot04.png
diff --git a/doc/images/screenshot05.png b/doc/images/screenshot05.png
diff --git a/doc/images/screenshot14.png b/doc/images/screenshot14.png
diff --git a/doc/images/screenshot15.png b/doc/images/screenshot15.png
diff --git a/src/main/resources/properties/config.properties b/src/main/resources/properties/config.properties
@@ -1,6 +1,6 @@
 # CONFIG PROPERTIES
 prop.config.applicationTitle=Simple Killing Floor 2 Server Launcher
-prop.config.applicationVersion=2.2.0 final 240609
+prop.config.applicationVersion=2.2.0 final 240610
 prop.config.applicationResolution=1024x724
 prop.config.applicationMaximized=false
 prop.config.selectedLanguageCode=en