Compilation es ES

Compilación

La compilación es el proceso de crear un archivo ejecutable. Esto es lo que necesitas hacer si deseas añadir tus propios cambios a ASF, o si por cualquier razón no confías en los archivos ejecutables proporcionados en las versiones oficiales. Si eres usuario y no un desarrollador, lo más probable es que quieras usar ejecutables ya compilados, pero si quieres usar los tuyos propios, a aprender algo nuevo, continua leyendo.

ASF puede ser compilado en cualquier plataforma soportada actualmente, siempre que tengas todas las herramientas para hacerlo.

.NET SDK

Independientemente de la plataforma, necesitas .NET SDK completo (no solo runtime) para compilar ASF. Las instrucciones para la instalación se pueden encontrar en la página de descarga de .NET. Necesitas instalar la versión apropiada de .NET SDK para tu sistema operativo. Después de una instalación exitosa, el comando dotnet debería estar funcionando y operativo. Puedes verificar si funciona con dotnet --info. También asegúrate de que tu .NET SDK coincida con los requisitos de runtime de ASF.

Compilación

Suponiendo que tienes .NET SDK operativo y en la versión apropiada, simplemente navega al directorio fuente de ASF (repositorio de ASF clonado o descargado y desempaquetado) y ejecuta:

dotnet publish ArchiSteamFarm -c "Release" -f "net7.0" -o "out/generic"

Si usas Linux/macOS, en su lugar puedes usar el script cc.sh que hará lo mismo, de forma un poco más compleja.

Si la compilación terminó con éxito, podrás encontrar ASF en su variante source en el directorio out/generic. Esto es lo mismo que la compilación generic oficial de ASF, pero está forzado a UpdateChannel y UpdatePeriod de 0, lo que es apropiado para versiones autocompiladas.

Sistema operativo específico

Si tienes una necesidad específica también puedes generar un paquete .NET específico para un sistema operativo. En general no deberías hacer eso porque acabas de compilar la variante generic que puedes ejecutar con el ya instalado .NET runtime que usaste para la compilación en primer lugar, pero en caso de que lo quieras hacer:

dotnet publish ArchiSteamFarm -c "Release" -f "net7.0" -o "out/linux-x64" -r "linux-x64"

Por supuesto, reemplaza linux-x64 con la arquitectura del sistema operativo que tienes por objetivo, tal como win-x64. Esta compilación también tendrá las actualizaciones deshabilitadas.

.NET Framework

En el raro caso de que quieras compilar un paquete generic-netf, puedes cambiar el framework objetivo de net7.0 a net481. Ten en cuenta que necesitarás el paquete de desarrollador .NET Framework adecuado para compilar la variante netf, además de .NET SDK, así que lo siguiente solo funcionará en Windows:

dotnet publish ArchiSteamFarm -c "Release" -f "net481" -o "out/generic-netf"

En caso de no poder instalar .NET Framework o incluso .NET SDK (por ejemplo, por estar compilando en linux-x86 con mono), puedes usar msbuild directamente. También necesitarás especificar ASFNetFramework manualmente, ya que ASF por defecto desactiva la compilación netf en plataformas que no son Windows:

msbuild /m /r /t:Publish /p:Configuration=Release /p:TargetFramework=net481 /p:PublishDir=out/generic-netf /p:ASFNetFramework=true ArchiSteamFarm

ASF-ui

Aunque los pasos anteriores son todo lo necesario para tener una compilación de ASF completamente funcional, también podría interesarte compilar ASF-ui, nuestra interfaz web gráfica. Desde el lado de ASF, todo lo que necesitas hacer es poner una compilación de ASF-ui en la ubicación estándar ASF-ui/dist, luego compilar ASF con ella (de nuevo, si es necesario).

