Trabajar con archivos

Hay muchas maneras diferentes de crear y/o acceder a archivos. Las rutas de archivo y las formas en que accedes a estos archivos varían según el tipo de archivo y su ubicación.

Funciones para acceder a archivos y carpetas

Defold proporciona varias funciones diferentes para trabajar con archivos:

• Puedes usar las funciones estándar io.* para leer y escribir archivos. Estas funciones te dan un control muy detallado sobre todo el proceso de E/S.

-- abrir myfile.txt para escritura en modo binario
-- devuelve nil más un mensaje de error si falla
local f, err = io.open("path/to/myfile.txt", "wb")
if not f then
	print("Something went wrong while opening the file", err)
	return
end

-- escribir en el archivo, vaciarlo al disco y luego cerrar el archivo
f:write("Foobar")
f:flush()
f:close()

-- abrir myfile.txt para lectura en modo binario
-- devuelve nil más un mensaje de error si falla
local f, err = io.open("path/to/myfile.txt", "rb")
if not f then
	print("Something went wrong while opening the file", err)
	return
end

-- leer el archivo completo como string
-- devuelve nil si falla
local s = f:read("*a")
if not s then
	print("Error while reading file")
	return
end

print(s) -- Foobar

• Puedes usar os.rename() y os.remove() para renombrar y eliminar archivos.

• Puedes usar sys.save() y sys.load() para leer y escribir tablas Lua. Existen funciones sys.* adicionales para ayudar con la resolución de rutas de archivo independiente de la plataforma.

-- obtener una ruta independiente de la plataforma al archivo "highscore" para la aplicación "mygame"
local path = sys.get_save_file("mygame", "highscore")

-- guardar una tabla Lua con algunos datos
local ok = sys.save(path, { highscore = 100 })
if not ok then
	print("Failed to save", path)
	return
end

-- cargar los datos
local data = sys.load(path)
print(data.highscore) -- 100

Ubicaciones de archivos y carpetas

Las ubicaciones de archivos y carpetas se pueden dividir en tres categorías:

• Archivos específicos de la aplicación creados por tu aplicación
• Archivos y carpetas empaquetados con tu aplicación
• Archivos específicos del sistema a los que accede tu aplicación

Cómo guardar y cargar archivos específicos de la aplicación

Al guardar y cargar archivos específicos de la aplicación, como puntuaciones altas, configuración de usuario y estado del juego, se recomienda hacerlo en una ubicación proporcionada por el sistema operativo y destinada específicamente a este propósito. Puedes usar sys.get_save_file() para obtener la ruta absoluta específica del sistema operativo a un archivo. Una vez que tengas la ruta absoluta, puedes usar las funciones sys.*, io.* y os.* (consulta arriba).

Consulta el ejemplo que muestra cómo usar sys.save() y sys.load().

Cómo acceder a archivos empaquetados con la aplicación

Puedes incluir archivos con tu aplicación usando Custom Resources y Bundle Resources.

Recursos personalizados (Custom Resources)

Los recursos personalizados se empaquetan en el archivo principal del juego usando el campo Custom Resources en game.project.

El campo Custom Resources debe contener una lista separada por comas de los recursos que se incluirán en el archivo principal del juego. Si se especifican directorios, todos los archivos y directorios dentro de ese directorio se incluyen de forma recursiva. Puedes leer los archivos usando sys.load_resource().

-- Cargar los datos del nivel en un string
local data, error = sys.load_resource("/assets/level_data.json")
-- Decodificar el string JSON a una tabla Lua
if data then
  local data_table = json.decode(data)
  pprint(data_table)
else
  print(error)
end

Recursos de bundle (Bundle Resources)

Los recursos de bundle son archivos y carpetas adicionales ubicados como parte del bundle de tu aplicación usando el campo Bundle Resources en game.project.

El campo Bundle Resources debe contener una lista separada por comas de directorios que contienen archivos de recursos y carpetas que deben copiarse tal cual en el paquete resultante al crear el bundle. Los directorios deben especificarse con una ruta absoluta desde la raíz del proyecto, por ejemplo /res. El directorio de recursos debe contener subcarpetas con nombres según platform o architecture-platform.

Las plataformas soportadas son ios, android, osx, win32, linux, web, switch. También se permite una subcarpeta llamada common, que contiene archivos de recursos comunes para todas las plataformas. Ejemplo:

res
├── win32
│   └── mywin32file.txt
├── common
│   └── mycommonfile.txt
└── android
    ├── myandroidfile.txt
    └── res
        └── xml
            └── filepaths.xml

Puedes usar sys.get_application_path() para obtener la ruta donde está almacenada la aplicación. Usa esta ruta base de la aplicación para crear la ruta absoluta final a los archivos a los que necesitas acceder. Una vez que tengas la ruta absoluta de estos archivos, puedes usar las funciones io.* y os.* para acceder a los archivos.

local path = sys.get_application_path()
local f = io.open(path .. "/mycommonfile.txt", "rb")
local txt, err = f:read("*a")
if not txt then
	print(err)
	return
end
print(txt)

Comparación de Custom Resources y Bundle Resources

Acceso a archivos del sistema

El acceso a los archivos del sistema puede estar restringido por el sistema operativo por motivos de seguridad. Puedes usar la extensión nativa extension-directories para obtener la ruta absoluta a algunos directorios comunes del sistema (por ejemplo, documents, resource, temp). Una vez que tengas la ruta absoluta, puedes usar las funciones io.* y os.* para acceder a los archivos (consulta arriba).

Extensiones

El Asset Portal contiene varios assets para simplificar el acceso a archivos y carpetas. Algunos ejemplos:

• Lua File System (LFS) - Funciones para trabajar con directorios, permisos de archivo, etc.
• DefSave - Un módulo que te ayuda a guardar / cargar configuración y datos del jugador entre sesiones.