Desarrollo

De FFAA MOD Wiki
Saltar a: navegación, buscar

Primeros pasos

Aqui podrás encontrar información relevante sobre las pautas, consejos y ayudas para poder colaborar de la forma mas eficiente posible. También puede consultar la guía del usuario para obtener información sobre el uso del software wiki.

Sistema de versionado

El estándar o numeración de versionado actual se compone de dos parámetros [X.AB], aunque existe un último parámetro para las versiones de desarrollo [Y]:

  • X : Versión pública, implica cambios mayores y una versión completamente nueva del proyecto. Su valor actual es 6.
  • AB : Subversión pública, implica cambios menores o correciones del proyecto. Su valor crece de 0.0 a 9.9.
  • Y : Version privada solo para desarrolladores y testeadores, es la version de desarrollo y puede contener errores. Su valor se acota entre 0 y 9. Las versiones a punto de saltar a una subversión pública y apta para testeado se denomina RC (Release Candidate).

La versión 6.0.9 indica una versión pública numero 9 de la versión 6 del proyecto.
La versión 6.1.2.7 indica una versión de desarrollo, reiteración 7 de la versión pública 12 de la versión 6 del proyecto.
La versión 6.0.6 RC indica una versión Release Candidate, es la que potencialmente saldrá al público en la 6.0.6, solo disponible para testeadores.

Empaquetado automático de addons

TO-DO
Actualmente estudiando viabilidad para implantar mismo sistema que desarrolladores de ACE.

Instalación de software adicional

TO-DO

Instalacion de entorno de trabajo

TO-DO

Compilación y empaquetado

TO-DO

Funciones de exportación

Como extraer toda la información de la wiki directamente desde arma 3.
Para ello se han creado varias funciones especiales dentro del mod (a partir de la versión 6.0.4.6) que permiten la correcta exportación a formato wiki. Ya que las que se encuentran por defecto, no funcionan de manera correcta.

Funciones disponibles

Modo "Screenshots"

En el modo "screenshots", las capturas serán guardadas en {Mis documentos}/Arma 3 - Other Profiles\{Usuario}\Screenshots\exportCfg. Las capturas serán guardadas en formato .PNG, estas deben de ser convertidas (hay varias herramientas online para esto) a formato .JPG y volverlas a subir a la plataforma.

Lista de CfgPatches

Para mayor facilidad a la hora de generar esta documentación, las funciones permiten filtrar los addons que se van a procesar.
Aqui se encuentra disponible el array de cadenas de los CfgPatches disponibles hasta el momento.

["ffaa_ar_bam","ffaa_ar_harrier","ffaa_ar_infanteria","ffaa_ar_lcm","ffaa_ar_supercat","ffaa_ar_zodiac","ffaa_armas","ffaa_data","ffaa_ea_hercules","ffaa_ea_reaper","ffaa_estatico","ffaa_et_anibal","ffaa_et_brilat","ffaa_et_ch47","ffaa_et_cougar","ffaa_et_famet","ffaa_et_leopardo","ffaa_et_moe","ffaa_et_pegaso","ffaa_et_pizarro","ffaa_et_rg31","ffaa_et_searcher","ffaa_et_tigre","ffaa_et_toa","ffaa_et_vamtac","ffaa_rapel"]

Importación de errores a la wiki

Para una mayor comodidad de traspasos manuales desde la lista de errores en el feedback tracker, existe una función llamada ffaa_fnc_convertfeedtowiki introducido por el mod que convierte la lista nativa en formato wiki.

Extraer lista

Para ello vamos a la lista de los cambios recientes, situada aqui. La lista debe de tener el siguiente formato:

- 0999991: [Infanteria] Esto es una prueba de error - resuelta.
- 0999992: [Armas] Sigue siendo una prueba pero con categoría Armas - resuelta.
- 0999993: [Vehiculos] Este categoria vehiculos y resuelto por un desarrollador (Mickyleitor) - resuelta.

Preparación

A continuación, ejecutamos Arma 3 y creamos una nueva misión. Adicionalmente (recomendado), aqui esta disponible una misión para que transforme archivo "archivo.txt", lo lea y transforme todo ese contenido.
Para ello, descarga y mueve la carpeta descargada dentro de \Documents\Arma 3 - Other Profiles\{USUARIO}\missions.

Ejecución

Si has utilizado la plantilla de ejemplo, podremos cargar todo el texto situado en Documents\Arma 3 - Other Profiles\{USUARIO}\missions\FFAA_Convertfeedtowiki.VR\archivo.txt

  • Ejecutamos la llamada al archivo con esta sintaxis:
[loadFile "archivo.txt"] call ffaa_fnc_convertfeedtowiki;

Obtención

Si todo ha salido bien, tendrás en el Portapapeles toda la lista en formato wiki. Si has usado la plantilla, por defecto devuelve lo siguiente:

==Arreglados==
===General===
===Armas===
* Sigue siendo una prueba pero con categoría Armas (0999992)
===Infanteria===
* Esto es una prueba de error (0999991)
===Vehiculos===
* Este categoria vehiculos y resuelto por un desarrollador (0999993)
===Advanced Combat Environment===

Edición wiki

Ahora solo es necesario editar la página de Cambios, el apartado de Arreglados y añadir lo que la función ha devuelto.
De esta manera nos ahorraremos un valioso tiempo editando linea por linea cada incidencia y sus hiper vínculos, clasificandolo etc..

Publicación en Steam Workshop

Para el interes general para la publicación o actualización de un contenido en la plataforma de Steam Workshop se realiza con unos pasos muy sencillos.

Login

Se debe de realizar un login en con la cuenta del FFAA MOD (o en su defecto, quien sea el autor prinicipal del addon). No es válido login desde la web, se debe de realizar con el programa de steam de escritorio.

Alt text

Publisher

Dependiendo de la naturaleza del addon o misión (las misiones se actualizan directamente desde el EDEN, pero los pasos son casi idénticos), se procede a cumplimentar correctamente todos los datos relevantes. En concreto:

  • Mod content: Aqui deben de ir los archivos que se encuentran dentro de la carpeta @FFAAMOD (Ojo con lo que publicamos).
  • Change Notes: La lista de cambios para la presente versión. Por facilidad y mas comodidad, rediriguir directamente a nuestra [Cambios|página de cambios].
  • Description: Como el addon sigue siendo el mismo, no hace falta cambiarlo (además, se puede actualizar mas tarde desde la web).
Alt text

Para mas información sobre el Arma 3 Publisher aqui.

Publicar

El paso mas sencillo, publicarlo. Después de este paso, automáticamente todo el trabajo se delega a Steam. Nuestro trabajo ahora es anunciarlo a través de nuestras redes sociales (que no son pocas y es recomendable tenerlo preparado antes de publicar para que estos pasos sean instantáneos).

Colaboradores

Es recomendable añadir como colaboradores a todos los miembros del mod, ya que así aparecemos como autores del mismo (aunque el único que lo puede actualizar es quien lo ha publicado con el publisher), aprovechando la cantidad de visitas del FFAA MOD, se le da mas visualización a cualquier contenido que tenga el autor FFAA MOD.

Enlaces de ayuda