ASF-ui es parte del árbol fuente de ASF como un submódulo git, asegúrate de que has clonado el repositorio con git clone --recursive, ya que de lo contrario no tendrás los archivos necesarios. También necesitarás un NPM funcional, Node.js viene con él. Si estás usando Linux/macOS, recomendamos nuestro script cc.sh, que automáticamente cubrirá la compilación y envío de ASF-ui (si es posible, es decir, si cumples con los requisitos que acabamos de mencionar).

Además del script cc.sh, abajo también adjuntamos las instrucciones de compilación simplificada, consulta ASF-ui repo para documentación adicional. Desde la ubicación del árbol fuente de ASF, así como arriba, ejecuta los siguientes comandos:

rm -rf "ASF-ui/dist" # ASF-ui no limpia sus archivos después de la compilación vieja

npm ci --prefix ASF-ui
npm run-script deploy --prefix ASF-ui

rm -rf "out/generic/www" # Asegúrate de que la salida de compilación está limpia de archivos antiguos
dotnet publish ArchiSteamFarm -c "Release" -f "net7.0" -o "out/generic" # O de acuerdo a lo que necesites según lo anterior

Ahora deberías ser capaz de encontrar los archivos de ASF-ui en tu carpeta out/generic/www. ASF podrá enviar esos archivos a tu navegador.

Alternativamente, puedes compilar solamente ASF-ui, ya sea manualmente o con la ayuda de nuestro repositorio, luego copia manualmente la compilación a la carpeta ${OUT}/www, donde ${OUT} es la carpeta de salida de ASF que especificaste con el parámetro -o. Esto es exactamente lo que ASF está haciendo como parte del proceso de compilación, copia ASF-ui/dist (si existe) a ${OUT}/www, nada extraño.

Desarrollo

Si deseas editar el código de ASF, para ello puedes usar cualquier IDE (entorno de desarrollo integrado) compatible con .NET, aunque incluso eso es opcional, ya que también puedes editarlo con un bloc de notas y compilarlo con el comando dotnet descrito arriba. Aún así, para Windows recomendamos el Visual Studio más reciente (la versión gratuita de la comunidad es más que suficiente).

Si quieres trabajar con el código de ASF en Linux/macOS, recomendamos el Visual Studio Code más reciente. No es tan rico como Visual Studio clásico, pero es bastante bueno.

Claro que todas las sugerencias anteriores son solo recomendaciones, puedes usar lo que desees, todo se reduce al comando dotnet build de todas formas. Usamos JetBrains Rider para el desarrollo de ASF, aunque no es una solución gratuita.

Etiquetas

La rama main no garantiza estar en un estado que permita una compilación exitosa o una ejecución de ASF sin fallas, ya que es una rama de desarrollo como indicamos en nuestro ciclo de lanzamiento. Si quieres compilar o referenciar ASF desde la fuente, entonces debes usar la etiqueta apropiada para ese fin, lo que garantiza una compilación exitosa, y muy probablemente también una ejecución sin fallas (si la compilación fue marcada como versión estable). Para comprobar la "salud" actual del árbol, puedes usar nuestra integración continua - GitHub.

Versiones oficiales

Las versiones oficiales de ASF son compiladas por GitHub en Windows, con el último .NET SDK que coincida con los requisitos de runtime de ASF. Después de pasar las pruebas, todos los paquetes son distribuidos como la versión, también en GitHub. Esto también garantiza transparencia, ya que GitHub siempre usa una fuente pública oficial para todas las compilaciones, y puedes comparar las sumas de verificación (checksums) de los artefactos de GitHub con los recursos de publicación de GitHub. Los desarrolladores de ASF no compilan ni publican versiones por cuenta propia, excepto para el proceso de desarrollo privado y depuración.

A partir de ASF V5.2.0.5, además de lo anterior, los mantenedores validan manualmente y publican sumas de verificación de compilación independientes de GitHub, el servidor remoto, como medida de seguridad adicional. Este paso es obligatorio para que los ASF existentes consideren la versión como un candidato válido para la funcionalidad de actualización automática.