Skip to content

Commit

Permalink
A lot of work for the upcoming release.
Browse files Browse the repository at this point in the history
  • Loading branch information
syntax-tm committed May 9, 2024
1 parent 027f14b commit 120d96a
Show file tree
Hide file tree
Showing 87 changed files with 2,986 additions and 546 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 7.0.x
dotnet-version: 8.0.x
- id: cache-restore
uses: actions/cache/restore@v4
with:
Expand Down
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"svg.preview.background": "white"
}
56 changes: 52 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,62 @@
## 0.6.0

### 1.0.0-alpha

#### General

- Upgraded to .NET 8
- Updated [WPF-UI](https://github.com/lepoco/wpfui) to version 3.0.4

#### SAM

- Added status bar item for favorites
- Added ability to show hidden apps
- Added ability to unhide all apps
- Added ability to show only favorited apps
- Added autocomplete to search
- Added overlay for favorited apps
- Added overlay for hidden apps
- Added overlay menu for quickly adding/removing favorites and hiding/showing apps
- Added `View on SteamGridDB` menu option
- Added support for displaying [Steam Grid](https://www.steamgriddb.com/) assets
- **Note:** Animated images are not currently supported
- Added support for loading Steam's `librarycache` images
- Implemented app refresh queue
- This should help users with larger Steam libraries from having issues with the Steamworks Web API
- **[BUG]** Fixed error in debug output when launching a web page
- **[BUG]** Fixed hidden apps status bar item count not updating
- **[BUG]** Fixed library search textbox alignment

#### SAM.Manager

- **[BUG]** Ability to filter achievements using the drop down has been temporarily removed

#### Planned

##### SAM

- Ability to customize favorites overlay color
- Ability to customize hidden overlay color
- Basic command line options
- For automating resettings stats/achievements, generating reports, etc.
- Save and auto load `Show Hidden` and `Show Only Favorites` view settings

#### Known Issues

- An `OutOfMemoryException` will be thrown when attempting to load an animated Grid image
- This should only be visible in the output when debugging and can be ignored
- Startup SlpashScreen's TitleBar was removed
- During startup, you will not be able to move the SplashScreen or close it using the Window buttons

### 0.6.0-alpha

- Updated logging
- [BUG] Removed library caching
- **[BUG]** Removed library caching

## 0.5.0

- [BUG] Fixed issue with increment only stats allowing invalid values
- [BUG] Fixed issue with increment only stats not displaying properly
- **[BUG]** Fixed issue with increment only stats allowing invalid values
- **[BUG]** Fixed issue with increment only stats not displaying properly

## 0.4.0

Expand All @@ -32,7 +80,7 @@
- Added new release workflow
- Added ability to Refresh Steam library
- Switched ViewModels to source generators
- [BUG] Fixed issue with the "Show Hidden" button not working for Achievements
- **[BUG]** Fixed issue with the "Show Hidden" button not working for Achievements

## 0.1.0

Expand Down
55 changes: 25 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
<div align="center">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/syntax-tm/SteamAchievementManager">
<img src="https://github.com/syntax-tm/SteamAchievementManager/actions/workflows/build.yml/badge.svg">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/syntax-tm/SteamAchievementManager">
<img alt="GitHub release (with filter)" src="https://img.shields.io/github/v/release/syntax-tm/SteamAchievementManager">
</div>
<h1>
<div align="center">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/syntax-tm/SteamAchievementManager">
<img alt="Build Badge" src="https://github.com/syntax-tm/SteamAchievementManager/actions/workflows/build.yml/badge.svg">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/syntax-tm/SteamAchievementManager">
<img alt="GitHub release (with filter)" src="https://img.shields.io/github/v/release/syntax-tm/SteamAchievementManager">
</div>
</h1>

<p align="center">
<img src="./resources/SAM_logo_light_blue.svg" style="max-width: 600px; width: 70%;">
<img alt="SAM Logo" src="./resources/SAM_logo_default.svg" style="max-width: 600px; width: 70%;">
</p>

## Overview

The Steam Achievement Manager lets you manage achievements, stats, and more for any currently supported app.
The Steam Achievement Manager lets you manage achievements, stats, and more for any currently supported Steam app.

<p align="center">
<a href="./resources/sam_screenshot.png">
<img src="./resources/sam_screenshot.png" />
<a href="./resources/animated/SAM.webp">
<img alt="SAM Screenshot" src="./resources/animated/SAM.webp" />
</a>
</p>

This project is a fork of the [Steam Achievement Manager](https://github.com/gibbed/SteamAchievementManager) project with the goal of updating to .NET Core and WPF. This is very much a work in progress.
This project is a fork of the [Steam Achievement Manager](https://github.com/gibbed/SteamAchievementManager) project with the goal of updating to .NET Core and WPF.

## Project Structure

Expand Down Expand Up @@ -63,7 +65,7 @@ flowchart TB
<table align="center">
<tr>
<th align="center">Legacy Project</th>
<th>New Project</th>
<th align="center">New Project</th>
<th style="width: 80%;">Description</th>
</tr>
<tr>
Expand All @@ -88,33 +90,26 @@ flowchart TB
</tr>
</table>

---

## FAQ

### What is an App or App ID?

> An Application (or App) is the main representation of a product on Steam. An App generally has its own store page, it's own Community Hub, and is what appears in customers' libraries. Each App is represented by a unique ID called an App ID - that you'll see referenced throughout this documentation and used with the Steamworks API and Steamworks Web API. Generally a single product will not span multiple Applications. ([source](https://partner.steamgames.com/doc/store/application))
## Sponsors

### Why does SAM let people cheat achievements?
<p align="center">
<img alt="JetBrains" src="./resources/ref/JetBrains_Logo_2016.svg" width="120" />
</p>

Some games have achievements that are no longer reasonably or actually attainable. While SAM _can_ be used to abuse the achievement system, it also lets people who do care about achievements unlock achievements that would otherwise be impossible. One common example is achievements requiring you to play multiplayer on a game that no longer has any active players, or even dedicated servers. **SAM** is a potential solution for a game's poorly designed achievements.
A special thank you to [JetBrains](https://www.jetbrains.com/) for their continued [Support of Open-Source Projects](https://www.jetbrains.com/community/opensource/#support) like **SAM**.

---
> [!NOTE]
> Active **SAM** contributors are eligible to receieve complimentary licenses [for non-commercial development] for **all** **JetBrains** products. For questions regarding eligability please refer to the [Open Source FAQ](https://sales.jetbrains.com/hc/en-gb/categories/13706169183250-Free-Licenses-for-OSS-development).
## Acknowledgements

- [Devexpress MVVM](https://github.com/DevExpress/DevExpress.Mvvm.Free)
- [Font-Awesome-WPF](https://github.com/charri/Font-Awesome-WPF)
- [SteamCountries](https://github.com/RudeySH/SteamCountries)
- [WPF UI](https://github.com/lepoco/wpfui)

---
<p align="center">
<a href="https://github.com/DevExpress/DevExpress.Mvvm.Free">DevExpress MVVM</a> • <a href="https://github.com/RudeySH/SteamCountries">SteamCountries</a> • <a href="https://github.com/lepoco/wpfui">WPF UI</a>
</p>

## Resources

- [DevExpress MVVM](https://docs.devexpress.com/WPF/15112/mvvm-framework)
- [Font-Awesome-WPF Documentation](https://github.com/charri/Font-Awesome-WPF/blob/master/README-WPF.md)
- [Steamworks API Overview](https://partner.steamgames.com/doc/sdk/api)
- [Steamworks Overview](https://partner.steamgames.com/doc/sdk/api)
- [Steamworks API](https://partner.steamgames.com/doc/api)
- [Steamworks Web API](https://partner.steamgames.com/doc/webapi)
62 changes: 62 additions & 0 deletions resources/SAM_API_logo_default.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions resources/SAM_logo_default.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/animated/SAM.webp
Binary file not shown.
Binary file added resources/ico/sam.ico
Binary file not shown.
File renamed without changes
File renamed without changes
Binary file added resources/ref/devexpress.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 120d96a

Please sign in to comment.