AppImage - Revision history

LabRPS at 10:06, 24 August 2022

2022-08-24T10:06:14Z

← Older revision		Revision as of 03:06, 24 August 2022
Line 1:		Line 1:
	{{VeryImportantMessage\|The contents on this page is not applicable.}}		{{VeryImportantMessage\|The contents on this page are not applicable.}}
	{{TOCright}}		{{TOCright}}

LabRPS at 10:05, 24 August 2022

2022-08-24T10:05:36Z

← Older revision		Revision as of 03:05, 24 August 2022
Line 1:		Line 1:
			{{VeryImportantMessage\|The contents on this page is not applicable.}}
	{{TOCright}}		{{TOCright}}


	== What is an AppImage? ==		== What is an AppImage? ==

LabRPS at 19:09, 9 August 2022

2022-08-09T19:09:55Z

← Older revision		Revision as of 12:09, 9 August 2022
Line 1:		Line 1:
	{{VeryImportantMessage\|As of 7 July 2019, the LabRPS community has been observing that downloading AppImages from Github seems to timeout before completion. We aren't sure why this is occurring. If this happens to you please try downloading again. It make take a few tries. A recommended practice is to use the AppImage [https://www.wiki.labrps.com/Appimage#Automatic_updating auto-updating feature], which will restore the download from the place it failed.}}


	{{TOCright}}		{{TOCright}}

LabRPS at 19:08, 9 August 2022

2022-08-09T19:08:40Z

← Older revision		Revision as of 12:08, 9 August 2022
Line 21:		Line 21:

	For other types of installation see [[Download\|Download]].		For other types of installation see [[Download\|Download]].




	== LabRPS AppImages ==		== LabRPS AppImages ==

LabRPS at 19:07, 9 August 2022

2022-08-09T19:07:41Z

← Older revision		Revision as of 12:07, 9 August 2022
Line 33:		Line 33:
	! style="text-align: center; font-size: 200%;" \| Development		! style="text-align: center; font-size: 200%;" \| Development
	\|-		\|-
	\| style="text-align: center;" \| [[Image:AppImage-logo.png\|link=https://github.com/LabRPS/LabRPS-Bundle/releases/tag/0.20]] <!-- [https://github.com/LabRPS/LabRPS/releases/download/0.19.3/LabRPS_0.19.3-Linux-Conda_glibc2.12-x86_64.AppImage 0.19.3] ([https://github.com/LabRPS/LabRPS/releases/download/0.19.3/LabRPS_0.19.3-Linux-Conda_glibc2.12-x86_64.AppImage-SHA256.txt SHA256]) --> [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/0.20 v0.20]		\| style="text-align: center;" \| [[Image:AppImage-logo.png\|link=https://github.com/LabRPS/LabRPS-Bundle/releases/tag/0.001]] <!-- [https://github.com/LabRPS/LabRPS/releases/download/0.000.3/LabRPS_0.000.3-Linux-Conda_glibc2.12-x86_64.AppImage 0.000.3] ([https://github.com/LabRPS/LabRPS/releases/download/0.000.3/LabRPS_0.000.3-Linux-Conda_glibc2.12-x86_64.AppImage-SHA256.txt SHA256]) --> [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/0.001 v0.001]
	\| style="text-align: center;" \| <!-- [[Image:AppImage-logo.png\|link=https://github.com/LabRPS/LabRPS-Bundle/releases/download/weekly-builds/LabRPS_weekly-builds-{{:Template:Development-Version}}-Linux-Conda_glibc2.12-x86_64.AppImage]] [https://github.com/LabRPS/LabRPS-Bundle/releases/download/weekly-builds/LabRPS_weekly-builds-{{:Template:Development-Version}}-Linux-Conda_glibc2.12-x86_64.AppImage {{:Template:Development-Version}}] ([https://github.com/LabRPS/LabRPS-Bundle/releases/download/weekly-builds/LabRPS_weekly-builds-{{:Template:Development-Version}}-Linux-Conda_glibc2.12-x86_64.AppImage-SHA256.txt SHA256]) --> [[Image:AppImage-logo.png\|link=https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds Weekly build]] [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds Weekly build]		\| style="text-align: center;" \| <!-- [[Image:AppImage-logo.png\|link=https://github.com/LabRPS/LabRPS-Bundle/releases/download/weekly-builds/LabRPS_weekly-builds-{{:Template:Development-Version}}-Linux-Conda_glibc2.12-x86_64.AppImage]] [https://github.com/LabRPS/LabRPS-Bundle/releases/download/weekly-builds/LabRPS_weekly-builds-{{:Template:Development-Version}}-Linux-Conda_glibc2.12-x86_64.AppImage {{:Template:Development-Version}}] ([https://github.com/LabRPS/LabRPS-Bundle/releases/download/weekly-builds/LabRPS_weekly-builds-{{:Template:Development-Version}}-Linux-Conda_glibc2.12-x86_64.AppImage-SHA256.txt SHA256]) --> [[Image:AppImage-logo.png\|link=https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds Weekly build]] [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds Weekly build]
	\|}		\|}
Line 57:		Line 57:
	=== Experimental in-app updating ===		=== Experimental in-app updating ===

	Thanks to the efforts of several key devs, there is an [http://labrps.com/boards ongoing effort] to integrate a feature that allows '''self-updating the AppImage within LabRPS''' itself. Starting from FC 0.19.21514 there now exists an AppImage section found via {{MenuCommand\|Edit → Preferences → AppImage}}. Please test this capability and report your experience to the [http://labrps.com/boards forum discussion].		Thanks to the efforts of several key devs, there is an [http://labrps.com/boards ongoing effort] to integrate a feature that allows '''self-updating the AppImage within LabRPS''' itself. Starting from FC 0.000.21514 there now exists an AppImage section found via {{MenuCommand\|Edit → Preferences → AppImage}}. Please test this capability and report your experience to the [http://labrps.com/boards forum discussion].

	=== GUI method 1 (official) ===		=== GUI method 1 (official) ===

LabRPS: Created page with "{{VeryImportantMessage|As of 7 July 2019, the LabRPS community has been observing that downloading AppImages from Github seems to timeout before completion. We aren't sure why this is occurring. If this happens to you please try downloading again. It make take a few tries. A recommended practice is to use the AppImage [https://www.wiki.labrps.com/Appimage#Automatic_updating auto-updating feature], which will restore the download from the place it failed.}} {{TOCright}}..."

2022-08-09T19:01:00Z

Created page with "{{VeryImportantMessage|As of 7 July 2019, the LabRPS community has been observing that downloading AppImages from Github seems to timeout before completion. We aren't sure why this is occurring. If this happens to you please try downloading again. It make take a few tries. A recommended practice is to use the AppImage [https://www.wiki.labrps.com/Appimage#Automatic_updating auto-updating feature], which will restore the download from the place it failed.}} {{TOCright}}..."

New page

{{VeryImportantMessage|As of 7 July 2019, the LabRPS community has been observing that downloading AppImages from Github seems to timeout before completion. We aren't sure why this is occurring. If this happens to you please try downloading again. It make take a few tries. A recommended practice is to use the AppImage [https://www.wiki.labrps.com/Appimage#Automatic_updating auto-updating feature], which will restore the download from the place it failed.}}

{{TOCright}}

== What is an AppImage? ==

[[Image:AppImage-logo.png|link=https://appimage.org]] {{Emphasis|Package once and run everywhere. Reach users on all major Linux desktop distributions.}}

AppImage is a "universal binary package" intended to distribute an application to any Linux distribution. Read more about it on the [https://appimage.org Appimage homepage] and [https://en.wikipedia.org/wiki/AppImage Wikipedia].

To run it, first make it executable, and then type the relative or full path.

{{Code|code=
chmod +x LabRPS_xxx-x86_64.AppImage
./LabRPS_xxx-x86_64.AppImage
}}

For other types of installation see [[Download|Download]].

== LabRPS AppImages ==

{{VeryImportantMessage|'''Note:''' Development builds are now hosted on the [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds '''LabRPS-Bundle'''] github repo.<br/>If the download links below do not work, please manually download the files from the expanded "Assets" section of the above link}}

{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
|+ style="text-align: center; font-size: 150%; | Available LabRPS AppImages
|+
! style="text-align: center; font-size: 200%;" | Stable
! style="text-align: center; font-size: 200%;" | Development
|-
| style="text-align: center;" | [[Image:AppImage-logo.png|link=https://github.com/LabRPS/LabRPS-Bundle/releases/tag/0.20]]  [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/0.20 v0.20]
| style="text-align: center;" |  [[Image:AppImage-logo.png|link=https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds Weekly build]] [https://github.com/LabRPS/LabRPS-Bundle/releases/tag/weekly-builds Weekly build]
|}

'''Important Notes:'''
* Development happens daily and rapidly, the link for the most up-to-date AppImage is a moving target.
* The development link above should be up-to-date because it is updated via a script.
* Many users on the forum utilize the development version.
* It can be run on the same system in parallel with another version of LabRPS.
* Users use the dev version to take advantage of the latest features and bug fixes (since LabRPS has a long release cycle). They also use it to help test and find bugs to spur development and improvement of LabRPS.

==== Obligatory Word of Caution ====

For the most part the development version is stable but of course it's important to add the obligatory statement to use it at your own risk. Though most people that utilize backups and 'save often' do quite well.

== Automatic updating ==

AppImage has a smart and economical way of updating. It calculates the difference between the new AppImage and the old one, and will only download the changes between their versions. In theory the user ends up downloading around 15% each time instead of an entirely new AppImage.

Automatic updating is done via several optional methods. Currently there are 4 methods, 2 through the graphical interface (GUI), and 2 through the command-line/terminal interface (CLI).

=== Experimental in-app updating ===

Thanks to the efforts of several key devs, there is an [http://labrps.com/boards ongoing effort] to integrate a feature that allows '''self-updating the AppImage within LabRPS''' itself. Starting from FC 0.19.21514 there now exists an AppImage section found via {{MenuCommand|Edit → Preferences → AppImage}}. Please test this capability and report your experience to the [http://labrps.com/boards forum discussion].

=== GUI method 1 (official) ===

This is the official AppImageUpdate GUI application.
# Download [https://github.com/AppImage/AppImageUpdate/releases/download/continuous/AppImageUpdate-x86_64.AppImage AppImageUpdate-x86_64.AppImage].
# Make it executable by right clicking on the file, going in to properties and "Run as an executable".
# Double click on the AppImage icon, a dialog box will appear and you'll be prompted to specify what AppImage you want to update.
# Specify the path to your existing AppImage.
# Once the AppImage is updated, press the button {{Button|Run updated AppImage}}.

=== GUI method 2 (unofficial) ===

This is a sleeker 3rd-party unofficial version of AppImageUpdate named: '''AppImageUpdater'''. It is still in development (at the time of this wiki edit) but nevertheless, quite nice to use.
# Download [https://github.com/antony-jr/AppImageUpdater/releases/tag/continuous AppImageUpdater-*-x86_64.AppImage]
# Make it executable: {{Code|code=chmod +x AppImageUpdater*-x86_64.AppImage}}
# Run it: {{Code|code=source AppImageUpdater*-x86_64.AppImage}}
# Find your current LabRPS AppImage and drag-drop it on to the AppImageUpdater
Result: Follow the AppImageUpdater prompts

=== CLI method 1 (official) ===

Run the following instructions in your terminal

{{Code|code=
wget https://github.com/AppImage/AppImageUpdate/releases/download/continuous/appimageupdatetool-x86_64.AppImage
chmod +x ./appimageupdatetool-x86_64.AppImage
./appimageupdatetool.AppImage path/to/old/LabRPS.AppImage
chmod +x path/to/updated/LabRPS.AppImage
./path/to/updated/LabRPS.AppImage
}}

Notes:
* The file names will be unique because of the version info is embedded in them. The above instructions are simplified for convenience.
* Run {{incode|./appimageupdatetool-x86_64.AppImage --help}} to learn about functionality like {{incode|--remove-old}}, {{incode|--overwrite}} and {{incode|--self-update}}.
* There is also an i386 version; see the [https://github.com/AppImage/AppImageUpdate/releases AppImageUpdate release] page.

Todo: share a script that can be added as an alias or cron job.

=== CLI method 2 (unofficial) ===

Similarly to the Graphical methods having an official and unofficial approaches to downloading AppImages, the same applies to the command line.
This is a sleeker 3rd-party command line option to download AppImages

# Download [https://github.com/antony-jr/AppImageUpdater/releases/tag/continuous-cli appimageupdater-*-x86_64.AppImage]
# Make it executable: {{Code|code=chmod +x appimageupdater*-x86_64.AppImage}}
# Run it: {{Code|code=source appimageupdater*-x86_64.AppImage /path/to/old/LabRPS-AppImage.AppImage}}
'''Result''': Updates specified AppImage file if update exists

= Experimental =

== Fixing AppImage zsync ==

It may happen that an AppImage won't update because it's target file changed in some way. Instead of downloading a whole new appimage, it's possible to rewrite the zsync file that is used by the AppImage to download the delta. More info can be found at https://github.com/antony-jr/appimage-update-info-writer.

This section needs more details.

== Downloading via Bittorrent ==

An experimental feature that the LabRPS packaging team is exploring (thanks to the work of Antony-jr) is being able to download an appimage delta of LabRPS via bittorrent. The repository issue is at https://github.com/LabRPS/LabRPS-Bundle/issues/49

= Developer Section =

{{Emphasis|Note:}} the following sections are intended for developers

== Unpacking AppImages ==

A very convenient aspect of LabRPS is that a majority of it is built in [[Python|Python]], which doesn't need to be manually compiled like C++. Essentially, a Python file can be modified, and upon restarting LabRPS those changes will be integrated into the application. A developer can quickly work on the latest LabRPS release using this technique and an AppImage. Moreover, using an AppImage doesn't modify your system's environment in any way, that is, nothing is installed and no environmental variables are modified.

=== Modifying AppImages ===

An AppImage embeds a file system in it with everything that is required to run the application. In order to modify it, the file system needs to be extracted.

{{Code|code=
./LabRPS_xxx.AppImage --appimage-extract
cd squashfs-root/
}}

Now open the required Python source files in your preferred code editor, modify them, and save them. Then run the application.

{{Code|code=
./AppRun
}}

=== Repackaging AppImages ===

If you've modified the code, and now want to re-package the AppImage with your latest changes, use the [https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage appimagetool-x86_64] tool on the extracted file system.

{{Code|code=
cd ..
wget "https://github.com/AppImage/AppImageKit/releases/download/continuous/appimagetool-x86_64.AppImage"
chmod +x appimagetool-x86_64.AppImage
./appimagetool-x86_64.AppImage squashfs-root
}}

== Personalized AppImages ==

Thanks to the work of {{Emphasis|realthunder}}, author of [[App_Link|App Link]] and [[Assembly3_Workbench|Assembly3 Workbench]], it is possible to build custom AppImages using a set of scripts.

This makes it very convenient to release images for a specific branch of the source code for others to test. Although AppImages only work on Linux, realthunder's scripts make it possible to generate AppImages also on Windows and MacOS.

The repository for these scripts is at [https://github.com/realthunder/LabRPSMakeImage realthunder/LabRPSMakeImage]. Please read the [https://github.com/realthunder/LabRPSMakeImage/blob/master/Readme.md Readme.md] for more details.

== Related ==

* [[Ubuntu_Snap|Snap]] packages.
* [[Flatpak|Flatpak]] packages.

[[Category:Packaging]]
[[Category:Developer Documentation]]
[[Category:Testing]]
{{Userdocnavi}}