[MINIGAME] Minigame Example

[RoiMP]

My example minigame name

This is an example to show how an issue for a minigame creation will look in GitHub.

There are a few templates available to make issue creation easier.

Features

Basic (simple version)

Here are a few features about what I'm going to implement in the basic version

• [ ] The user can use the mouse to click something
• [ ] A single map/level is available

Advanced (once the simple version is reached)

Now a list of more advanced features

• [ ] 3 maps/levels available
• [ ] The user can now also use the keyboard to play
• [ ] New images and UI improved
• [ ] Add delight to the experience when all tasks are complete :tada:

Aditional content

Just an image so you can see how it looks like

Feel free to add any other information, screenshots of the game, thoughts, etc here.

[MarcoteRL]

Cómo subir un minijuego

1. Crear carpeta del minijuego y HTML

• Primero, debemos de ir a la ruta -> src/minigames/templates
• Dentro crearemos la carpeta con el nombre de nuestro minijuego y dentro de esta carpeta incluiremos el archivo HTML
• El archivo HTML tendrá el siguiente formato:

{% extends 'minigame_base.html' %}
{% load bootstrap5 %}
{% load static %}

// Dentro de % block, incluiremos el contenido de nuestro minijuego,
// el contenido debe de estar dentro de un div como el ejemplo de abajo:

{% block minigame %}
    <div id="game">
        <h1>Wordle</h1>
    </div>
{% endblock %}

2. Modificar views.py y urls.py

• Primero accederemos a views.py que se encuenta en: src/minigames/views.py
• Crearemos una función con el nombre de nuestro minijuego, con el siguiente formato:

def nombre_minijuego(request):
    """Nombre Minijuego
    """

    #En template_name debemos de poner la ruta de nuestro minijuego:

    template_name = 'carpeta/minigame.html'
    return render(request, template_name)

• Finalmente añadiremos la ruta y y enlazaremos la función creada en el archivo views.py al archivo urls.py, para ello accederemos a la siguiente ruta: src/minigames/views.py
• Añadimos la ruta en el array de urlpatterns:

from .views import mock_minigame_view, tu_minijuego_view #Se importa aquí la función creada en views.

urlpatterns = [
    path('mock_minigame/', mock_minigame_view),
    #Añadiremos la ruta con el siguiente formato:
    path('tu-minijuego/', nombre_minijuego),
]

3. Subirlo a la rama principal.

Para subirlo a la rama principal, debemos primero de tener nuestra rama actualizada con el branch main. Para ello, nos aseguramos que estamos en nuestra rama y haremos:

git merge main

Esto actualizará nuestra rama con los datos de la principal. Finalmente ya podremos subir nuestros archivos:

git add .
git commit -m "Mensaje de commit"
git push

Y por último haremos un pull request desde GitHub.