Git Product home page Git Product logo

reliefvalve's Introduction

ReliefValve iconReliefValve

Travis-CI Build Status Appveyor Build Status

Libraries.io for GitHub

GitHub issues

GitHub license

Total Downloads

A tool to help manage the Steam client, and apps installed via Steam.


Table of contents

What is it?

A tool to help manage the Steam client, and apps installed via Steam. Features are based on tricks which can be done manually, or are well-hidden options within the Steam client.

  • Manage auto-update settings for the apps you've installed via the Steam client.

  • Apply an offline fix to make apps which have an update available playable in offline mode.

  • Help "force start" a download for a game that's not compatible with your system.

  • Change your Steam skin, including to a random one. Information about ReliefValve.

  • What - What the app can do.

  • How - How the app is built, powered.

  • Warning - Warning that "ReliefValve is in no way affiliated with, authorized, maintained, sponsored or endorsed by Valve or any employees of Valve."

Installation

Windows

Download the ReliefValve-v#.#.#-Setup.exe and install it.

Linux

  • Download the AppImage for your system. On 32-bit systems get the i386 (32-bit) version, on 64-bit systems get the x86_64 (64-bit) version.

  • Open a terminal and cd into the folder where the AppImage is.

  • Make it executable with

    chmod a+x ReliefValve*.AppImage

  • Run it with

    ./ReliefValve*.AppImage

  • ...or by double-clicking/right clicking and pressing "Run" if you're into that kinda thing, or you can search for it in your Applications and open it from there.

Note: Linux needs to run chmod a+x ReliefValve*.AppImage after updating the app even if you replace the old copy with a new one.

Mac

Download the .dmg, mount it, and then drag ReliefValve.app to Applications.

Usage

Notes

The application is "frameless" by default, so does not have an outer edge. This means it can easily blend into other windows and be hard to see the edges of it. Setting a background image will help with this.

RV does a lot of reading/writing - it's config file that stores the settings, your Steam installation, and the Windows registry (to change the selected Steam skin). Using it on/from a SSD is not recommended.

As far as I know Steam must be opened using "Steam Browser Protocol" at least once with your system's browser before RV can do so.


Setup

Open "Settings" and press "Choose", and then select the folder where Steam is installed to load your installation. If you want to automatically load it when RV is started check "Auto-load" and press Apply.


Main

main

Steam Apps

On the left is your list of apps installed via Steam, aka Steam Apps. On the left of it's label is a refresh button to reload the list, and on the right is the number of items currently in the list (which is updated when you filter the list using the search box).

Below that the boxes are:

  • Blue - The total number of currently selected apps.
  • Green - The total number of currently selected apps that are playable.
  • Yellow - The total number of currently selected apps that are fully installed, but have an update available, and can be fixed for offline play.
  • Red - The total number of currently selected apps that are useless.

Steam App Controls

  • First is the auto-update setting control, which you may be familiar with from Steam because it's the exact same idea & wording. This will apply the chosen auto-update setting to each selected app when you press "Apply" on the bottom left of the main page.
  • Next is the "Offline Fix" checkbox. If any of the selected apps can be fixed for offline play, this will do the fix when you press "Apply" on the bottom left of the main page.
  • Next, "Add To Blacklist". This will add all of the currently selected apps to the blacklist on the right, which is explained further below.

Blacklist

On the right is the Blacklist, which is apps that will be ignored by ReliefValve and not loaded, to keep it from messing with them in any way. Next to the label is the number of items currently in the list (which is also updated when you filter the list using the search box).

Below the Blacklist the box is the same as for the Steam Apps list:

  • Blue - The total number of currently selected apps.

Blacklist Controls

  • "Remove Selected" will remove the currently selected apps fromt the Blacklist. Note that SteamVR is permanently blacklisted as I'm not sure how Steam would deal with changing it's appmanifest file.
  • "Reset Blacklist" will remove everything (except SteamVR) from the Blacklist, resetting it to it's beginning state.

Settings

settings

Steam Location

Controls for the Steam install location RV uses.

  • Choose button - Select a new Steam Location; also loads it when chosen.

  • Auto-load User - Auto-load the chosen Steam Location when ReliefValve starts.

  • Apply - Save the auto-load setting, including the chosen Steam Location.

