• Alex

How to set up your own Warehouse for your GameShell

Updated: Jun 1

The warehouse is unlocked. The owner left the door open for you. The machine you're looking for is inside.

-- Pinball,1973 by Haruki Murakami





Hi GameShellers!

Recently, we’ve opened our Warehouse for you guys.

Warehouse is for browsing and downloading games.

Example reference https://github.com/clockworkpi/warehouse 13

Currently, Launcher’s Warehouse only supports a separate repository on github.com 2 as a warehouse.


The top-level directory of the Warehouse contains an index.json as the only index of the game category directory list in the warehouse

Each game category directory contains an index.json and all game directories, index.json is the main index of all game directories

2019 GAME JAM is a game category directory, there are 11 game directories under this directory


drwxrwxr-x 4 cpi cpi 4096 Dec 28 18:11 'AGENT OF SHINIGAMI' drwxrwxr-x 4 cpi cpi 4096 Dec 28 18:11 'Ancient Abyss' drwxrwxr-x 4 cpi cpi 4096 Dec 28 22:43 DCDOR drwxrwxr-x 4 cpi cpi 4096 Dec 28 18:11 'Diner Mafia' drwxrwxr-x 4 cpi cpi 4096 Dec 28 18:11 du-pk -rw-rw-r-- 1 cpi cpi 3417 Dec 29 15:05 index.json drwxrwxr-x 4 cpi cpi 4096 Dec 28 18:11 'Infected System' drwxrwxr-x 4 cpi cpi 4096 Dec 28 22:42 Omamori drwxrwxr-x 4 cpi cpi 4096 Dec 28 22:43 'Road Invaders' drwxrwxr-x 4 cpi cpi 4096 Dec 28 18:11 ShiftQuest drwxrwxr-x 4 cpi cpi 4096 Dec 28 22:43 SpaceShifter drwxrwxr-x 4 cpi cpi 4096 Dec 28 22:44 'Two Dimensions'



Warehouse game category

Each game directory has a simple rule to distinguish three warehouse game types[launcher,pico8,tic80]

fileshots.game

The launcher type is a folder storage method for launching games currently supported by launcher.

In simple terms

Folder / Folder.sh # .sh file of the same name, containing the command to start the game, must have executable rights (chmod + x)

Folder / Folder.png # .png file of the same name, used as the icon displayed in the launcher, the size is 80x80, optional or not

Place other files at will


Launcher

The launcher type uses AGENT OF SHINIGAMI as an example:

The file folder contains a compressed package of the launcher game folder. The compressed package currently only supports the .tar.gz format and requires the same name as the directory, such as AGENT OF SHINIGAMI.tar.gzThe shots folder contains a screenshot for previewing the game, the size is GameShell’s resolution, and the file name is arbitrary.game plain text file, the file name is dot + game, linux hidden file, its content is the type string of this game directory, currently only launcher, pico8, tic80, the three can only write one

The launcher game is installed under ~/aria2download/, with github user name and library name as the directory name, such as ~/aria2download/clockworkpi/warehouse/master/2019%20GAME%20JAM/


Pico-8

Pico-8 type Take du-pk as an example:

The file folder contains a card for a pico8 game, must be a png, and the file name ends with .p8.pngThe shots folder contains a screenshot for previewing the game, the size is GameShell’s resolution, and the file name is arbitrary.game plain text file, the file name is dot + game, linux hidden file, its content is the type string of this game directory, currently only launcher, pico8, tic80, the three can only write one

After the pico8 game is installed, it will appear in pico8. The installation path is /home/cpi/.lexaloffle/pico-8/carts


Tic80

The Tic80 type is very similar to Pico-8, except that the file folder contains a card for a Tic80 game, with the file name ending in .tic

Everything else is as same as Pico-8

The Tic80 game installation path is /home/cpi/games/TIC-80/

Add to Launcher’s Warehouse

After all the remote github.com 2 game library is generated, please go to launcher-> Warehouse

+ Add new warehouse

Enter warehouse URL

Take https://github.com/clockworkpi/warehouse 13 as an example

The input result is github.com/clockworkpi/warehouse , there is no need for http (s):// at the beginning, and .git at the end, which is simply github.com 2 + github.com 2 username + repository name.



If you have any further question, please feel free to feedback here. LOVE & PEACE !

1,652 views
os.png
  • Grey Facebook Icon
  • Grey Twitter Icon
  • Grey Instagram Icon

Follow  ClockworkPi

Privacy      Terms

Clockwork Tech LLC