Difference between revisions of "RAPPS"

From ReactOS Wiki
Jump to: navigation, search
m
m (File Schema)
 
(14 intermediate revisions by 7 users not shown)
Line 1: Line 1:
'''RAPPS''', previously known as '''Download!''', is a small GUI program that allows users to download multiple programs without hassle.
+
'''RAPPS''', previously known as '''Download!''', is a small program that allows users to download multiple programs without hassle.
  
It has it's own application list that can be expanded by the user and the community. Applications that are included in the list by default are tested and most likely work on ReactOS.
+
It has its own application list that can be expanded by the user and the community. Applications that are included in the list by default are tested and most likely work on ReactOS.
  
 
= How It Works =
 
= How It Works =
When you first start RAPPS, it will automatically connect to the internet, and it will seek for the file "rappmgr.cab". Then, it will extract the contents of this archive file to the same location where main RAPPS executable is, creating a folder called "rapps".
+
When you first start RAPPS, it will automatically connect to the internet, and it will seek for the file "rappmgr.cab". Then, it will extract the contents of this archive file to the same location where the main RAPPS executable is, creating a folder called "rapps".
 
The contents of the archive are just '''UTF-8''' .txt files.
 
The contents of the archive are just '''UTF-8''' .txt files.
  
Line 14: Line 14:
 