ReliefValve Settings

Controls for RV's own settings.

  • Background - Choose default (nothing, will use default background color), Solid (solid color background), or Image (a background image, as in the screenshots). When you choose "Solid" or "Background" another control will popup. When solid is selected it will be a color bar (as is shown by the "Text Color" setting) which when clicked will open a color picker that lets you pick a solid color. When Image is selected it will display a label with the file name of the current background image or "..." if nothing is selected, and below it a "Choose" button that will let you pick a different background image.
  • Text Color - The text color which will be used throughout most of the application.
  • Apply - Saves the selected settings and applies them the app.

Client

client

Force Start Download

Enter an appid or Steam Store URL of an app to "force download" it on an unsupported platform.

  • The text box is where to enter the appid or store url.
  • The "Game Name" label will be updated with the name of the game if it's found.
  • The "Clear" button will clear the text box.
  • The "Add" button will add the forced download.

Client Options

Options for the Steam client.

  • "Launch Options" opens a dialog with some launch options for the Steam client. Check a box if you want to use an option.

  • "Launch" will launch the Steam client with the selected Launch Options.

    Launch Options

    client-launch-options

    Launch options for the Steam client.

  • Enable Console - Enables the debugging console of the Steam client, found under the Console tab when it's enabled. Allows access to some special hidden commands and variables.

  • Developer Mode - Enables the console + developer mode of the Steam client. Developer mode enables use of VGUI inspector by pressing F6 (similar to a modern browser's "devtools") or VGUI zoo by pressing F7, which are useful for Steam skin development.

  • Big Picture Mode - Open Steam in Big Picture Mode.

  • Close ReliefValve - If this is selected then when you press "Launch" to start Steam ReliefValve will close itself.

  • Reset - Reset launch options to the last saved defaults.

  • Save - Save the currently selected launch options as the default.


Help

A very minimal version of the README documentation. Needs an upgrade.


About

Information about ReliefValve.

  • What - What the app can do.
  • How - How the app is built, powered.
  • Warning - Warning that "ReliefValve is in no way affiliated with, authorized, maintained, sponsored or endorsed by Valve or any employees of Valve."

Unsigned

This is an unsigned application and it will not run on Windows or Mac without first warning the user and asking for consent (on Windows). On Mac it can be run by right clicking & pressing "Open" and then "Open" again in the dialog that pops up; you may need to enter the admin password to do this.


License

Distributed under the MIT license. See LICENSE for more information.


Contact

l3l_aze (Tom Shaver) GitHub Reddit Steam e-mail

https://github.com/l3laze/ReliefValve

reliefvalve's People

Contributors

l3laze avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

fossabot inc775

reliefvalve's Issues

[Linux] desktop file is lacking a Categories= entry

The desktop file is lacking a Categories= entry in the *.desktop file.

According to the menu spec,

By including one of the Main Categories in an application's desktop entry file, the application will be ensured that it will show up in a section of the application menu dedicated to this category. If multiple Main Categories are included in a single desktop entry file, the entry may appear more than once in the menu.

Hence, please add at least one of the following in the Categories= key.

Main Category Description Notes
AudioVideo Application for presenting, creating, or processing multimedia (audio/video)
Audio An audio application Desktop entry must include AudioVideo as well
Video A video application Desktop entry must include AudioVideo as well
Development An application for development
Education Educational software
Game A game
Graphics Application for viewing, creating, or processing graphics
Network Network application such as a web browser
Office An office type application
Science Scientific software
Settings Settings applications Entries may appear in a separate menu or as part of a "Control Center"
System System application, "System Tools" such as say a log viewer or network monitor
Utility Small utility application, "Accessories"

In addition, you could specify one or more from the longer list of Additional Categories.

Please test the result with desktop-file-validate and make sure it passes.

electron-builder offers native support for this since v19.22.1.

Reference: AppImage/appimage.github.io#2

stuck with white screen

After choosing steam location it then goes to a pure white screen and stays that way .
I have to kill the process from task manger or process explorer.
Tried as admin and non-admin in case it made a difference.

win 10 x64 updated

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.