commit 88ecb1bc2410b1ed9f067c75c08086e2f78b2609 Author: Justin Harms Date: Sat Jan 18 20:03:40 2025 -0600 initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..237aa5d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [2025] [SteamCache2] + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..55b0394 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# SteamCache2 + +SteamCache2 is a blazing fast download cache for Steam, designed to reduce bandwidth usage and speed up game downloads. + +## Features + +- High-speed caching for Steam downloads +- Tiered storage for getting the most out of your storage media +- Reduces bandwidth usage +- Easy to set up and configure aside from dns stuff to trick Steam into using it +- Supports multiple clients + +## Usage + +1. Start the cache server: + ```sh + ./SteamCache2 + ``` +2. Configure your Steam client to use the cache server as a proxy. + +## License + +This project is licensed. See the [LICENSE](LICENSE) file for details. + +## Acknowledgements + +- Inspired by other caching solutions for game platforms. diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..8a27992 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module s1d3sw1ped/SteamCache2 + +go 1.23.0