resource

resources.json

The resources.json file is the file that is used to list all the resources used by your game.

module

fireform.resource.load(*paths, smooth_images=False)

Load resources.

Parameters:
paths : str

File paths to search relative to the working directory of the game.

Note

This may be changed to be relative to the program directory of the game in the future.

smooth_images : bool

Set to True to smooth images when they are resized. Most games should enable this. Pixel art games should not. Defaults to false.

fireform.resource.open_data(filename, mode='r')

Opens a file found in the search paths.

Parameters:
filename : str

The filename.

mode : str

The mode to open the file in. This is the same as the mode parameter on the builtin open function. Defaults to 'r' (read, text mode).