Skip to content

NixOS flake packaging for CachyOS Proton (https://github.com/CachyOS/proton-cachyos), a compatibility tool for Steam Play with CachyOS optimizations

License

Notifications You must be signed in to change notification settings

kimjongbing/nix-proton-cachyos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nix Proton CachyOS

A Nix flake for CachyOS Proton, a compatibility tool for Steam Play based on Wine with additional patches and optimizations from CachyOS.

Disclaimer: This is an unofficial, community-maintained Nix package. It is not affiliated with, officially connected to, or endorsed by Valve Corporation, CachyOS, or any of their subsidiaries or affiliates. The names Proton, CachyOS, and any related names are trademarks of their respective owners.

Usage

Add to your NixOS configuration:

{
  inputs = {
    nix-proton-cachyos.url = "github:kimjongbing/nix-proton-cachyos";
  };
}

Then add it to your Steam configuration:

# In your Steam configuration (e.g., configuration.nix or steam.nix)
programs.steam = {
  enable = true;
  extraCompatPackages = [
    inputs.nix-proton-cachyos.packages.${system}.proton-cachyos
  ];
};

After rebuilding your system, you should see something like "Proton-CachyOS" in Steam's compatibility tools list (Steam -> Settings -> Compatibility).

Updates

This package automatically checks for updates every 6 hours and creates a pull request when a new version is available on the CachyOS mirror. To get the latest version:

  1. Update your flake inputs:
nix flake update nix-proton-cachyos
  1. Rebuild your system:
sudo nixos-rebuild switch

Contributing

This is a community-maintained package and help is welcome! If you'd like to contribute:

  1. Issues:

    • Report packaging issues (e.g., installation problems, Steam not detecting the tool)
    • Problems with the Nix flake itself
    • Note: For issues with games or Proton itself, please report to:
  2. Pull Requests:

    • Improvements to the Nix packaging
    • Documentation updates
    • Automation enhancements
  3. Documentation:

    • Help improve installation instructions
    • Add usage examples
    • Clarify system requirements

This repository only handles the Nix packaging of Proton-CachyOS. We can't fix issues with the underlying Proton implementation.

Credits

This package is just a Nix flake wrapper around:

  • Proton-CachyOS by the CachyOS team - a fork of Proton with additional optimizations
  • Proton by Valve Corporation - the original compatibility layer for Steam Play

All credit for the underlying software goes to their respective teams. This repository simply provides the Nix packaging to make it easier to use on NixOS.

About

NixOS flake packaging for CachyOS Proton (https://github.com/CachyOS/proton-cachyos), a compatibility tool for Steam Play with CachyOS optimizations

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages