Framework para la creación de servidores y resources en FiveM basados en Zombie Role-Play
Explora la documentación »
Reportar un bug
·
Solicitar función
Tabla de contenidos
Zombie Role-Play Framework es un framework para la creación de servidores y resources en FiveM basados en un modelo de juego de rol Zombie. El proyecto está altamente inspirado en es_extended en una de sus versiones legacy. Tan inspirado, que literalmente hay funciones que han sido directamente copiadas del proyexto.
Algunas de las dependencias son un fork de las originales. El único propósito de los forks es darle mantenimiento y asegurar que no habrá conflictos con futuras actualizaciones de las originales. Cada dependencia mantiene su
LICENCIAoriginal.
Para que el framework funcione correctamente, es necesario seguir una serie de pasos para poder configurarlo. Además es necesaria la instalación de algunas dependencias.
Antes de siquiera comenzar con la configuración del framework, es necesario que tengas instaladas las dependencias. Para hacerlo, descárgalas desde el enlace de la lista para cada una de ellas, y extrae los archivos del zip en la carpeta resources. Puedes crear una carpeta nueva llamada [dependencias] por ejemplo o puedes arrastrarla a alguna de las carpetas ya existentes como [system].
Para terminar con la instalación de las dependencias debes revisar en el repositorio o la página de cada dependencia los paso a seguir. Nosotros mostraremos aquí los más básicos.
-
mysql-async:
... set mysql_connection_string "user=zrp_username;database=zrp_framework;password=zrp_password" ... ensure mysql-async ...
También puedes seguir el asistente en la página: asistente.
Es importante que el
set mysql_connection_stringesté antes de la llamada aensure mysql-async.
Es MUY IMPORTANTE que todas las dependencias sean cargadas ANTES que el framework. Y que el framework sea cargado ANTES que todos los resources que lo utilicen.
- Descargar la última versión disponible (o la deseada) de la lista de versiones.
- Extraer el contenido del zip en la carpeta
[zrp]dentro deresources. Si la carpeta[zrp]no existe, puedes crearla tú mismo. - En el caso de que la carpeta extraída no se llame
zrp_framework, debes ponerle tú ese nombre (para evitar problemas de compatibilidad). - Agrega lo siguiente al archivo
server.cfgen la carpeta del servidorRecuerda que es importante que estas líneas se incluyan DESPUÉS de las líneas de las dependencias y ANTES de los resources que utilicen el framework.## ZRP Framework ensure zrp_framework add_ace resource.zrp_framework command.add_principal allow add_ace resource.zrp_framework command.add_ace allow
- Para configurar el framework, puedes hacerlo desde el archivo
config.luadentro de la carpeta que acabas de extraer. - Ejecutar el archivo
zrp_framework.sqlen la base de datos para crear las tablas necesarias.
Config = {}
Config.Locale = 'en'
Config.CheckVersion = true
Config.MapName = 'Palencia'
Config.GameType = 'Zombie Roleplay'
Config.MaxWeight = 24
Config.Traffic = {}
Config.Traffic.PedestrianAmount = 0
Config.Traffic.ParkedAmount = 15Config.Locale = 'es' contiene el idioma que usará el framework. Los idiomas disponibles están en la carpeta locales/. En el caso de no estar el idioma que quieres, puedes crearlo tú a partir de uno ya existente o modificar uno de los existentes.
Config.CheckVersion = true indica si quieres que el framework compruebe si hay alguna nueva versión existente. Lo hará una vez al iniciar el servidor, y luego una vez cada 8 horas y mostrará en consola un mensaje solamente si hay una versión disponible. No consume recursos del servidor, pero si no quiere que compruebe nuevas versiones, puede cambiarlo por false.
Config.MapName = 'Palencia' el nombre del mapa del servidor. Algo meramente estético y para la lista de servidores. Puede ponerle el nombre que quiera darle a su mapa.
Config.GameType = 'Zombie Roleplay' el tipo de juego que usará el servidor. En este caso no recomiendo cambiarlo, pero puede hacerlo si lo desea aunque puede crear confusión entre los jugadores.
Config.MaxWeight = 24 el peso máximo que puede llevar un jugador en kg. Puede ser aumentado si lleva algún objeto como mochila, o disminuido si tiene alguna enfermedad o algo así por ejemplo.
Config.Traffic.PedestrianAmount = 0 el porcentaje en relación al juego original de los peatones que aparecerán. Ahora está a 0 pero se planea aumentar ya que los peatones serán los zombies.
Config.Traffic.parkedAmount = 15 el porcentaje en relación al juego original de los vehículos que aparecerán aparcados en el mapa.
Aun se está trabajando en la creación del propio framework para traer una versión estable, por lo que aún no hay ninguna documentación disponible para crear resources haciendo uso del framework. Se está trabajando en la documentación.
Hay un resource demo de cómo se usa el framework y cómo se planeará usar. Puede verlo en el repositorio Eschiclers/zrp_demo.
Aún se está trabajando en la documentación para contribuir en el desarrollo del framework, pero puede contribuir ya haciendo pull requests.
Lo único que se pide hasta que haya documentación para las contribuciones, es seguir las convenciones de commits y que se siga la estructura que tiene el proyecto.
Este proyecto utiliza la licencia AGPL-3.0. Consulte el archivo LICENSE para más información.
Chicle - @eschiclers - [email protected]
Enlace del proyecto: https://github.com/Eschiclers/zrp_framework
- @othneildrew por esta plantilla de README
- ESX Framework por ser la idea en la que está basada este proyecto