LBRYCommunity/lbry-format
1
0
Fork 0
Code Issues 1 Pull requests 7 Projects Releases Packages Wiki Activity

Merge pull request #1 from upsided/master

Browse source 
Added a little more detail in the README for the curious who wish to try it out
This commit is contained in:
Shawn K 2019-03-31 23:24:05 -05:00 committed by GitHub
commit 9fd036d494
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -17,6 +17,17 @@ Once installed, run `lbry-format --help`
`lbry-format pack ./sourceDirectory ./outputPackage.lbry`
## What It's For
A lbry-format file is a compressed web site, much like a zip file. More specifically, it's a directory of files individually zipped with Zstandard, then collected into a tar archive.
It is recognized and launched by the LBRY-desktop app to enable rich, interactive media in the client.
When the LBRY desktop app encounters the .lbry extension, and the user presses "play," it decompresses the .lbry file, launches a sandboxed web server in the background, and 'serves up' this file like a real web server might.
This enables a lot of possibilities. To see what is currently possible with this format, check out the LBRY channel [@OpenSourceGames](https://open.lbry.io/@OpenSourceGames#e8fed337dc4ee260f4bcfa6d24ae1e4dd75c2fb3).
There are more restrictions to a .lbry archive than normal websites, because of the security issues and the fact that it's not running on a domain.
## Name
- Name Format: `*.lbry`