RAPPS also has experimental support for icons for application list. See [[#Experimental Features|Experimental Features]] for details.
 
RAPPS also has experimental support for icons for application list. See [[#Experimental Features|Experimental Features]] for details.
  
= Submitting new applications =
+
= Submitting New Applications =
Some people may complain why his/her favourite application is not in the RAPPS list.
+
Some people may complain that his/her favourite application is not in the RAPPS list.
 
The description files can be created by anyone. (See [[#File Schema|File Schema]] for a detailed breakdown).
 
The description files can be created by anyone. (See [[#File Schema|File Schema]] for a detailed breakdown).
  
 
''Description files need to be saved in UTF-8 format, or some specific languages will be displayed strangely.''
 
''Description files need to be saved in UTF-8 format, or some specific languages will be displayed strangely.''
  
After a description file is created, it has to be submitted to [https://jira.reactos.org JIRA].
+
You can fork the https://github.com/reactos/rapps-db repository and send your submission as a [[Commiting Changes|Pull-Request]].
* For the category, choose 'Core ReactOS'
 
* Name it something along the lines of: 'Add xxx to rapps'.
 
* To make the inclusion process faster, include some screenshots of your application running on ReactOS.
 
 
 
'''NEW! :''' You can now clone the https://github.com/reactos/rapps-db repository and send your submission as a [[Commiting Changes|Pull-Request]].
 
  
 
= File Schema =
 
= File Schema =
Here is a description file that corresponds to the DosBox program:
+
Here is an example description file.
 
<syntaxhighlight lang="ini">
 
<syntaxhighlight lang="ini">
 
  [Section]
 
  [Section]
  Name = DOSBox
+
  Name = My fun stuff-o-matic
  Version = 0.74-2
+
RegName = Name in Registry
 +
  Version = 1.1.1
 
  License = GPL
 
  License = GPL
  Description = An open-source DOS emulator.
+
  Description = Shortish description giving some additional background information about what it does.
  Size = 1.4 MiB
+
  SizeBytes = 10485760
  Category = 15
+
  Category = 5
  URLSite = http://www.dosbox.com/
+
  URLSite = https://example.org/
  URLDownload = http://download.sourceforge.net/project/dosbox/dosbox/0.74-2/DOSBox0.74-2-win32-installer.exe
+
  URLDownload = https://ftp.example.org/pub/installer.exe
  SHA1 = 06f23be4ceba35c8c547a98f1b327da20082b483
+
  Screenshot1 = Screenshot URL
CDPath = none
+
  Icon = Icon filename in icons folder (with .ico extension)
  SizeBytes = 1453151
+
     
 
+
  [Section.0419] ; 0419 - for Russian language
[Section.0407]
+
  Description = Description in Russian language
Description = DOSBox ist ein DOS Emulator.
 
 
 
  [Section.040a]
 
  Description = DOSBox es un emulador de DOS.
 
 
 
[Section.040c]
 
Description = DOSBox est un émulateur DOS.
 
 
 
[Section.0415]
 
Description = DOSBox – emulator DOSa.
 
 
 
[Section.0422]
 
Description = DOSBox - емулятор DOSу.
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 
Let's analyze it from top to the bottom.
 
Let's analyze it from top to the bottom.
 +
 
== [Section] ==
 
== [Section] ==
This is the beggining of the area that is read when user click on the name of the program that he chooses to download. It consist's of several things:
+
This is the beginning of the area that is read when the user clicks on the name of the program that he chooses to download. It consists of several things:
 +
 
 
=== Name ===
 
=== Name ===
This is the program name that is displayed in the list, and in the lower grey description field.
+
This is the program name that is displayed.
 +
 
 
=== Version ===
 
=== Version ===
This is the version of the program, also displayed in the list and in the lower field.
+
This is the version of the program.
 +
 
 
=== License ===
 
=== License ===
The license that the program is based on. Typical options are : Trial, Demo, Freeware, Open-Source.
+
The license that the program is based on. Typical options are : Trial, Demo, Freeware, Open-Source. Or more specifically, GPL, MIT and so on.
 +
 
 
=== Description ===
 
=== Description ===
The description of the program For example : "A program that emulates older hardware to run older games".
+
The description of the program giving some additional background information about what it does..
 +
 
 
=== Size ===
 
=== Size ===
'''DEPRECATED:''' The value should be kept for backward compatibility.
+
Size of the program. Template: NUMBERUNIT For example "10 MB".
  
Size of the program. Template: NUMBERUNIT For example "223 MB".
 
 
=== SizeBytes ===
 
=== SizeBytes ===
Actual size of the download in bytes. Used to display size value in the application info as well as while downloading.
+
The actual size of the download in bytes. Used to display size value in the application info as well as while downloading.
 +
 
 
=== Category ===
 
=== Category ===
The category of the program. Category name correspond to the number. There are 15 categories for now:
+
The category of the program. Category name corresponds to the number. There are 15 categories for now:
 
*1 – Sound – Software for recording, playing, modify, convert sound
 
*1 – Sound – Software for recording, playing, modify, convert sound
 
*2 – Video – As above but applies to video and movies
 
*2 – Video – As above but applies to video and movies
Line 82: Line 71:
 
*4 – Games and Entertainment – There are games, emulators for games
 
*4 – Games and Entertainment – There are games, emulators for games
 
*5 – Internet and Networks – Browsers, IM clients, FTP software, Remote desktop...
 
*5 – Internet and Networks – Browsers, IM clients, FTP software, Remote desktop...
*6 – Office stuff – Software that is used in the Office for example Open Office
+
*6 – Office stuff – Software that is used in the Office, for example, Open Office
*7 – Developement / programming – programs used for compiling, and source writing for example Dev C++
+
*7 – Development/programming – programs used for compiling, and source writing, for example, Dev C++
 
*8 – Education – Programs that help in teaching, learning. For example dictionaries, translators
 
*8 – Education – Programs that help in teaching, learning. For example dictionaries, translators
*9 – Engineering – Programs simmilar to CAD, SolidWorks (tm)
+
*9 – Engineering – Programs similar to CAD, SolidWorks (TM)
 
*10 – Financial – Programs for financial stuff, TRade monitors, database systems for warehouses e.t.c
 
*10 – Financial – Programs for financial stuff, TRade monitors, database systems for warehouses e.t.c
*11 – Science – For programs that makes simulations, helps in the Chemistry, Physics....
+
*11 – Science – For programs that make simulations, helps in the Chemistry, Physics...
*12 – Tools – Utilities for users for example archiving software
+
*12 – Tools – Utilities for users, for example, archiving software
 
*13 – Drivers – Files for the devices that are installed in the system
 
*13 – Drivers – Files for the devices that are installed in the system
 
*14 – Libraries – Files that are needed to run some programs like Visual Basic and .NET
 
*14 – Libraries – Files that are needed to run some programs like Visual Basic and .NET
*15 – Other – programs that did not fit in above categories
+
*15 – Themes - Themes for ReactOS or Windows (for example: watercolor, classic, luna, etc)
 +
*16 – Other – programs that did not fit in above categories
  
 
=== URLSite ===
 
=== URLSite ===
Line 99: Line 89:
 
Direct link to the installer/program.
 
Direct link to the installer/program.
  
=== CDPath ===
+
=== ScreenshotN ===
Field that contains a path to go to after downloading. Currently unused. (CDPath = none)
+
Screenshot URL link. (N = 1, 2, 3 ...) Currently, only first Screenshot is used.
  
== [Section.0407] ==
+
=== Icon ===
Specific language of the description, based on the host system language settings.  
+
Icon filename in icons folder (with .ico extension)
  
When host language is different that languages in the file, English is choosen by default (If you talk Spanish, and there is no such entry avaliable in the file, software description will be displayed in English).
+
== [Section.0419] ==
 +
The specific language of the description, based on the host system language settings.
 +
 
 +
When host language is different than languages in the file, English is chosen by default (If you talk Spanish, and there is no such entry available in the file, software description will be displayed in English).
  
 
Locale IDs (that number in Section.xxxx) can be found [http://msdn.microsoft.com/en-us/goglobal/bb964664 here] (numbers from the left column).
 
Locale IDs (that number in Section.xxxx) can be found [http://msdn.microsoft.com/en-us/goglobal/bb964664 here] (numbers from the left column).
Line 112: Line 105:
  
 
= Experimental Features =
 
= Experimental Features =
RAPPS has some experimental features that are not refined enough and/or not used yet. They are still a subject to change, therefore are not yet adopted in the main database.
+
RAPPS has some experimental features that are not refined enough and/or not used yet. They are still subject to change, therefore are not yet adopted in the main database.
  
 
However, these features are present in the codebase and work well enough to be tested and used.
 
However, these features are present in the codebase and work well enough to be tested and used.
  
 
== Command Line Support ==
 
== Command Line Support ==
Apart from graphical interface, RAPPS features a command-line options that can be used to install apps.
+
Apart from the graphical interface, RAPPS features command-line options that can be used to install apps.
They would install exactly as if selected in the app itself.
+
They will install exactly as if selected in the app itself.
  
There are two keys now:
+
Current available options are listed below:
 +
*<code>/?</code> - display the usage of RAPPS commandline
 
*<code>/INSTALL</code> - accepts multiple apps as values and installs them if they are available.
 
*<code>/INSTALL</code> - accepts multiple apps as values and installs them if they are available.
Example: <code>rapps /INSTALL 7-Zip AkelPad</code>
+
Example: <code>rapps /INSTALL 7zip akelpad</code>
 
*<code>/SETUP</code> - accepts a full path to the .inf file, where in <code>[RAPPS]</code> block you can specify which apps to install using one Install= key per single app.
 
*<code>/SETUP</code> - accepts a full path to the .inf file, where in <code>[RAPPS]</code> block you can specify which apps to install using one Install= key per single app.
 
 
Example:
 
Example:
 
<syntaxhighlight lang="ini">
 
<syntaxhighlight lang="ini">
Line 132: Line 125:
  
 
[RAPPS]
 
[RAPPS]
Install=7-Zip
+
Install=7zip
Install=AkelPad
+
Install=akelpad
 
</syntaxhighlight >
 
</syntaxhighlight >
 
<code>[Version]</code> section is a nessesary header for .INF files. <code>[RAPPS]</code> is a section where you specify the needed apps.
 
<code>[Version]</code> section is a nessesary header for .INF files. <code>[RAPPS]</code> is a section where you specify the needed apps.
 
Apps should be added in .INF one-by-one, as can be seen in the example.  
 
Apps should be added in .INF one-by-one, as can be seen in the example.  
  
Names used are same as in the <code>Name</code> field in the database textfiles.
+
Names used are same as the filename in database textfiles.
  
== Icon Support ==
+
*<code>/FIND</code> - accepts multiple strings and find all corresponding apps contains the strings in the name or description.
RAPPS supports 'per app' icons, that can be loaded from <code>AppData/rapps/rapps/icons</code> folder (that's where the database entries are).
+
Example: <code>rapps /FIND Firefox "Python 3"</code>
 +
*<code>/INFO</code> - accepts multiple package-name and display apps information correspond with the package-name.
 +
Example: <code>rapps /INFO rosbe codeblocks</code>
 +
== Icon and Screenshot Support ==
 +
RAPPS supports 'per app' icons, that will be shown instead of the generic 'application' icon.
 +
The icon can be specified with the field name 'Icon', which should be placed in the main 'Section'.
 +
The icon itself should be placed in the `icons` folder.
  
The filename should match the <code>Name</code> field in the database plus the extension. Only icons of the .ICO format are supported.
+
There is also support for a screenshot, which should be uploaded to an image host.
 +
This screenshot can be specified with the field 'Screenshot1'.
 +
 
 +
<syntaxhighlight lang="ini">
 +
[Section]
 +
Name = Code::Blocks (without compiler)
 +
URLDownload = https://download.sourceforge.net/project/codeblocks/Binaries/17.12/Windows/codeblocks-17.12-setup.exe
 +
SHA1 = 05ad095b5e04de243df736c060aea25a554dad94
 +
SizeBytes = 37372176
 +
Icon=codeblocks.ico
 +
Screenshot1=https://i.imgur.com/FykFrzz.png
 +
</syntaxhighlight>
  
 
== New [Section] Fields ==
 
== New [Section] Fields ==
Line 151: Line 161:
 
This field is used to inform the user whether the app is available in their language.
 
This field is used to inform the user whether the app is available in their language.
  
You should place all the language codes app supports separated by <code>|</code> there. Multiline parameters are also supported.  
+
You should place all the language codes app supports separated by <code>|</code> there.
  
 
Example:
 
Example:
 
<syntaxhighlight lang="ini">
 
<syntaxhighlight lang="ini">
Languages=0C09|0813|0422 \\English|Dutch|Ukrainian
+
Languages=0C09|0813|0422
 
</syntaxhighlight>
 
</syntaxhighlight>
  
Line 164: Line 174:
 
*1 - "Open Source"
 
*1 - "Open Source"
 
*2 - "Freeware"  
 
*2 - "Freeware"  
*3 - "Demo/Trial".  
+
*3 - "Demo/Trial".
  
 
= See Also =
 
= See Also =

Latest revision as of 16:20, 3 October 2020

RAPPS, previously known as Download!, is a small program that allows users to download multiple programs without hassle.

It has its own application list that can be expanded by the user and the community. Applications that are included in the list by default are tested and most likely work on ReactOS.

How It Works

When you first start RAPPS, it will automatically connect to the internet, and it will seek for the file "rappmgr.cab". Then, it will extract the contents of this archive file to the same location where the main RAPPS executable is, creating a folder called "rapps". The contents of the archive are just UTF-8 .txt files.

Every single file that is on download list in RAPPS, has it's own "description" file.

Custom files must be placed in /rapps folder created after .CAB file download. TXT file names should correspond to the software they are relative to.

RAPPS also has experimental support for icons for application list. See Experimental Features for details.

Submitting New Applications

Some people may complain that his/her favourite application is not in the RAPPS list. The description files can be created by anyone. (See File Schema for a detailed breakdown).

Description files need to be saved in UTF-8 format, or some specific languages will be displayed strangely.

You can fork the https://github.com/reactos/rapps-db repository and send your submission as a Pull-Request.

File Schema

Here is an example description file.

 [Section]
 Name = My fun stuff-o-matic
 RegName = Name in Registry
 Version = 1.1.1
 License = GPL
 Description = Shortish description giving some additional background information about what it does.
 SizeBytes = 10485760
 Category = 5
 URLSite = https://example.org/
 URLDownload = https://ftp.example.org/pub/installer.exe
 Screenshot1 = Screenshot URL
 Icon = Icon filename in icons folder (with .ico extension)
      
 [Section.0419] ; 0419 - for Russian language
 Description = Description in Russian language

Let's analyze it from top to the bottom.

[Section]

This is the beginning of the area that is read when the user clicks on the name of the program that he chooses to download. It consists of several things:

Name

This is the program name that is displayed.

Version

This is the version of the program.

License

The license that the program is based on. Typical options are : Trial, Demo, Freeware, Open-Source. Or more specifically, GPL, MIT and so on.

Description

The description of the program giving some additional background information about what it does..

Size

Size of the program. Template: NUMBERUNIT For example "10 MB".

SizeBytes

The actual size of the download in bytes. Used to display size value in the application info as well as while downloading.

Category

The category of the program. Category name corresponds to the number. There are 15 categories for now:

  • 1 – Sound – Software for recording, playing, modify, convert sound
  • 2 – Video – As above but applies to video and movies
  • 3 – Graphics – As above, but graphics and images
  • 4 – Games and Entertainment – There are games, emulators for games
  • 5 – Internet and Networks – Browsers, IM clients, FTP software, Remote desktop...
  • 6 – Office stuff – Software that is used in the Office, for example, Open Office
  • 7 – Development/programming – programs used for compiling, and source writing, for example, Dev C++
  • 8 – Education – Programs that help in teaching, learning. For example dictionaries, translators
  • 9 – Engineering – Programs similar to CAD, SolidWorks (TM)
  • 10 – Financial – Programs for financial stuff, TRade monitors, database systems for warehouses e.t.c
  • 11 – Science – For programs that make simulations, helps in the Chemistry, Physics...
  • 12 – Tools – Utilities for users, for example, archiving software
  • 13 – Drivers – Files for the devices that are installed in the system
  • 14 – Libraries – Files that are needed to run some programs like Visual Basic and .NET
  • 15 – Themes - Themes for ReactOS or Windows (for example: watercolor, classic, luna, etc)
  • 16 – Other – programs that did not fit in above categories

URLSite

Main web site where the program can be found.

URLDownload

Direct link to the installer/program.

ScreenshotN

Screenshot URL link. (N = 1, 2, 3 ...) Currently, only first Screenshot is used.

Icon

Icon filename in icons folder (with .ico extension)

[Section.0419]

The specific language of the description, based on the host system language settings.

When host language is different than languages in the file, English is chosen by default (If you talk Spanish, and there is no such entry available in the file, software description will be displayed in English).

Locale IDs (that number in Section.xxxx) can be found here (numbers from the left column).

Thanks to the author, wojo664

Experimental Features

RAPPS has some experimental features that are not refined enough and/or not used yet. They are still subject to change, therefore are not yet adopted in the main database.

However, these features are present in the codebase and work well enough to be tested and used.

Command Line Support

Apart from the graphical interface, RAPPS features command-line options that can be used to install apps. They will install exactly as if selected in the app itself.

Current available options are listed below:

  • /? - display the usage of RAPPS commandline
  • /INSTALL - accepts multiple apps as values and installs them if they are available.

Example: rapps /INSTALL 7zip akelpad

  • /SETUP - accepts a full path to the .inf file, where in [RAPPS] block you can specify which apps to install using one Install= key per single app.

Example:

[Version]
Signature = $Windows NT$
ClassGUID = {00000000-0000-0000-0000-000000000000}

[RAPPS]
Install=7zip
Install=akelpad

[Version] section is a nessesary header for .INF files. [RAPPS] is a section where you specify the needed apps. Apps should be added in .INF one-by-one, as can be seen in the example.

Names used are same as the filename in database textfiles.

  • /FIND - accepts multiple strings and find all corresponding apps contains the strings in the name or description.

Example: rapps /FIND Firefox "Python 3"

  • /INFO - accepts multiple package-name and display apps information correspond with the package-name.

Example: rapps /INFO rosbe codeblocks

Icon and Screenshot Support

RAPPS supports 'per app' icons, that will be shown instead of the generic 'application' icon. The icon can be specified with the field name 'Icon', which should be placed in the main 'Section'. The icon itself should be placed in the `icons` folder.

There is also support for a screenshot, which should be uploaded to an image host. This screenshot can be specified with the field 'Screenshot1'.

 [Section]
 Name = Code::Blocks (without compiler)
 URLDownload = https://download.sourceforge.net/project/codeblocks/Binaries/17.12/Windows/codeblocks-17.12-setup.exe
 SHA1 = 05ad095b5e04de243df736c060aea25a554dad94
 SizeBytes = 37372176
 Icon=codeblocks.ico
 Screenshot1=https://i.imgur.com/FykFrzz.png

New [Section] Fields

There are two experimental fields in the database files - Languages and LicenseInfo.

Languages

This field is used to inform the user whether the app is available in their language.

You should place all the language codes app supports separated by | there.

Example:

Languages=0C09|0813|0422

LicenseInfo

This is a field in the DB which, when present, changes the way License field in the info is shown.

Application license types correspond to a number:

  • 1 - "Open Source"
  • 2 - "Freeware"
  • 3 - "Demo/Trial".

See Also

References