Speedrun.com Discord Webhook

Este proyecto es una aplicación de consola en C# que obtiene los mejores récords personales (Personal Bests o PBs) de un usuario de Speedrun.com y los publica en un canal de Discord a través de un Webhook.

La aplicación está diseñada para ser ejecutada tanto localmente para pruebas como de forma automatizada usando GitHub Actions.

Nota: Este proyecto utiliza una versión preliminar de .NET 10.

Características

• Consulta a la API de Speedrun.com: Obtiene los PBs de un usuario específico.
• Extracción de Datos: Extrae el nombre del juego, la categoría y el tiempo del récord.
• Integración con Discord: Construye y envía un mensaje formateado a un Webhook de Discord usando Embeds para una mejor visualización.
• Seguridad: Maneja las claves secretas (Webhook URL) y la configuración (nombre de usuario) a través de variables de entorno, evitando exponerlas en el código fuente.
• Automatización: Incluye un flujo de trabajo de GitHub Actions para ejecutar la aplicación de forma programada.

Cómo Empezar

Prerrequisitos

• .NET SDK (versión 10.0.302 o superior)
• Una cuenta de GitHub para la automatización.
• Un Webhook de Discord.

---

1. Configuración para Desarrollo Local

Para probar la aplicación en tu máquina local:

1. Clona el repositorio.

2. Crea un archivo .env: Copia el archivo .env.example y renómbralo a .env.

   cp .env.example .env

3. Modifica el archivo .env: Abre el archivo .env y reemplaza los valores de ejemplo con tus datos reales.

   # La URL completa del Webhook de tu canal de Discord.
   DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/..."
   
   # El nombre de usuario exacto de Speedrun.com que quieres consultar.
   SPEEDRUN_USERNAME="nombredeusuario"

   El archivo .gitignore ya está configurado para que .env no se suba a tu repositorio.

4. Ejecuta la aplicación: Abre una terminal en la raíz del proyecto y ejecuta los siguientes comandos:

   # Restaura las dependencias (solo la primera vez)
   dotnet restore
   
   # Ejecuta la aplicación
   dotnet run

---

2. Configuración para Automatización con GitHub Actions

Para que la aplicación se ejecute automáticamente en un horario definido:

1. Sube el código a tu repositorio de GitHub.

2. Configura los Secrets en GitHub:

   • Ve a tu repositorio en GitHub.

   • Haz clic en Settings > Secrets and variables > Actions.

   • Haz clic en New repository secret para añadir cada una de las siguientes variables:

     • DISCORD_WEBHOOK_URL: Pega aquí la URL de tu Webhook de Discord.
     • SPEEDRUN_USERNAME: Escribe el nombre de usuario de Speedrun.com.

3. Activa el flujo de trabajo: El flujo de trabajo definido en .github/workflows/main.yml se activará automáticamente según el cron especificado. También puedes ejecutarlo manualmente desde la pestaña Actions de tu repositorio.

Estructura del Código

• Program.cs: Lógica principal de la aplicación.
• SpeedrunWebhook.csproj: Archivo de proyecto que define el TargetFramework a net10.0 y las dependencias.
• global.json: Asegura que se utilice el SDK de .NET 10.
• .github/workflows/main.yml: Define el flujo de trabajo de GitHub Actions para la ejecución automatizada con .NET 10.