All Functions Modules Pages
game

Functions

IMAGE game.geticon0 (STRING path)
 Load the icon0.png stored in an EBOOT.PBP/VPK/ISO/CSO to use it after. More...
 
IMAGE game.getpic0 (STRING path)
 Load the pic0.png/startup.png stored in an EBOOT.PBP/VPK/ISO/CSO to use it after. More...
 
IMAGE game.getpic1 (STRING path)
 Load the pic1.png/pic0.png stored in an EBOOT.PBP/VPK/ISO/CSO to use it after. More...
 
IMAGE game.startup (STRING path)
 Loads a 'startup' image of an application. More...
 
IMAGE game.bg0 (STRING path)
 Carga una imagen 'bg0' de una aplicacion. More...
 
TABLE game.info (STRING path)
 Get the info stored in the PARAM.SFO file of an EBOOT.PBP/VPK/ISO/CSO/SFO. More...
 
NUMBER game.setsfo (STRING path, STRING Param, STRING value)
 Allows to set or change the content of a STRING field on a PARAM.SFO. More...
 
NUMBER game.setsfo (STRING path, STRING Param, NUMBER value)
 Allows to set or change the content of a NUMERIC field on a PARAM.SFO. More...
 
NIL game.launch (STRING gameid)
 Executes a content Homebrew/Game for his gameid. More...
 
NIL game.open (STRING gameid)
 Open a content Homebrew/Game for his ID. More...
 
NIL game.close (STRING gameid)
 Closes a Homebrew/Game content using its ID. More...
 
NUMBER game.install (STRING src)
 Install the .vpk on the system. More...
 
NUMBER game.install (STRING src, BOOLEAN check)
 Install the .vpk on the system. More...
 
NUMBER game.install (STRING src, NUMBER size)
 Install the .VPK on the system. More...
 
NUMBER game.install (STRING src, NUMBER size, BOOLEAN check)
 Install the .VPK on the system. More...
 
NUMBER game.installdir (STRING src)
 Install the content of the .VPK on the system. More...
 
TABLE game.list (NUMBER type)
 Allows to get a list of all the games installed at ux0, ur0 and uma0 on the console. More...
 
NUMBER game.move (STRING gameid, NUMBER toggle)
 Allows to move a game or app between the different available partitions: ux0, ur0 or uma0. More...
 
NUMBER game.move (STRING gameid, NUMBER toggle, NUMBER size)
 Allows to move a game or app between the different available partitions: ux0, ur0 or uma0. More...
 
NUMBER game.delete (STRING gameid)
 Allows to delete a game or an app from the console system. More...
 
NUMBER game.exists (STRING gameid)
 Allows to check if a game or an app already exist on the console system. More...
 
NUMBER game.changeinfo (STRING path)
 Allows add a changeinfo.xml in system, with changes in the running application. More...
 
NUMBER game.changeinfo (STRING path, STRING gameid)
 Allows add a changeinfo.xml in system, with changes in a specific application. More...
 
STRING game.sceid (STRING path)
 Allows to get the GAMEID from the __sce_ebootpbp file. More...
 
BOOLEAN game.rif (STRING gameid)
 Checks if there is an existent valid bounded rif license for a Homebrew/Game. More...
 
BOOLEAN game.frif (STRING gameid)
 Checks if there is an existent valid rif license for a Homebrew/Game. More...
 
NUMBER game.refresh (STRING gameid)
 Allows to install the contents of an app/game in the system. More...
 
BOOLEAN game.mount (STRING gameid)
 Allows to mount an app/game with PFS content. More...
 
NUMBER game.umount (STRING gameid)
 Allows to unmount an app/game with PFS content previously mounted. More...
 

Detailed Description

EBOOT.PBP/VPK/ISO/CSO/SFO files functions.

Function Documentation

IMAGE game.geticon0 ( STRING  path)

Load the icon0.png stored in an EBOOT.PBP/VPK/ISO/CSO to use it after.

