Skip to content
This repository was archived by the owner on May 11, 2026. It is now read-only.

Commit 970cc1d

Browse files
committed
update README.md
1 parent 050d5ae commit 970cc1d

2 files changed

Lines changed: 19 additions & 22 deletions

File tree

Animation.gif

317 KB
Loading

README.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
Patches Steam games to run through the [Goldberg emulator](https://github.com/Detanup01/gbe_fork).
66
Finds the AppID, grabs DLC info, swaps the DLLs, backs up the originals. One command.
77

8-
![Python](https://img.shields.io/badge/python-3.13%2B-blue?style=flat-square)
9-
![Platform](https://img.shields.io/badge/platform-Windows-lightgrey?style=flat-square)
10-
![License](https://img.shields.io/badge/license-MIT-green?style=flat-square)
8+
[![PyPI version](https://img.shields.io/pypi/v/steamlayer.svg?style=flat-square)](https://pypi.org/project/steamlayer/)
9+
![Python 3.13+](https://img.shields.io/badge/python-3.13%2B-blue?style=flat-square)
10+
![Windows Only](https://img.shields.io/badge/platform-Windows-lightgrey?style=flat-square)
11+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](https://opensource.org/licenses/MIT)
1112

13+
[View Demo](https://raw.githubusercontent.com/layeredtools/steamlayer/refs/heads/main/Animation.gif)
1214
</div>
1315

1416
---
1517

1618
## What it does
1719

18-
You point it at a game folder. It figures out the AppID (or you tell it), pulls DLC metadata from Steam, backs up the original `steam_api.dll` files, drops in Goldberg's replacements, and writes the config. If something breaks or you just want your files back, `--restore` undoes everything cleanly.
19-
20-
7-Zip, Goldberg, and Steamless are downloaded automatically on first run — you don't install them manually.
20+
`steamlayer` automates the tedious manual work of setting up game environments. It handles AppID discovery, DLC metadata fetching, DLL swapping, and SteamStub stripping in a single pass—all while keeping your original files safe in a managed vault.
2121

2222
> [!WARNING]
2323
> steamlayer is under active development and not yet production-ready. Expect rough edges, and always keep `--restore` in mind.
@@ -40,8 +40,6 @@ pipx install steamlayer
4040
* Windows
4141
* 7-Zip somewhere on your system for the very first run (after that steamlayer manages its own copy).
4242

43-
---
44-
4543
## Usage
4644

4745
```bash
@@ -72,6 +70,19 @@ Something broke, want your files back:
7270
steamlayer "C:\Games\Portal 2" --restore
7371
```
7472

73+
> [!IMPORTANT]
74+
> ## Windows Defender
75+
> If real-time protection is on, add a folder exclusion before running:
76+
>
77+
> **Windows Security → Virus & threat protection → Manage settings → Exclusions → Add an exclusion → Folder**
78+
>
79+
> ```
80+
> C:\Users\<you>\.steamlayer\vendors
81+
> ```
82+
> Swapping Steam DLLs looks suspicious enough that Defender will sometimes quarantine Goldberg's or Steamless's files mid-download. The exclusion keeps that from happening. It only covers this one folder, nothing else on your system.
83+
84+
---
85+
7586
### All options
7687
7788
| Flag | Description |
@@ -103,20 +114,6 @@ steamlayer "C:\Games\Portal 2" --restore
103114
104115
---
105116
106-
## Windows Defender
107-
108-
If real-time protection is on, add a folder exclusion before running:
109-
110-
**Windows Security → Virus & threat protection → Manage settings → Exclusions → Add an exclusion → Folder**
111-
112-
```
113-
C:\Users\<you>\.steamlayer\vendors
114-
```
115-
116-
Swapping Steam DLLs looks suspicious enough that Defender will sometimes quarantine Goldberg's or Steamless's files mid-download. The exclusion keeps that from happening. It only covers this one folder, nothing else on your system.
117-
118-
---
119-
120117
## Troubleshooting
121118
122119
**7-Zip bootstrap fails** — steamlayer needs an existing `7z.exe` to pull in its own copy. Make sure it's in `PATH` or installed at the default location (`C:\Program Files\7-Zip\`).

0 commit comments

Comments
 (0)