First off, thanks for taking the time to contribute! 👍
This is a community project packaging CachyOS's Proton build for NixOS. Any help is appreciated, whether it's:
- Reporting bugs
- Improving documentation
- Submitting fixes
- Testing with different games
- Suggesting improvements
- Fork the repository
- Create a feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
The package is relatively simple, consisting of:
default.nix
: The main package definitionflake.nix
: The flake interfaceversions.json
: Version information that's automatically updated
Before submitting a PR, please:
- Build the package:
nix build
- Test it with Steam:
# Add to your NixOS config and rebuild
sudo nixos-rebuild switch
- Verify it appears in Steam's compatibility tools list
The package has an automated workflow that:
- Checks for new versions every 6 hours
- Creates a PR when updates are available
- Runs basic tests on the package
Feel free to open an issue for any questions or suggestions!