Skip to content

Commit a043789

Browse files
committed
updated README.md, and configured local server
new dependency installed to configure a server: express.js
1 parent 7d22ad3 commit a043789

File tree

6 files changed

+877
-22
lines changed

6 files changed

+877
-22
lines changed

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -59,37 +59,53 @@ Algunos caminos se encontrarán bloqueados, por lo que tendrás que hacer uso de
5959
* ``<SPACE>`` - Interactuar (carteles, cerraduras, etc.)
6060
* ``<SHIFT>`` - Correr
6161
* ``<ENTER>`` - Saltar cinemática
62-
* ``< ESC >`` - Regresar a la pantalla de inicio (**advertencia**: no hay menú de pausa)
62+
* ``< P >`` - Abrir menú de pausa
63+
64+
### Menú de pausa
65+
66+
* ``< P >`` - Reanudar el juego
67+
* ``< ESC >`` ``[dejar presionado]`` - Regresar al menú principal (reinicia el juego)
6368

6469
## Cómo jugar
6570

66-
¿Instalar? *pffff*. Basta con que abras el juego en el enlace de **GitHub Pages** que se encuentra en la información del repositorio, o dando [click aquí](https://complexralex.github.io/gamedev-final-project/).
71+
¿Instalar? *pffff*. Basta con que des [click aquí](https://complexralex.github.io/gamedev-final-project/). Este URL también se encuentra en la información del repositorio.
6772

6873
### Jugar desde código fuente
6974

70-
Para esto primero se requiere clonar el repositorio en cualquier directorio que se desee.
75+
Toma en cuenta que para jugarlo de manera local, es necesario que tengas instalado `Node.js` en tu computadora.
76+
77+
1. Primero se necesita clonar el repositorio:
78+
79+
```sh
80+
git clone https://github.com/ComplexRalex/gamedev-final-project.git
81+
```
7182

72-
Luego, para cargar el framework de Phaser 2D existen dos formas de hacerlo:
83+
2. Luego, se tienen que instalar las dependencias del proyecto:
7384

74-
1. Sobre la raíz del proyecto ejecutar ``npm init`` y *descomentar* la línea debajo del ``[1]`` en ``index.html``.
75-
2. Copiar la línea del *script* de la página https://cdnjs.com/libraries/phaser/3.55.2 y reemplazar la línea copiada por la que se encuentra debajo de ``[2]`` en ``index.html``.
85+
```sh
86+
npm install
87+
```
7688

77-
El archivo tiene una estructura similar a la siguiente:
89+
3. Después, se debe cargar el framework de Phaser 2D. Para esto, se puede usar directamente el CDN que **ya se encuentra configurado** en la línea `[2]`, u *opcionalmente* se puede cambiar por el que fue instalado en el paso anterior en la línea `[1]`, de la siguiente forma en el archivo `index.html`:
7890

7991
```html
8092
<body>
8193
<div id="phaser_container"></div>
82-
<!-- [1] Si tienes node_modules, usa este (comenta esta línea) -->
83-
<!-- <script src="./node_modules/phaser/dist/phaser.min.js"></script> -->
84-
<!-- [2] Si no usas node_modules, usa este (descomenta esta línea) -->
85-
<!-- ¡Reemplaza esta línea de código por la que copiaste de la página! -->
94+
<!-- [1] Con esta línea estarías usando la dependencia del paso 2 -->
95+
<script src="./node_modules/phaser/dist/phaser.min.js"></script>
96+
<!-- [2] En la siguiente línea, estarías usando el CDN, que ya se encuentra configurado -->
97+
<!-- (se extrajo el script de https://cdnjs.com/libraries/phaser/3.55.2) -->
8698
<script src="./src/main.js" type="module"></script>
8799
</body>
88100
```
89101

90-
Nota 1: Es posible que ya se encuentre el *script* en el archivo antes mencionado, por lo que no será necesario este paso.
102+
4. Por último, se tiene que iniciar el servidor local para ejecutar el juego:
103+
104+
```sh
105+
npm run start
106+
```
91107

92-
Nota 2: Para poder ejecutarlo desde código fuente (con cualquiera de las dos formas), se necesitará de un servidor web. Se puede hacer uso de ``http-server`` instalandolo con NPM ``npm install http-server`` y ejecutando con ``http-server`` dentro del directorio del proyecto.
108+
5. ¡En la dirección http://localhost:3000 se podrá jugar en cualquier navegador!
93109

94110
## Screenshots
95111

@@ -110,8 +126,7 @@ Nota 2: Para poder ejecutarlo desde código fuente (con cualquiera de las dos fo
110126

111127
## Planes futuros
112128

113-
* Agregar posibilidad de jugar en dispositivos móviles.
114-
* Agregar menú de pausa.
129+
* ~~Agregar posibilidad de jugar en dispositivos móviles.~~
115130
* Agregar un jefe final.
116131

117132
## Créditos

index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<link rel="icon" type="image/png" href="public/favicon.png">
88
<meta http-equiv="X-UA-Compatible" content="ie=edge">
9-
<title>Proyecto Final - El Mundo de Floresta</title>
9+
<title>El Mundo de Floresta</title>
1010
<style>
1111
* {
1212
margin: 0px;
@@ -21,9 +21,9 @@
2121

2222
<body>
2323
<div id="phaser_container"></div>
24-
<!-- Si tienes node_modules, usa este -->
24+
<!-- Dependencia de node_modules -->
2525
<!-- <script src="./node_modules/phaser/dist/phaser.min.js"></script> -->
26-
<!-- Si no usas node_modules, usa este -->
26+
<!-- Dependencia del CDN -->
2727
<script src="https://cdnjs.cloudflare.com/ajax/libs/phaser/3.55.2/phaser.min.js" integrity="sha512-kg6fSrg6FkD9Ua02PzuA289KatVkTp6HdiFrSKwnz1bKBeKe5JG54rNeYZeghYO/I4ka49rb9H/9Ezcq9Se3iQ==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
2828
<script src="./src/main.js" type="module"></script>
2929
</body>

0 commit comments

Comments
 (0)