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...
 
NIL game.launch (STRING ID)
 Executes a content Homebrew/Game for his 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 complete gamelist of all the games installed on ux0 and ur0 of the PSVita. More...
 
NUMBER game.move (STRING gameid, NUMBER toggle)
 Allows to move a game or an app from ux0 to ur0 or the other way around on the system. 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 id)
 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...
 

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.
NIL game.launch ( STRING  ID)

Executes a content Homebrew/Game for his ID.

Parameters
IDContent identifier, such as "PCSG00524".
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 complete gamelist of all the games installed on ux0 and ur0 of the PSVita.

Parameters
type(OPTIONAL) When you add this value, a complete gamelist could be created or only a gamelist from ux0:pspemu/PSP/GAME
  • __ALL (1) Gets the complete gamelist from the console.
  • __PSPEMU (2) Gets the gamelist of installed games on ux0:pspemu/PSP/GAME
Returns
A table with these fields:
  • id: Is the GAMEID of installed game (STRING).
  • path: Complete path of installed game (STRING).
NUMBER game.move ( STRING  gameid,
NUMBER  toggle 
)

Allows to move a game or an app from ux0 to ur0 or the other way around on the system.

Parameters
gameidIs the GAMEID of the game we are trying to move.
toggle(OPTIONAL) Is the numeric value to indicate where the game or app is going to be moved.
  • (1) Allows to move from ux0 to ur0.
  • (2) Allows to move from ur0 to ux0.
Note
  • If the toggle value is skiped the game or app will be moved from ux0 to ur0 by default.
  • 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  id 
)

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

Parameters
pathIt is the path to 'changeinfo.xml'.
idIt 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 "---"