rInstallFriendly

A simple and easy-to-use installer packages creator.

What can I do with rInstallFriendly?

You can create fancy software installers for your game/product with just a few clicks.

Generated installer is simple, only 3 steps/screens, but it supports most of the options of any installer creator.

Additionally, it supports custom animated banners with audio and custom interactive shaders, allowing to create unique installation experiences.

Features

• No external dependencies/runtimes (single-executable)
• Support compressed packages as input files: .zip
• Installer project saving and loading from .rif text file
• Installer mode simulator from package editor to verify process
• Custom banner with support for animation, shaders and audio
• User inputs and additional uniforms on banner shader
• Branding inclusion: Banner, Icon, URL links
• Custom EULA/README/LICENSE support
• Custom and pre-defined installation path
• Password-protected installation
• Installation rollback on Cancel while installing
• Installation messages customization, Unicode support
• Command-line support for installer generation using .rif file
• Package installation in silent mode (command-line)
• Sponsoring URL support for FOSS tools promotion
• Multiple UI Style, support of custom styles (rGuiStyler)
• Completely portable (single-file, no-dependencies)

Usage

Open the tool, drag and drop the .zip package and fill the required package information.

• Product Banner: Drag&drop a banner for the product, multiple options supported:
  • Image: To be displayed during installation (464x200 pixels). Supported formats: .png, .qoi, .gif
  • Audio: To be played during installation. Supported formats: .mp3, .qoa, .xm, .mod
  • Shader: Executed over banner image. It must be GLSL330. Supported extensions: .fs, .frag, .glsl

NOTE: On shader loading, some custom uniforms are queried to allow user interactivity.

• Input file (mandatory): The package to be installed (.zip file), decompressed into Install Path.
• Product Info: basic information about the product to be installed, some info could be displayed on intallation process.
  • Name, Version, Description: Product name, current version and description
  • Icon: Product icon, draw&drop or press Load Icon button, supported formats: .ico, .png, .qoi
  • Company and Corp. URL: Company name and corporate URL link
    • [x] Window title: Displays company name on the window title when installing
    • [x] Banner Link: Allows mouse-click on banner to open provided URL on default browser
  • License: Product LICENSE/EULA document, drag&drop or press Select License, supported formats: .txt, .md, .info
    • [x] License Agreement Required: Requires user to click license checkbox before continuing with the installation
• Install Path: Default installation path, it could be configurable by user on installation or not.
• Installer Options: Additional options for the installation process.
  • [x] Sponsoring URL: URL asking for product support (sponsoring/donations), visible during installation process.
  • [x] Password Protected: Installation process requires a password/key.
  • [x] Desktop Shortcut: A desktop shortcut to selected package file is created at the end of installation. Windows only

Simulator mode

Play button on the main toolbar runs the installer simulation mode. In this mode, the installation process can be tested from begin to end but nothing is actually being installed, package files are only validated.

To generate the output pacakage: Export project LCTRL+E

Keyboard/Mouse Shortcuts

• F1 - Show Help window
• F2 - Show About window
• F3 - Show Sponsor window

File Options

• LCTRL + N - New installer project
• LCTRL + O - Load installer image/board
• LCTRL + S - Save installer image/board
• LCTRL + E - Generate installer package

Editor Options

• LCTRL + SPACE - Installer simulator

Command-line interface

rInstallFriendly comes with two possible command-lines, one for the Editor mode and one for the Installer mode. For usage help:

rinstallfriendly.exe --help

Technologies

This tool has been created using the following open-source technologies:

• raylib - A simple and easy-to-use library to enjoy videogames programming
• raygui - A simple and easy-to-use immediate-mode-gui library
• tinyfiledialogs - File dialogs for desktop platforms
• monocypher - Encryption and hashing algorithms
• miniz - Lossless, high performance data compression library

Handmade Software

rInstallFriendly is handmade software, it has been meticulously developed using the C programming language, with great attention put on each line of code written. This approach usually results in highly optimized and efficient code, but it is also more time-consuming and require a higher level of technical skills. The result is great performance and small memory footprint.

rInstallFriendly is self-contained in a single-executable of about 1 MB, it could fit on a floppy disk.

rInstallFriendly could be customized on demand for corporate users, if your company needs a custom version, just get in touch: ray[at]raylibtech.com

Issues & Feedback

You can report tool issues and feedback at https://github.com/raylibtech/rtools

License

The use of rInstallFriendly desktop application is subject to the terms and conditions of the End User License Agreement. By using rInstallFriendly, the user agrees to be bound by the terms of the EULA.

Check included End User License Agreement document for details (EULA.txt).

Copyright (c) 2023 raylib technologies (@raylibtech) | Ramon Santamaria (@raysan5)