Parameters
pathPath to the EBOOT.PBP/VPK/ISO/CSO.
Returns
An IMAGE object (return nil if the EBOOT.PBP/VPK/ISO/CSO doesn't have the resource).
IMAGE game.getpic0 ( STRING  path)

Load the pic0.png/startup.png stored in an EBOOT.PBP/VPK/ISO/CSO to use it after.

Parameters
pathPath to the EBOOT.PBP/VPK/ISO/CSO.
Returns
An IMAGE object (return nil if the EBOOT.PBP/VPK/ISO/CSO doesn't have the resource).
IMAGE game.getpic1 ( STRING  path)

Load the pic1.png/pic0.png stored in an EBOOT.PBP/VPK/ISO/CSO to use it after.

Parameters
pathPath to the EBOOT.PBP/VPK/ISO/CSO.
Returns
An IMAGE object (return nil if the EBOOT.PBP/VPK/ISO/CSO doesn't have the resource).
IMAGE game.startup ( STRING  path)

Loads a 'startup' image of an application.

Parameters
pathPath to the application folder, example: 'ux0:/app/MLCL00001/'.
Returns
An object of type IMAGE in case of success, otherwise returns nil.
IMAGE game.bg0 ( STRING  path)

Carga una imagen 'bg0' de una aplicacion.

Parameters
pathPath to the application folder, example: 'ux0:/app/MLCL00001/'.
Returns
An object of type IMAGE in case of success, otherwise returns nil.
TABLE game.info ( STRING  path)

Get the info stored in the PARAM.SFO file of an EBOOT.PBP/VPK/ISO/CSO/SFO.

Parameters
pathPath to the EBOOT.PBP/VPK/ISO/CSO/SFO.
Returns
A table with these fields:
  • APP_VER
  • BOOTABLE
  • CATEGORY
  • DISC_ID
  • DISC_NUMBER
  • DISC_TOTAL
  • DISC_VERSION
  • GAMEDATA_ID
  • HRKGMP_VER
  • PARENTAL_LEVEL
  • PSP_SYSTEM_VER
  • REGION
  • TITLE
  • TITLEID
  • USE_USB
Warning
The previous list show the most common fields, however, the returned table couldn't have all the listed fields, or even it could have other non-listed fields, so is very important to make sure any field exists before use it.
NUMBER game.setsfo ( STRING  path,
STRING  Param,
STRING  value 
)

Allows to set or change the content of a STRING field on a PARAM.SFO.

Parameters
pathIs the path to param.sfo.
ParamIs the field to set or change.
valueThe value to set in the param.sfo (Must be a STRING).
Returns
It will return a numeric value 1 if succeded, or a numeric value below 0 in case of error.
NUMBER game.setsfo ( STRING  path,
STRING  Param,
NUMBER  value 
)

Allows to set or change the content of a NUMERIC field on a PARAM.SFO.

Parameters
pathIs the path to param.sfo.
ParamIs the field to set or change.
valueThe value to set in the param.sfo (Must be a NUMERIC value).
Returns
It will return a numeric value 1 if succeded, or a numeric value below 0 in case of error.
NIL game.launch ( STRING  gameid)

Executes a content Homebrew/Game for his gameid.

Parameters
gameidContent identifier, such as "PCSG00524".
Returns
Nothing.
NIL game.open ( STRING  gameid)

Open a content Homebrew/Game for his ID.

Parameters
gameidContent identifier, such as "PCSG00524".
Returns
Nothing.
NIL game.close ( STRING  gameid)

Closes a Homebrew/Game content using its ID.

Parameters
gameidContent identifier, example "PCSG00524".
Note
This argument could be skiped, If done so, all open Apps will be closed.
Returns
Nothing.
NUMBER game.install ( STRING  src)

Install the .vpk on the system.

Parameters
srcPath to the .VPK file.
Note
  • This function can use the onAppInstall() callback, more info here .
  • This function checks by default if a vpk is Unsafe/Dangerous.
Returns
1 if success, 0 otherwise.
NUMBER game.install ( STRING  src,
BOOLEAN  check 
)

Install the .vpk on the system.

Parameters
srcPath to the .VPK file.
checktrue/false according to required check, if a vpk is Unsafe or Dangerous.
Note
  • This function can use the onAppInstall() callback, more info here .
Returns
1 if success, 0 otherwise.
NUMBER game.install ( STRING  src,
NUMBER  size 
)

Install the .VPK on the system.

Parameters
srcPath to the .VPK file.
sizeTotal uncompressed size in bytes (can be easily obtained using files.scan()).
Note
  • This function can use the onAppInstall() callback, more info here .
  • This function checks by default if a vpk is Unsafe/Dangerous.
Returns
1 if success, 0 otherwise.
NUMBER game.install ( STRING  src,
NUMBER  size,
BOOLEAN  check 
)

Install the .VPK on the system.

Parameters
srcPath to the .VPK file.
sizeTotal uncompressed size in bytes (can be easily obtained using files.scan()).
checktrue/false according to required check, if a vpk is Unsafe or Dangerous.
Note
  • This function can use the onAppInstall() callback, more info here .
Returns
1 if success, 0 otherwise.
NUMBER game.installdir ( STRING  src)

Install the content of the .VPK on the system.

Parameters
srcThe path to the resources of the .VPK to be installed.
Note
  • This function is designed to install .VPKs, applications or contents that are sent unpacked in a folder.
  • This function can use the onAppInstall() callback, more info here .
Returns
1 if success, 0 otherwise.
TABLE game.list ( NUMBER  type)

Allows to get a list of all the games installed at ux0, ur0 and uma0 on the console.

Parameters
typeWhen using any of the following values, a list will be created according to the chosen value:
  • __GAME_LIST_ALL (1) To get a complete list of all the games/hbs installed in the console.
  • __GAME_LIST_PSPEMU (2) To get a list of the installed games/hbs at pspemu/PSP/GAME.
  • __GAME_LIST_APP (3) To get a list of PSVita games/hbs installed at ux0:app, ur0:app, y uma0:app.
  • __GAME_LIST_SYS (4) To get a list of Livearea system apps such as Near, PSNStore...
Returns
A table with the next fields:
  • id: Is the installed game's GAMEID (STRING).
  • type: Is the installed game's category, example "gd", "gdp", "mb" (STRING).
  • version: Is the installed game's version: "01.00" (STRING).
  • title: Is the installed game's title (STRING).
  • path: Installed game's complete path (STRING).
  • dev: Is the partition where the game/app is installed: "ux0", "ur0", "uma0" or "vs0" (STRING).
NUMBER game.move ( STRING  gameid,
NUMBER  toggle 
)

Allows to move a game or app between the different available partitions: ux0, ur0 or uma0.

Parameters
gameidIs the GAMEID of the game we are trying to move.
toggleIs the numeric value to indicate where the game or app is going to be moved.
  • __GAME_MOVE_UX02UR0 (1) Allows to move from ux0 to ur0.
  • __GAME_MOVE_UR02UX0 (2) Allows to move from ur0 to ux0.
  • __GAME_MOVE_UX02UMA0 (3) Allows to move from ux0 to uma0.
  • __GAME_MOVE_UMA02UX0 (4) Allows to move from uma0 to ux0.
  • __GAME_MOVE_UR02UMA0 (5) Allows to move from ur0 to uma0.
  • __GAME_MOVE_UMA02UR0 (6) Allows to move from uma0 to ur0.
Note
  • This function creates an app.db system file backup to path:"ux0:/data/backup/db/app_orig.db".
Returns
1 if success, 0 otherwise.
NUMBER game.move ( STRING  gameid,
NUMBER  toggle,
NUMBER  size 
)

Allows to move a game or app between the different available partitions: ux0, ur0 or uma0.

Parameters
gameidIs the GAMEID of the game we are trying to move.
toggleIs the numeric value to indicate where the game or app is going to be moved.
  • __GAME_MOVE_UX02UR0 (1) Allows to move from ux0 to ur0.
  • __GAME_MOVE_UR02UX0 (2) Allows to move from ur0 to ux0.
  • __GAME_MOVE_UX02UMA0 (3) Allows to move from ux0 to uma0.
  • __GAME_MOVE_UMA02UX0 (4) Allows to move from uma0 to ux0.
  • __GAME_MOVE_UR02UMA0 (5) Allows to move from ur0 to uma0.
  • __GAME_MOVE_UMA02UR0 (6) Allows to move from uma0 to ur0.
size(OPCIONAL) Total size in bytes: partitions:app/GAMEID. partitions should be ux0:,ur0 or uma0:
Note
  • This function creates an app.db system file backup to path:"ux0:/data/backup/db/app_orig.db".
Returns
1 if success, 0 otherwise.
NUMBER game.delete ( STRING  gameid)

Allows to delete a game or an app from the console system.

Parameters
gameidIs the GAMEID of the game or app we are trying to delete.
Returns
1 if success, 0 otherwise.
NUMBER game.exists ( STRING  gameid)

Allows to check if a game or an app already exist on the console system.

Parameters
gameidIs the GAMEID of the checked game or app.
Returns
1 if success, 0 otherwise.
NUMBER game.changeinfo ( STRING  path)

Allows add a changeinfo.xml in system, with changes in the running application.

Parameters
pathIt is the path to 'changeinfo.xml'.
Returns
A numerical value of 1 on success, 0 otherwise.
NUMBER game.changeinfo ( STRING  path,
STRING  gameid 
)

Allows add a changeinfo.xml in system, with changes in a specific application.

Parameters
pathIt is the path to 'changeinfo.xml'.
gameidIt is the identifier of the application.
Returns
A numerical value of 1 on success, 0 otherwise.
STRING game.sceid ( STRING  path)

Allows to get the GAMEID from the __sce_ebootpbp file.

Parameters
pathComplete path of the __sce_ebootpbp file.
Returns
the GAMEID if found, otherwise will return the string "---"
BOOLEAN game.rif ( STRING  gameid)

Checks if there is an existent valid bounded rif license for a Homebrew/Game.

Parameters
gameidContent identifier of the application.
Returns
true/false In case it exists or not.
BOOLEAN game.frif ( STRING  gameid)

Checks if there is an existent valid rif license for a Homebrew/Game.

Parameters
gameidIt is the identifier of the application.
Returns
true/false In case it exists or not.
NUMBER game.refresh ( STRING  gameid)

Allows to install the contents of an app/game in the system.

Parameters
gameidIt is the identifier of the application.
Note
This function must be used together with the functions game.rif(). and game.frif(). The Homebrew EasyPowerRefresh can be checked to see how this functions work.
Returns
It will return a numeric value 1 if succeded, or a numeric value below 0 in case of error.
BOOLEAN game.mount ( STRING  gameid)

Allows to mount an app/game with PFS content.

Parameters
gameidIt is the identifier of the application.
Returns
true/false In case of success or not.
NUMBER game.umount ( STRING  gameid)

Allows to unmount an app/game with PFS content previously mounted.

Returns
It will return a numeric value 1 if succeded, or a numeric value below 0 in case of error.