Requisitos de documentación - POOA-2017-2/Connect4 GitHub Wiki

I. Manual para el jugador (USUARIO-CLIENTE).

I.1 Introducción.

El Usuario-Cliente sera el segundo jugador del juego. Este jugador estará restringido a ciertas opciones de la aplicación y no podrá hacer cambios en la configuración del juego.

I.2 Reglas del juego.

La única regla de este juego es que un jugador no puede "tirar" dos veces. Pero el juego esta programado y validado para que eso no pase, así que no habrá problema. El Usuario-Cliente no podrá agregar o eliminar usuarios, solo podrá ver las estadísticas y utilizar la pestaña de Ayuda.

I.3 Instrucciones para el jugador.

El Usuario-Cliente debe esperar a que el Usuario-Administrador inicie el juego. Una vez que se haya iniciado el juego, el primer turno para "tirar" la ficha sera para el Usuario-Administrador, enseguida sera el turno del Usuario-Cliente como segundo jugador.

I.4 FAQ y resolución de problemas.

  1. Como puedo empezar a jugar?

Se debe esperar a que el Usuario-Administrador inicie la aplicación para que aparezca la segunda ventana del juego con la que el Usuario-Cliente estará jugando.

  1. Como puedo agregar un usuario?

Solamente el Usuario-Administrador puede agregar y eliminar usuarios ya que el Usuario-Cliente no tiene acceso a la opción para agregar o eliminar usuarios.

  1. Que puedo hacer si ya no quiero seguir jugando pero quiero conservar mi puntuaje?

Si estas en medio de una partida y ya no deseas seguir jugando, basta con cerrar la ventana de la aplicación. Se debe tomar en cuenta que la partida actual se perderá y tu puntuaje quedara intacto como lo habías dejado la ultima vez que jugaste.

II. Manual para el administrador (USUARIO-ADMINISTRADOR).

II.1 Introducción.

El usuario que tomara el rol de Administrador sera el responsable de iniciar la aplicación y tener el control total del juego todo el tiempo.

II.2 Reglas de configuración.

El Usuario-Administrador debe correr la aplicación y no el Usuario-Cliente. Cuando el Usuario-Administrador inicie el juego debe escoger una de dos configuraciones. Las dos configuraciones son:

  • Una pantalla: Esta configuración es para que jueguen ambos usuarios (cliente y administrador) en la misma ventana, alternándose los jugadoras para "tirar" su ficha.
  • Pantalla dividida: Esta configuración es para jugar el mismo juego en dos ventanas diferentes.

II.3 Instrucciones para el administrador.

Como Usuario-Administrador, se debe iniciar la aplicación y escoger una de dos configuraciones en el menú de inicio principal para así mismo poder empezar a jugar. En el caso de haber escogido Pantalla Dividida, otra ventana aparecerá en la misma pantalla con el juego listo para iniciar la partida. Este usuario deberá crear usuarios (en caso de que no exista ninguno) para poder jugar.

II.4 FAQ y resolución de problemas.

  1. Que configuración inicial debo escoger para jugar?

Si se cuenta con dos ratones en el mismo ordenador se recomienda escoger la opción de "Pantalla Dividida" ya que puede llegar a ser molesto para los dos jugadores usar el mismo ratón para "tirar" sus fichas. Si no se cuenta con la ayuda de dos ratones, se recomienda la opción de "Una pantalla".

  1. Como puedo agregar un usuario?

Los usuarios se pueden agregar entrando a la pestaña "Editar" del menú que se encuentra en la parte de arriba de la aplicación y escoger la opción de "Agregar Usuario". Se debe tomar en cuenta que solamente el Usuario-Administrador puede agregar y eliminar usuarios ya que solamente podrá tener acceso a opción.

  1. Que puedo hacer si ya no quiero seguir jugando pero quiero conservar mi puntuaje?

