s1d3sw1ped/steamcache2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 19 Wiki Activity

Refactor module naming and update references to steamcache2
All checks were successful
Release Tag / release (push) Successful in 9s
Details

Browse Source 
- Changed module name from `s1d3sw1ped/SteamCache2` to `s1d3sw1ped/steamcache2` for consistency.
- Updated all import paths and references throughout the codebase to reflect the new module name.
- Adjusted README and Makefile to use the updated module name, ensuring clarity in usage instructions.
This commit is contained in:
Justin Harms
2025-09-21 23:10:21 -05:00
parent 46495dc3aa
commit bd123bc63a
15 changed files with 44 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.goreleaser.yaml
View File

@@ -11,8 +11,8 @@ builds:
- -s - -s
- -w - -w
- -extldflags "-static" - -extldflags "-static"
- -X s1d3sw1ped/SteamCache2/version.Version={{.Version}} - -X s1d3sw1ped/steamcache2/version.Version={{.Version}}
- -X s1d3sw1ped/SteamCache2/version.Date={{.Date}} - -X s1d3sw1ped/steamcache2/version.Date={{.Date}}
env: env:
- CGO_ENABLED=0 - CGO_ENABLED=0
goos: goos:

2
Makefile
View File

@@ -13,7 +13,7 @@ build-snapshot-single: deps test ## Build a snapshot of the application for the
@goreleaser build --single-target --snapshot --clean @goreleaser build --single-target --snapshot --clean
help: ## Show this help message help: ## Show this help message
@echo SteamCache2 Makefile @echo steamcache2 Makefile
@echo Available targets: @echo Available targets:
@echo run Run the application @echo run Run the application
@echo run-debug Run the application with debug logging @echo run-debug Run the application with debug logging

2
README.md
View File

@@ -21,7 +21,7 @@ SteamCache2 is a blazing fast download cache for Steam, designed to reduce bandw
1. **Clone and build:** 1. **Clone and build:**
```bash ```bash
git clone <repository-url> git clone <repository-url>
cd SteamCache2 cd steamcache2
make # This will run tests and build the application make # This will run tests and build the application
``` ```

20
cmd/root.go
View File

@@ -4,10 +4,10 @@ package cmd
import ( import (
"fmt" "fmt"
"os" "os"
"s1d3sw1ped/SteamCache2/config" "s1d3sw1ped/steamcache2/config"
"s1d3sw1ped/SteamCache2/steamcache" "s1d3sw1ped/steamcache2/steamcache"
"s1d3sw1ped/SteamCache2/steamcache/logger" "s1d3sw1ped/steamcache2/steamcache/logger"
"s1d3sw1ped/SteamCache2/version" "s1d3sw1ped/steamcache2/version"
"strings" "strings"
"github.com/rs/zerolog" "github.com/rs/zerolog"
@@ -25,9 +25,9 @@ var (
) )
var rootCmd = &cobra.Command{ var rootCmd = &cobra.Command{
Use: "SteamCache2", Use: "steamcache2",
Short: "SteamCache2 is a caching solution for Steam game updates and installations", Short: "steamcache2 is a caching solution for Steam game updates and installations",
Long: `SteamCache2 is a caching solution designed to optimize the delivery of Steam game updates and installations. Long: `steamcache2 is a caching solution designed to optimize the delivery of Steam game updates and installations.
It reduces bandwidth usage and speeds up the download process by caching game files locally. It reduces bandwidth usage and speeds up the download process by caching game files locally.
This tool is particularly useful for environments with multiple Steam users, such as gaming cafes or households with multiple gamers. This tool is particularly useful for environments with multiple Steam users, such as gaming cafes or households with multiple gamers.
By caching game files, SteamCache2 ensures that subsequent downloads of the same files are served from the local cache, By caching game files, SteamCache2 ensures that subsequent downloads of the same files are served from the local cache,
@@ -53,7 +53,7 @@ var rootCmd = &cobra.Command{
logger.Logger = zerolog.New(writer).With().Timestamp().Logger() logger.Logger = zerolog.New(writer).With().Timestamp().Logger()
logger.Logger.Info(). logger.Logger.Info().
Msg("SteamCache2 " + version.Version + " " + version.Date + " starting...") Msg("steamcache2 " + version.Version + " " + version.Date + " starting...")
// Load configuration // Load configuration
cfg, err := config.LoadConfig(configPath) cfg, err := config.LoadConfig(configPath)
@@ -121,11 +121,11 @@ var rootCmd = &cobra.Command{
) )
logger.Logger.Info(). logger.Logger.Info().
Msg("SteamCache2 " + version.Version + " started on " + cfg.ListenAddress) Msg("steamcache2 " + version.Version + " started on " + cfg.ListenAddress)
sc.Run() sc.Run()
logger.Logger.Info().Msg("SteamCache2 stopped") logger.Logger.Info().Msg("steamcache2 stopped")
os.Exit(0) os.Exit(0)
}, },
} }

