├── .github └── ISSUE_TEMPLATE │ └── issue_template.md ├── OEM.md ├── README.md └── contributing.md /.github/ISSUE_TEMPLATE/issue_template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Issue Report 3 | about: File an issue report. 4 | 5 | --- 6 | 7 | #### Your system information 8 | 9 | * Steam client version: 10 | * SteamOS version: 11 | * Opted into Steam client beta?: [Yes/No] 12 | * Opted into SteamOS beta?: [Yes/No] 13 | * Have you checked for updates in Settings > System?: [Yes/No] 14 | 15 | #### Please describe your issue in as much detail as possible: 16 | Describe what you _expected_ should happen and what _did_ happen. 17 | 18 | #### Steps for reproducing this issue: 19 | 20 | 1. 21 | 2. 22 | 3. 23 | -------------------------------------------------------------------------------- /OEM.md: -------------------------------------------------------------------------------- 1 | ### SteamOS hardware enablement and development guidelines 2 | 3 | If you want to create a Steam machine design, please keep the following things in mind when deciding on the specifications. 4 | 5 | All hardware support is provided out of the box by the SteamOS image and as such, support for your devices has to be integrated into SteamOS ahead of time. This requires coordination between you, your device vendors and Valve well ahead of the release (or even specification) of your product. 6 | 7 | #### Graphics 8 | 9 | Graphics driver releases from the vendors are integrated as-is into SteamOS; as such it is your responsibility to coordinate with them to ensure the hardware and features you want to ship will be supported by their publicly available drivers by the time you're planning to start ramping up testing. 10 | 11 | #### Picking hardware devices 12 | 13 | When specifying your Steam Machine design, please make sure all the device vendors provide Linux support and are willing to work with Valve to integrate their support into the Linux kernel shipped with the current SteamOS release. 14 | 15 | The kernel tree for SteamOS lives there: 16 | 17 | https://github.com/ValveSoftware/steamos_kernel 18 | 19 | This tree is the common kernel for all SteamOS devices; as such, be very careful about the scope of your patches and don't touch common code or interfaces unless you have a very good reason to do so. 20 | 21 | The current shipping branch for SteamOS 2.0 is 'brewmaster-4.1' and branched off 'linux-4.1.y' from kernel.org; send your pull requests against 'brewmaster-4.1'. 22 | 23 | Please coordinate with your vendors to confirm that support for their devices is either: 24 | * Already present in that base version of the kernel, in which case it'll be supported out-of-the-box by the SteamOS kernel 25 | * Supported in a subsequent release of the kernel, in which case they will have to be backported to kernel our tree (see above) and provided to us as a pull request that we can integrate with our kernel for testing. 26 | 27 | Make sure your pull requests are fully tested on the target hardware or that Valve has access to the right hardware platform to confirm that the driver works. 28 | 29 | We cannot support out-of-tree drivers; please ensure your vendors are ready to have all their changes upstream by the time they expect SteamOS testing to be able to begin. 30 | 31 | #### Boot firmware display 32 | 33 | The steps below will ensure we have all the tools at our disposal to offer a seamless boot experience from pressing the power button to the SteamOS login screen: 34 | 35 | * The firmware should program the primary display device with its native timings, according to its EDID 36 | * Not doing that will cause a modeswitch during boot, making the TV go dark for a few seconds and print mode information 37 | * The firmware should allocate its EFI framebuffer with the same size as the mode it's programming 38 | * The SteamOS bootloader and kernel inherit this framebuffer 39 | * Allocating a mismatching framebuffer will cause a distorted/pixelated splash screen and flickering during boot 40 | * The firmware should only display the SteamOS splash screen during regular boot 41 | * The splash screen will be stored in EFI/steamos/steamos.png by SteamOS and might be updated in-place in the future 42 | * The splash screen should be upscaled or downscaled to the target framebuffer resolution (see above) 43 | * The splash screen aspect ratio should be maintained 44 | * The splash screen shouldn't be zoomed 45 | * Nothing should be overlaid on top of the splash screen (eg. text prompts; "Press DEL to enter setup") 46 | * The firmware shouldn't clear this splash screen before handing off to the SteamOS bootloader 47 | 48 | #### Boot firmware input 49 | 50 | * The machine needs to be able to be woken up and powered on from S5 with the USB port that hosts the Steam Controller's wireless dongle, through regular USB power events. 51 | * The BIOS setup screen should be able to be entered with the Tab key and navigated with the Arrow keys, Enter and Escape. 52 | 53 | #### Factory Install Processes 54 | 55 | * The machine's RTC should be set to UTC time, not local time. The end user selects their time zone during the first boot. 56 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | SteamOS community tracker 2 | ========================= 3 | 4 | This issue tracker is meant for community support and requests for improvements. 5 | 6 | SteamOS FAQ 7 | ----------- 8 | 9 | http://steamcommunity.com/groups/steamuniverse/discussions/1/648814395741989999/ 10 | 11 | Supplemental community-driven information can also be found in the [wiki](https://github.com/ValveSoftware/SteamOS/wiki) section of this repository. 12 | 13 | Reporting Issues 14 | ---------------- 15 | 16 | If you encounter an issue while using SteamOS, first search the [issue list](https://github.com/ValveSoftware/SteamOS/issues) to see if it has already been reported. Include closed issues in your search. Some issues may have already been reported to other trackers, so it may be worth checking the following: 17 | 18 | - [Steam for Linux](https://github.com/ValveSoftware/steam-for-linux/issues) for Steam Client issues 19 | - [Dota 2](https://github.com/ValveSoftware/Dota-2/issues) for issues regarding Dota 2 on Mac and Linux/SteamOS. 20 | - [Counter-Strike: Global Offensive](https://github.com/ValveSoftware/Counter-Strike-Global-Offensive/issues) for issues regarding Counter-Strike: Global Offensive on Linux/SteamOS. 21 | - [Portal 2](https://github.com/ValveSoftware/portal2/issues) for issues regarding Portal 2 on Linux/SteamOS. 22 | - [HalfLife](https://github.com/ValveSoftware/halflife/issues) for issues regarding Half-Life 1 engine (GoldSrc) games. 23 | - [Source-1 Games](https://github.com/ValveSoftware/Source-1-Games/issues) for issues regarding Source games (HL2, TF2, CS:S, etc) 24 | 25 | If it has not been reported, create a new issue with at least the following information: 26 | 27 | - a short, descriptive title; 28 | - a detailed description of the issue, including any output from the command line; 29 | - steps for reproducing the issue; and 30 | - your system information.\* 31 | - Steam has the ability to submit a "system report" directly to Valve, that could include useful information about the issue. 32 | - `Settings -> System -> Advanced -> System Report -> Create Report` 33 | - It's necessary to mention your steam ID in the issue so that the corresponding system report can be retrieved. 34 | 35 | Please place logs either in a code block (press `M` in your browser for a GFM cheat sheet) or a [gist](https://gist.github.com) if they are lengthy. Information on log locations what what do with them, can be found on [wiki](https://github.com/ValveSoftware/SteamOS/wiki/Reviewing-log-information). 36 | 37 | Conduct 38 | ------- 39 | 40 | 41 | There are basic rules of conduct that should be followed at all times by everyone participating in the discussions. While this is generally a relaxed environment, please remember the following: 42 | 43 | - Do not insult, harass, or demean anyone. 44 | - Do not intentionally multi-post an issue. 45 | - Do not use ALL CAPS when creating an issue report. 46 | - Do not repeatedly update an open issue remarking that the issue persists. 47 | 48 | Remember: Just because the issue you reported was reported here does not mean that it is an issue with Steam. As well, should your issue not be resolved immediately, it does not mean that a resolution is not being researched or tested. Patience is always appreciated. 49 | -------------------------------------------------------------------------------- /contributing.md: -------------------------------------------------------------------------------- 1 | Reporting Issues 2 | ---------------- 3 | 4 | If you encounter an issue while using SteamOS, first search the [issue list](https://github.com/ValveSoftware/SteamOS/issues) to see if it has already been reported. Include closed issues in your search. Some issues may have already been reported to other trackers, so it may be worth checking the following: 5 | 6 | - [Steam for Linux](https://github.com/ValveSoftware/steam-for-linux/issues) for Steam Client issues 7 | - [Dota 2] (https://github.com/ValveSoftware/Dota-2/issues) for issues regarding Dota 2. 8 | - [HalfLife] (https://github.com/ValveSoftware/halflife/issues) for issues regarding Half-Life 1 engine (GoldSrc) games. 9 | - [Source-1 Games] (https://github.com/ValveSoftware/Source-1-Games/issues) for issues regarding Source games (HL2, TF2, CS:S, etc) 10 | 11 | If it has not been reported, create a new issue with at least the following information: 12 | 13 | - a short, descriptive title; 14 | - a detailed description of the issue, including any output from the command line; 15 | - steps for reproducing the issue; and 16 | - your system information.\* 17 | 18 | Please place logs either in a code block (press `M` in your browser for a GFM cheat sheet) or a [gist](https://gist.github.com). Information on log locations what what do with them, can be found on [wiki](https://github.com/ValveSoftware/SteamOS/wiki/Reviewing-log-information). If the logs and/or system information are lengthy, please place them into a GitHub [Gist](https://gist.github.com/). 19 | --------------------------------------------------------------------------------