Skip to content

Latest commit

 

History

History
208 lines (154 loc) · 6.69 KB

DOCS.md

File metadata and controls

208 lines (154 loc) · 6.69 KB
Raw

Modules

game
release

Classes

Game

Represents an installed game

GameWiki ⇐ Game

Represents an installed game and its Cemu wiki entry

Release

Represents a Cemu release

ReleaseInstall ⇐ Release

Represents an installed Cemu release

game

game.addWiki(game) ⇒ GameWiki

Convert a Game into a GameWiki

Kind: static method of game

Param Type Description
game Game Game to convert

game.code2id(code, publisherCode) ⇒ string

Convert a code and a publisher code into a game ID

Kind: static method of game

Param Type Description
code string Game code
publisherCode string Game publisher code

game.create(name, path, id, code, publisherCode, publisher, [version], [dlcVersion], [playTime], [lastPlayed]) ⇒ Game

Create a Game

Kind: static method of game

Param Type Default
name string
path string
id string
code string
publisherCode string
publisher string
[version] int 0
[dlcVersion] int 0
[playTime] int 0
[lastPlayed] int 0

release

release.create(version) ⇒ Release

Create a Release

Kind: static method of release

Param Type
version string

release.download(release, path, [callback]) ⇒ Promise

Download a Cemu release (zip) to a given path

Kind: static method of release

Param Type Description
release Release Release to download
path string Download path
[callback] function Callback, receives an error object if an error occurs

release.install(release, dir, [callback]) ⇒ Promise.<ReleaseInstall>

Download and install a Cemu release

Kind: static method of release

Param Type Description
release Release Release to install
dir string Install directory
[callback] function Callback, receives a ReleaseInstall (or null) and error object if an error occurs

Game

Represents an installed game

Kind: global class
Properties

Name Type Description
name string Name of the game
path string Path to the game directory
id string Game ID
code string Game code
publisherCode string Publisher code
publisher string Publisher of the game
version int Version of the game
dlcVersion int Version of the DLC
playTime int Seconds spent in game
lastPlayed Date Last time the game was played

GameWiki ⇐ Game

Represents an installed game and its Cemu wiki entry

Kind: global class
Extends: Game
Properties

Name Type Description
wiki object Cemu wiki information
wiki.pageid int Cemu wiki information
wiki.title string Cemu wiki page id
wiki.ids array Game title
wiki.developer string List of game IDs
wiki.publisher string Game developer
wiki.series string Game publisher
wiki.released object Series the game is part of
wiki.genre array Release dates of the game
wiki.modes array Genres of the game
wiki.input array Play modes of the game
wiki.rating string Input devices accepted by the game

gameWiki.parse([callback]) ⇒ Promise

Parse game information from the wiki

Kind: instance method of GameWiki

Param Type Description
[callback] function Callback, receives an error object if an error occurs

Release

Represents a Cemu release

Kind: global class
Properties

Name Type Description
version string Version
download url Download link
changelog url Changelog link

ReleaseInstall ⇐ Release

Represents an installed Cemu release

Kind: global class
Extends: Release
Properties

Name Type Description
path string Installation folder path
games array Installed games