8
cmd/version.go
View File

@@ -4,7 +4,7 @@ package cmd
import ( import (
"fmt" "fmt"
"os" "os"
"s1d3sw1ped/SteamCache2/version" "s1d3sw1ped/steamcache2/version"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@@ -12,10 +12,10 @@ import (
// versionCmd represents the version command // versionCmd represents the version command
var versionCmd = &cobra.Command{ var versionCmd = &cobra.Command{
Use: "version", Use: "version",
Short: "prints the version of SteamCache2", Short: "prints the version of steamcache2",
Long: `Prints the version of SteamCache2. This command is useful for checking the version of the application.`, Long: `Prints the version of steamcache2. This command is useful for checking the version of the application.`,
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
fmt.Fprintln(os.Stderr, "SteamCache2", version.Version, version.Date) fmt.Fprintln(os.Stderr, "steamcache2", version.Version, version.Date)
}, },
} }

2
go.mod
View File

@@ -1,4 +1,4 @@
module s1d3sw1ped/SteamCache2 module s1d3sw1ped/steamcache2
go 1.23.0 go 1.23.0

4
main.go
View File

@@ -2,8 +2,8 @@
package main package main
import ( import (
"s1d3sw1ped/SteamCache2/cmd" "s1d3sw1ped/steamcache2/cmd"
_ "s1d3sw1ped/SteamCache2/version" // Import the version package for global version variable _ "s1d3sw1ped/steamcache2/version" // Import the version package for global version variable
) )
func main() { func main() {

18
steamcache/steamcache.go
View File

@@ -13,15 +13,15 @@ import (
"net/url" "net/url"
"os" "os"
"regexp" "regexp"
"s1d3sw1ped/SteamCache2/steamcache/logger" "s1d3sw1ped/steamcache2/steamcache/logger"
"s1d3sw1ped/SteamCache2/vfs" "s1d3sw1ped/steamcache2/vfs"
"s1d3sw1ped/SteamCache2/vfs/adaptive" "s1d3sw1ped/steamcache2/vfs/adaptive"
"s1d3sw1ped/SteamCache2/vfs/cache" "s1d3sw1ped/steamcache2/vfs/cache"
"s1d3sw1ped/SteamCache2/vfs/disk" "s1d3sw1ped/steamcache2/vfs/disk"
"s1d3sw1ped/SteamCache2/vfs/gc" "s1d3sw1ped/steamcache2/vfs/gc"
"s1d3sw1ped/SteamCache2/vfs/memory" "s1d3sw1ped/steamcache2/vfs/memory"
"s1d3sw1ped/SteamCache2/vfs/predictive" "s1d3sw1ped/steamcache2/vfs/predictive"
"s1d3sw1ped/SteamCache2/vfs/warming" "s1d3sw1ped/steamcache2/vfs/warming"
"strconv" "strconv"
"strings" "strings"
"sync" "sync"

4
vfs/cache/cache.go vendored
View File

@@ -3,8 +3,8 @@ package cache
import ( import (
"io" "io"
"s1d3sw1ped/SteamCache2/vfs" "s1d3sw1ped/steamcache2/vfs"
"s1d3sw1ped/SteamCache2/vfs/vfserror" "s1d3sw1ped/steamcache2/vfs/vfserror"
"sync" "sync"
"sync/atomic" "sync/atomic"
) )

10
vfs/disk/disk.go
View File

@@ -7,9 +7,9 @@ import (
"io" "io"
"os" "os"
"path/filepath" "path/filepath"
"s1d3sw1ped/SteamCache2/steamcache/logger" "s1d3sw1ped/steamcache2/steamcache/logger"
"s1d3sw1ped/SteamCache2/vfs" "s1d3sw1ped/steamcache2/vfs"
"s1d3sw1ped/SteamCache2/vfs/vfserror" "s1d3sw1ped/steamcache2/vfs/vfserror"
"sort" "sort"
"strings" "strings"
"sync" "sync"
@@ -186,9 +186,7 @@ func (d *DiskFS) init() {
// Extract key from sharded path: remove root and convert sharding back // Extract key from sharded path: remove root and convert sharding back
// Handle both "./disk" and "disk" root paths // Handle both "./disk" and "disk" root paths
rootPath := d.root rootPath := d.root
if strings.HasPrefix(rootPath, "./") { rootPath = strings.TrimPrefix(rootPath, "./")
rootPath = rootPath[2:] // Remove "./" prefix
}
relPath := strings.ReplaceAll(npath[len(rootPath)+1:], "\\", "/") relPath := strings.ReplaceAll(npath[len(rootPath)+1:], "\\", "/")
// Extract the original key from the sharded path // Extract the original key from the sharded path

6
vfs/gc/gc.go
View File

@@ -4,9 +4,9 @@ package gc
import ( import (
"context" "context"
"io" "io"
"s1d3sw1ped/SteamCache2/vfs" "s1d3sw1ped/steamcache2/vfs"
"s1d3sw1ped/SteamCache2/vfs/disk" "s1d3sw1ped/steamcache2/vfs/disk"
"s1d3sw1ped/SteamCache2/vfs/memory" "s1d3sw1ped/steamcache2/vfs/memory"
"sync" "sync"
"sync/atomic" "sync/atomic"
"time" "time"

2
vfs/memory/dynamic.go
View File

@@ -1,7 +1,7 @@
package memory package memory
import ( import (
"s1d3sw1ped/SteamCache2/vfs" "s1d3sw1ped/steamcache2/vfs"
"sync" "sync"
"sync/atomic" "sync/atomic"
"time" "time"

4
vfs/memory/memory.go
View File

@@ -5,8 +5,8 @@ import (
"bytes" "bytes"
"container/list" "container/list"
"io" "io"
"s1d3sw1ped/SteamCache2/vfs/types" "s1d3sw1ped/steamcache2/vfs/types"
"s1d3sw1ped/SteamCache2/vfs/vfserror" "s1d3sw1ped/steamcache2/vfs/vfserror"
"sort" "sort"
"strings" "strings"
"sync" "sync"

2
vfs/vfs.go
View File

@@ -3,7 +3,7 @@ package vfs
import ( import (
"io" "io"
"s1d3sw1ped/SteamCache2/vfs/types" "s1d3sw1ped/steamcache2/vfs/types"
) )
// VFS defines the interface for virtual file systems // VFS defines the interface for virtual file systems

2
vfs/warming/warming.go
View File

@@ -2,7 +2,7 @@ package warming
import ( import (
"context" "context"
"s1d3sw1ped/SteamCache2/vfs" "s1d3sw1ped/steamcache2/vfs"
"sync" "sync"
"sync/atomic" "sync/atomic"
"time" "time"