Skip to content

RealMrCactus/valvefetch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ValveFetch

ValveFetch is a lightweight, user-friendly wrapper for SteamCMD that simplifies the process of managing Steam workshop content and game servers. Written in Rust for maximum performance and reliability, it handles authentication, addon downloads, and path management with minimal configuration.

Features

  • 📦 Automated workshop content downloads
  • 🗂️ Custom installation path configuration (Not Implemented)
  • 📝 Detailed logging system (Not Implemented)
  • 💾 Path persistence for recurring downloads (Not Implemented)
  • 🔄 Batch download support (Implemented incorrectly)
  • ⚡ Quick server setup and management (we'll see)
  • 🦀 Written in Rust for optimal performance and safety

Installation

# Using cargo
cargo install valvefetch

# From source
git clone https://github.com/yourusername/valvefetch
cd valvefetch
cargo build --release

Quick Start

# Basic usage
valvefetch --login username

# Download a specific workshop item
valvefetch --download 123456789

# Set custom installation path
valvefetch --path "/path/to/addons" --save

Batch Downloads

addon-id
addon-id
addon-id
...

Configuration

ValveFetch stores its configuration in ~/.config/valvefetch/config.toml (Linux/macOS) or %APPDATA%\ValveFetch\config.toml (Windows).

May be subject to change

default_path = "/path/to/addons"
steam_path = "/path/to/steamcmd"
log_level = "INFO"

Command Line Arguments

Usage: valvefetch [OPTIONS] COMMAND [ARGS]...

Options:
  --login TEXT         Steam username for authentication
  --download INT       Workshop item ID to download
  --path TEXT         Custom installation path
  --save              Save current path as default
  --batch FILE        Path to batch file containing workshop IDs
  --quiet            Reduce output verbosity
  --version          Show version information
  --help             Show this message and exit

Examples

Download Single Addon

valvefetch --login myusername --download 123456789

Batch Download

valvefetch --login myusername --batch addons.txt

Set New Default Path

valvefetch --path "/games/garrysmod/addons" --save

Requirements

  • Rust 1.80+
  • SteamCMD in your path

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Acknowledgments

  • Valve Corporation for SteamCMD
  • All contributors who have helped with the project (None yet :()
  • The Steam Workshop community

Support

If you encounter any issues or have questions, please:

  1. Check the FAQ (Nonexisting)
  2. Search existing issues
  3. Create a new issue if necessary

About

SteamCMD wrapper in rust.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages