/SteamOS-Tools

Tools and scripts for SteamOS

Primary LanguageShellGNU Affero General Public License v3.0AGPL-3.0

SteamOS-Tools

Version 2.6.5

Tools and scripts for SteamOS. Be sure to check out the Upcoming features subsection on the wiki for the latest developments! For those of you that wish to contribute, suggest, or otherwise correct code, please first read the Development and Feautres wiki page. Code corrections, additions, and all other suggestions can be made to the issus tracker.

All operations are tested against official Valve releases only.

For the latest change details, please see the commits page and changelog.md file for overall change details.

Warning

Please take time to read the disclaimer. Please also understand the default branch of this GitHub repository is for SteamOS Brewmaster.

Wiki and FAQ

Please refer to the wiki, located to your right in this repository for all supplemental information and instructions. A direct link to the FAQ is here. Information for installations, as well as much more, is located within. If there is a page missing, or information you wish me to add, please let me know via an issues ticket.

For SteamOS-specific help (aside from SteamOS-Tools), I do ask you visit and review the community SteamOS wiki at steamos.wikia.com for all other topics. This is one area that I greatly appreciate help and support with. Please considering signing up or anonymously contributing to it.

Hosted packages

There is now a Debian personal repository hosted at packages.libregeek.org. Be sure to check out the "hosted packages" section below! The wiki entry also contains repository information if you should wish to add the repository manually.

SteamoS-Tools Repository

Usage / Installation

Please make sue you have enabled desktop mode (Settings > Interface > Enable access to the Linux desktop), and aset your password for the dekstop user with passwd.

To clone this repository to your local computer, you will need the git software package to clone the repository. The command is included below in the first line below if you do not know it.

sudo apt-get install git
git clone https://github.com/ProfessorKaos64/SteamOS-Tools
cd SteamOS-Tools/

To update your local copy of files:

cd SteamOS-Tools/
git pull

There is also a testing branch for this repository, but I advise against using it.

Normal script execution, sans arguments, goes a little bit like:

./script-name.sh

Contents

  • artwork - Banners and various images/artwork for SteamOS.
  • cfgs/ - various configuration files, including package lists for Debian software installations.
  • docs/ - Various documentation. Previously hosted script documentation that is now on teh wiki.
  • ext-game-installers/ - Game installers for games outside Steam (e.g. GZDoom).
  • extra/ - Various extra scripts
  • game-fixes - A location to store some small deployable fixes for games.
  • scriptmodules/ - Plugable bash modules / routines for any of the below scripts. Scripts for packages and more.
  • utilities/ - various scripts to handle small parts of the SteamOS-Tools repository (plugable objects), build scripts, and standalone tools for use.
  • README.md - This file.
  • AUTHORS.md - Contributions, attributions, and more
  • LICENCE.md - License for this repository. Share all the things! ZOMGOMGBBQHELICOPTERZ
  • add-debian-repos.sh - adds debian repositories for installing Debian software.
  • changelog.md - Changes made to repository and tools
  • contributing.md - Guidelines for repository contributions
  • desktop-software.sh - script to install custom and bulk Debian desktop software packages, as well as special additional packages/utilities, such as gameplay recording, "web apps," and more. Please see the readme file in docs/ for the full listing of options.
  • disclaimer.md - safety warnings for this repository.

Wiki

  • In time I hope to maintain a colletion of useful articles or links to Steamcommunity Guides that still work, currate them and other such things*.

Video demonstrations / tutorials

Branches

There are four main branches at the moment

alchemist
Alchemist branch. Due to Brewmaster being usable now, this branch is not as up to date.
brewmaster
Brewmaster branch. Default branch for repository.
testing-a
Branch where new scripts are made, larger alterations to existing ones implemented, and more for alchemist.
testing-b
Branch where new scripts are made, larger alterations to existing ones implemented, and more for brewmaster.

Pull requests / suggestions

Please submit any issues / suggestions to the issues tracker on the right hand side of this page or any corrections (with justification) as a Pull Request. Have a cool script or method to enhance SteamOS? Send it over! Your name will be added to the script header and the contributing.md file.

Troubleshooting

Most scripts in the main folder of the repository write stdout and stderr to log.txt in the current directory after completion. Please check this file before submitting any issues or pull requests.

Donations

If you wish to support the work here, hosting costs for packages, and more, you can do so monthly at Patreon.com, or make a one time donation over at http://www.libregeek.org/.