From be439293229ab2f257ca219c95889764360f269a Mon Sep 17 00:00:00 2001 From: Pelayori <31128562+Pelayori@users.noreply.github.com> Date: Sun, 20 Aug 2023 01:48:55 +0200 Subject: [PATCH] Add Spanish translation --- README-esES.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 README-esES.md diff --git a/README-esES.md b/README-esES.md new file mode 100644 index 0000000..6a1fcdb --- /dev/null +++ b/README-esES.md @@ -0,0 +1,45 @@ +# BattleBit Remastered Community Server API + +[![Licencia: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +Language [English](/README.md) | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | Español + +Este repositorio proporciona una API que puede ser usada para manejar eventos en tu servidor de comunidad y manipularlos. + +## Primeros pasos + +### Preequisitos + +- Tu proprio servidor de BattleBit Remastered con la progresión **deshabilitada** y acceso a los parámetros de lanzamiento. +- Poder escribir y compilar [.NET 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) en C#. +- (para entorno de producción) Un espacio donde alojar esta API + +### Información + +La documentación y algunos ejemplos se pueden encontrar en la [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki) (WIP). + +La manera de utilizar esta API es instanciando una clase `ServerListener` (y ejecutándola) a la cual le pasas tus *propias* subclases de `Player` y `GameServer`. En esas subclases, puedes hacer tus propias modificaciones a los métodos que ya existen en `Player` y `GameServer`. Tambien puedes añadir tus propios atributos y métodos. + +La manera más fácil de empezar, es usando el archivo proporcionado `Program.cs` y agregar tus propias modificaciones. dentro de `MyPlayer` y `MyGameServer`. + +### Compilación + +El proyecto se puede compilar tanto usando el comando [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build) en una línea de comandos o usando las opciones de compilar dentro de tu IDE preferido. + +Alternativamente, puedes usar docker para ejecutarlo. Una forma fácil de hacer eso es ejecutar el comando `docker compose up`. + +### Conectando al servidor(es) + +Después de programar y compilar el proyecto, necesitarás un sitio donde alojarlo. Esto se podría hacer en el mismo sitio que el servidor del juego donde la latencia sería mínima, o en cualquier lugar completamente diferente. Es recomendable mantener la latencia entre el servidor y la API lo más baja posible para favorecer el rendimiento. Un mismo `ServerListener` puede ser utilizado para *múltiples* servidores del juego al mismo tiempo. Puedes especificar la API (direccion y puerto) en los parámetros de lanzamiento del servidor de juego. + +#### Parámetros de lanzamiento del servidor de juego + +El servidor se conecta a la API a través del parámetro `"-apiendpoint=:"`, donde `` es el puerto donde el listener escucha y `` es la dirección IP de la API. + +Si se requiere verificación por `Api Token` en tu API, tendrás que añadir el parámetro `"-apiToken="` a los parámetros de lanzamiento de los servidor(es). Si el `` del servidor es el mismo `Api Token` que está definido en la API, los servidores se podrán comunicar con la API. De no ser así, la conexión será rechazada. + +Cuando el servidor de juego esté iniciado completamente, puedes modificar direcamente el `Api Token` del servidor usando el comando `setapitoken ` en la ventana de comandos del servidor que se ha iniciado. + +#### Ajustar puerto de escucha de la API + +El proyecto está actualmente configurado para escuchar en el puerto `29294`. Si quisieses cambiar esto, asegurate de cambiarlo en el código (en tu `listener.start(port)`). El puerto `29294` tambien está expuesto en Docker y ligado al mismo puerto enel host en Docker Compose. Esto significa que, usando Docker, se tendrá que cambiar el puerto en el archivo `Dockerfile` y en el archivo `docker-compose.yml` (cuando se utiliza Compose) tambien. Léase [EXPOSE in the Dockerfile reference](https://docs.docker.com/engine/reference/builder/#expose) y [networking in Compose](https://docs.docker.com/compose/networking/). diff --git a/README.md b/README.md index 0b8cf40..308f061 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Language English | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) +Language English | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | [Español](/README-esES.md) This repository provides an API that can be used to handle events on your community server(s) and manipulate them.