Pocket Studio Docs

Packages

A package is a file built for one device, which you install on your own PSP, PS Vita, Nintendo 3DS, iPod touch or Android phone. A game's current packages are free for every account. The versions before them come with the membership. A Pocket Applet you make in the room is no package: it downloads as a .pocket file.

#Download a package

Every place that shows a published game has Download:

  • The game's page, /games/<name>. Its Download part has a tile for each device the game has a package for, with the version and the size.
  • The shelf on the landing page. Download on a game's card opens the same tiles in a dialog.
  • The play page, the game's own address. Download in the dock at its foot opens the same tiles over the game.
  • The room. The game's card lists the devices, with a download for each.

Press the tile for your device.

  • With an account signed in, the file starts downloading and the page stays where it is.
  • Without one, a sign-in card opens over the page. Sign in with an emailed code, with Google or with GitHub, and the download goes on. A guest in the room gets the same card.
  • On the play page the sign-in opens in a small window beside the game, so the game keeps running. Back to the game closes that window. A browser that opens no window follows the link to the game's page.

Reading a game's page and playing its browser version ask for no account. An account downloads a published game's packages when its author allows downloads. A download that stopped can continue where it was. The install guide says how to put the file on each device.

#Past versions

When an author uploads a later version of a package, the Studio keeps the one before it. All versions, under the tiles, lists every version kept for each device: its version, the day it was uploaded and its size.

  • The current version of each device is any account's to download.
  • Past versions come with the membership. For a visitor who is not a member, a past version's row carries a padlock and Become a member opens the plans. A payment started on a game's page returns to that page, which opens the list again.
  • A device's package keeps at most 12 past versions. The oldest goes when one more arrives.

A game whose packages were never replaced has no past version: the list says so and shows the current ones.

#Source code

The Download part and the Remix dialog offer a game's source under Source code, in tiles of the same size as a device's:

  • A game built outside Pocket Studio that names a public repository. On GitHub, Source code downloads a ZIP of the repository and a second tile opens the repository; on GitLab and Codeberg there is the tile that opens it. These files come from the repository's own host and ask for no account. The ZIP holds the repository's files and none of its submodules: a game that keeps PocketJS as a submodule builds from a clone with its submodules, which the remix prompt asks the agent for (Start a remix).
  • A game made in Pocket Studio whose command line sent its source. Source code downloads the archive the Studio holds, a .tgz of the project's files. It asks for an account, as a package does.

A remix starts from this source.

#What each device takes

DeviceThe file
PSPEBOOT.PBP, or a .zip of the PSP/GAME folder
PS Vitaa .vpk, or a .zip
Nintendo 3DSa .3dsx, or a .zip of the .3dsx and its SD card files
iPod touchan .ipa, or a .zip
Android phonean .apk, or a .zip

The install guide says, for each device, what it needs to run software that does not come from its maker's store, and how to put the file on it.

#Homebrew

A package is homebrew: it comes from the game's author. A game marked Verified by Pocket Nexus was published or reviewed by Pocket Nexus; the mark says who stands behind the game, and is not a promise about what a package does on your device. Nothing checks what a package does. You install one on your own device, at your own risk, and only on a device that is yours.

#Upload a package

The author of a game uploads its packages from a terminal, in the project:

pocket-studio package moon.3dsx --target 3ds --version 0.1.0
Uploaded moon.3dsx (4 KB), version 0.1.0 for 3ds.
Any account can download it from the game's page.
  • --target is psp, vita, 3ds, ipod-touch or android. A game offers one package a device: its newest version.
  • The command checks the file's first bytes against the kind its name says, before it sends anything.
  • A package is at most 512 MiB, and counts against the account's 3 GiB.
  • --version is a label of up to 32 letters, digits, dots, underscores, plus signs and hyphens.
  • pocket-studio downloads on allows accounts to download them, and off stops it.

The pocket-studio command uploads packages and does not build them: the author builds each one with the game's own tools.

#Upload another version

--version decides where an upload goes among the versions of a device's package:

The upload's versionWhat the Studio does
The same as the current package's, or either has no versionIt replaces the current package and deletes the replaced file.
Later than the current package'sIt becomes the current package. The one before it is kept as a past version.
Earlier than the current package'sIt joins the past versions. The game's page keeps offering the current one.
The same as a past version'sIt replaces that past version.

Two versions are compared as semantic versions are. The part before the first hyphen is the release: its pieces between dots and underscores compare one by one, two numbers as numbers, so 0.10.0 is later than 0.9.0. A number is earlier than a word, and of two releases that start alike the shorter is the earlier: 1.0 is earlier than 1.0.1. What follows the hyphen marks a build before that release: 1.0.0-rc.1 is earlier than 1.0.0, and 1.0.0-rc.1 is earlier than 1.0.0-rc.2. What follows a plus sign is not compared.

A device keeps 12 past versions. One more pushes the earliest out. An upload that is earlier than all 12 is refused: delete one with pocket-studio versions --remove first.

pocket-studio package moon-0.2.0.3dsx --target 3ds --version 0.2.0
Uploaded moon-0.2.0.3dsx (4 KB), version 0.2.0 for 3ds.
Any account can download it from the game's page.
Kept as past versions, which members download: 0.1.0. List them with pocket-studio versions.

pocket-studio versions lists what the game keeps, and --remove deletes one past version:

pocket-studio versions
pocket-studio versions --remove 0.1.0 --target 3ds
3ds
  0.2.0  4 KB  moon-0.2.0.3dsx  current
  0.1.0  4 KB  moon.3dsx
Any account downloads a current package. Members download the versions before it.

Past versions count against the account's 3 GiB. When an upload does not fit beside them, the Studio deletes the account's past versions one at a time, the earliest uploaded first, across all its games, until the upload fits. A current package is never deleted to make room: an upload that still does not fit is refused.