Si estas en medio de una partida y ya no deseas seguir jugando, basta con cerrar la ventana de la aplicación. Se debe tomar en cuenta que la partida actual se perderá y tu puntuaje quedara intacto como lo habías dejado la ultima vez que jugaste.

III. Reporte técnico.

III.1 Introducción

Si se desea compilar y/o correr la aplicación desde la terminal de Windows MS-DOS, se debe tomar en cuenta que este proyecto contiene mas de una clase que contiene un "main". Por lo tanto se debe 'correr' la clase "Menu.java". Si se importa a un IDE como "Eclipse" o "Netbeans", basta con correr la misma clase ya que desde ahí se invocan todas las demas clases.

III.2 Requisitos del sistema.

Windows

  • Windows 10 (8u51 y superiores)
  • Windows 8.x (escritorio)
  • Windows 7 SP1
  • Windows Vista SP2
  • Windows Server 2008 R2 SP1 (64 bits)
  • Windows Server 2012 y 2012 R2 (64 bits)
  • RAM: 128 MB
  • Espacio en disco: 124 MB para JRE; 2 MB para Java Update
  • Procesador: Mínimo Pentium 2 a 266 MHz
  • Exploradores: Internet Explorer 9 y superior, Firefox

Mac OS X

  • Mac con Intel que ejecuta Mac OS X 10.8.3+, 10.9+
  • Privilegios de administrador para la instalación
  • Explorador de 64 bits

Linux

  • Oracle Linux 5.5+1
  • Oracle Linux 6.x (32 bits), 6.x (64 bits)2
  • Oracle Linux 7.x (64 bits)2 (8u20 y superiores)
  • Red Hat Enterprise Linux 5.5+1, 6.x (32 bits), 6.x (64 bits)2
  • Red Hat Enterprise Linux 7.x (64 bits)2 (8u20 y superiores)
  • Suse Linux Enterprise Server 10 SP2+, 11.x
  • Suse Linux Enterprise Server 12.x (64 bits)2 (8u31 y superiores)
  • Ubuntu Linux 12.04 LTS, 13.x
  • Ubuntu Linux 14.x (8u25 y superiores)
  • Ubuntu Linux 15.04 (8u45 y superiores)
  • Ubuntu Linux 15.10 (8u65 y superiores)
  • Exploradores: Firefox

III.3 Especificaciones técnicas.

Para poder modificar este proyecto se necesita la ultima version de Java SE Development Kit de Oracle. Se recomienda utilizar un IDE.

III.4 Instrucciones para el programador.

Si se quisiera modificar alguna parte de la aplicación, se debe saber que existen dos paquetes con distintas clases. El paquete "conecta4" contiene la mayoría de las clases de la aplicación:

  • AboutUs: Contiene la información de los programadores que desarrollaron la aplicación.
  • Estadisticas: Contiene los puntuajes de los jugadores que están registrados. Solo los mas altos puntuajes aparecen en esta pantalla.
  • Ficha: Contiene parámetros de la ficha.
  • Instrucciones: Contiene las instrucciones del juego.
  • Main: Es la clase principal con la que correrán todas las anteriores y siguientes.
  • Musica: Es la clase donde se controla la música de la aplicación.
  • Presentacion: Contiene la pantalla de bienvenida donde se podrá agregar usuarios y ver las estadísticas.
  • Registro: Contiene la ventana gráfica donde se podrá agregar o eliminar usuarios.
  • Tablero: Contiene la pantalla de la aplicación donde se estará jugando.
  • Usuarios: Contiene los parámetros de los jugadores registrados.

El siguiente paquete se llama "logica" y contiene la clase:

  • logicaTablero: Esta clase contiene toda la lógica del juego donde se encuentran validaciones de los turnos de los jugadores, quien gana, quien pierde, etc.

Existen dos carpetas mas en este proyecto que contienen archivos que se utilizaron en el desarrollo del juego:

  • img: Esta carpeta contiene todas las imágenes e iconos de la aplicación.
  • music: Esta carpeta contiene todos los audios implementados en la aplicación.