Skip to content

Commit 05e37bc

Browse files
committed
Add CI badge to README, enhance documentation with a new "How It Works" section, and introduce CODEOWNERS and workflows for link checking, release drafting, and stale issue management.
1 parent 34e3705 commit 05e37bc

6 files changed

Lines changed: 186 additions & 105 deletions

File tree

.github/CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Default owner for all files
2+
* @TMHSDigital

.github/release-drafter.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
template: |
4+
## What's Changed
5+
6+
$CHANGES
7+
8+
**Full Changelog**: https://github.com/TMHSDigital/Steam-Cursor-Plugin/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
9+
10+
categories:
11+
- title: New Skills
12+
labels:
13+
- skill
14+
- title: New Rules
15+
labels:
16+
- rule
17+
- title: Enhancements
18+
labels:
19+
- enhancement
20+
- title: Bug Fixes
21+
labels:
22+
- bug
23+
- title: Documentation
24+
labels:
25+
- documentation
26+
- title: Maintenance
27+
labels:
28+
- maintenance
29+
- dependencies
30+
31+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
32+
change-title-escapes: '\<*_&'
33+
no-changes-template: 'No changes since last release.'
34+
35+
version-resolver:
36+
major:
37+
labels:
38+
- major
39+
minor:
40+
labels:
41+
- minor
42+
- skill
43+
- rule
44+
patch:
45+
labels:
46+
- patch
47+
- bug
48+
- documentation
49+
- maintenance
50+
default: patch

.github/workflows/links.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Check Links
2+
3+
on:
4+
schedule:
5+
- cron: '0 12 1 * *' # First of every month at noon UTC
6+
push:
7+
branches: [main]
8+
paths:
9+
- '**.md'
10+
- '**.mdc'
11+
workflow_dispatch:
12+
13+
jobs:
14+
check-links:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Link Checker
20+
uses: lycheeverse/lychee-action@v2
21+
with:
22+
args: >
23+
--verbose
24+
--no-progress
25+
--accept 200,204,301,302,403,429
26+
--exclude-mail
27+
--exclude "steamcommunity.com/dev/apikey"
28+
--exclude "partner.steam-api.com"
29+
--exclude "store.steampowered.com/app/"
30+
--exclude "api.steampowered.com"
31+
"**/*.md"
32+
"**/*.mdc"
33+
fail: false
34+
env:
35+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request_target:
7+
types: [opened, reopened, synchronize]
8+
9+
permissions:
10+
contents: read
11+
pull-requests: write
12+
13+
jobs:
14+
update_release_draft:
15+
permissions:
16+
contents: write
17+
pull-requests: write
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: release-drafter/release-drafter@v6
21+
env:
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/stale.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Stale Issues and PRs
2+
3+
on:
4+
schedule:
5+
- cron: '0 9 * * 1' # Every Monday at 9 AM UTC
6+
workflow_dispatch:
7+
8+
permissions:
9+
issues: write
10+
pull-requests: write
11+
12+
jobs:
13+
stale:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/stale@v9
17+
with:
18+
stale-issue-message: >
19+
This issue has been automatically marked as stale because it has not had
20+
recent activity. It will be closed in 14 days if no further activity occurs.
21+
If this is still relevant, please leave a comment.
22+
stale-pr-message: >
23+
This pull request has been automatically marked as stale because it has not had
24+
recent activity. It will be closed in 14 days if no further activity occurs.
25+
close-issue-message: >
26+
This issue was closed because it has been stale for 14 days with no activity.
27+
Feel free to reopen if this is still relevant.
28+
days-before-stale: 30
29+
days-before-close: 14
30+
stale-issue-label: stale
31+
stale-pr-label: stale
32+
exempt-issue-labels: pinned,security,roadmap
33+
exempt-pr-labels: pinned

README.md

Lines changed: 44 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
</p>
1010

1111
<p align="center">
12+
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/actions/workflows/validate.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Steam-Cursor-Plugin/validate.yml?label=CI" alt="CI"></a>
1213
<a href="LICENSE"><img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-blue.svg" alt="License: CC BY-NC-ND 4.0"></a>
1314
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/version-0.2.0-green.svg" alt="Version"></a>
1415
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/stargazers"><img src="https://img.shields.io/github/stars/TMHSDigital/Steam-Cursor-Plugin?style=flat" alt="GitHub Stars"></a>
@@ -20,10 +21,29 @@
2021

2122
---
2223

23-
Query Steam store data, manage Steamworks app configurations, build multiplayer networking, implement cloud saves, design achievements, compare games, and look up player profiles - all from within Cursor's AI chat. 14 skills and 4 rules covering the full Steam &amp; Steamworks ecosystem, with 10 live MCP tools via the companion [Steam MCP Server](https://github.com/TMHSDigital/steam-mcp).
24+
<p align="center">
25+
<strong>14 skills</strong> &nbsp;&bull;&nbsp; <strong>4 rules</strong> &nbsp;&bull;&nbsp; <strong>10 MCP tools</strong>
26+
</p>
27+
28+
Query Steam store data, manage Steamworks app configurations, build multiplayer networking, implement cloud saves, design achievements, compare games, and look up player profiles - all from within Cursor's AI chat. Covers the full Steam &amp; Steamworks ecosystem with live data via the companion [Steam MCP Server](https://github.com/TMHSDigital/steam-mcp).
2429

2530
> **No API key required** for most features. Store lookups, player counts, global achievement stats, and app searches all work out of the box.
2631
32+
## How It Works
33+
34+
```mermaid
35+
flowchart LR
36+
A["You ask Cursor\na Steam question"] --> B["Cursor loads\na Skill"]
37+
B --> C{"MCP server\navailable?"}
38+
C -- Yes --> D["Steam MCP Server\n(10 tools)"]
39+
C -- No --> E["curl to\nSteam Web API"]
40+
D --> F["Steam API"]
41+
E --> F
42+
F --> G["Formatted answer\nin Cursor chat"]
43+
```
44+
45+
**Skills** teach Cursor how to handle Steam-related prompts. **Rules** enforce best practices in your game project files. The **MCP server** provides live, structured API access so skills can fetch real data instead of relying on shell commands.
46+
2747
## Features
2848

2949
### Skills
@@ -127,174 +147,93 @@ ln -s "$(pwd)/Steam-Cursor-Plugin" ~/.cursor/plugins/local/steam-cursor-plugin
127147

128148
Once installed, the plugin's skills are available in Cursor's AI chat. Just ask naturally.
129149

130-
---
131-
132-
### Store Lookup
133-
134150
```
135151
What's the current price and review score for Hollow Knight?
136152
```
137153

138154
```
139-
Look up Steam App ID 1245620
140-
```
141-
142-
---
143-
144-
### Steamworks Configuration
145-
146-
```
147-
Set up Steam build configs for my game. App ID is 2345678, Windows and Linux only.
155+
How many people are playing Elden Ring right now?
148156
```
149157

150158
```
151-
How do I configure DLC depots in Steamworks?
159+
Compare Hades, Dead Cells, and Hollow Knight - price, reviews, and current players.
152160
```
153161

154-
---
155-
156-
### API Reference
162+
<details>
163+
<summary><strong>More examples (all 14 skills)</strong></summary>
157164

165+
**Store Lookup**
158166
```
159-
How do I get a list of achievements from the Steam API?
167+
Look up Steam App ID 1245620
160168
```
161169

170+
**Steamworks Configuration**
162171
```
163-
What parameters does ISteamUserStats/GetUserStatsForGame accept?
172+
Set up Steam build configs for my game. App ID is 2345678, Windows and Linux only.
164173
```
165174

166-
---
167-
168-
### Player Stats
169-
175+
**API Reference**
170176
```
171-
How many people are playing Elden Ring right now?
177+
What parameters does ISteamUserStats/GetUserStatsForGame accept?
172178
```
173179

180+
**Player Stats**
174181
```
175182
What are the rarest achievements in Celeste?
176183
```
177184

178-
---
179-
180-
### Workshop
181-
185+
**Workshop**
182186
```
183187
I want to add Workshop support to my Unity game. How do I handle uploads and downloads?
184188
```
185189

186-
```
187-
Get details for Workshop item 1234567890
188-
```
189-
190-
---
191-
192-
### Achievement Design
193-
190+
**Achievement Design**
194191
```
195192
I need achievements for my platformer. Milestones: complete tutorial, beat each world, collect all coins, speedrun under 2 hours.
196193
```
197194

198-
```
199-
Generate a VDF achievement config for my game with these achievements: [list]
200-
```
201-
202-
---
203-
204-
### Multiplayer Networking
205-
195+
**Multiplayer Networking**
206196
```
207197
How do I set up Steam lobbies for a 4-player co-op game?
208198
```
209199

210-
```
211-
Show me Steam Networking Sockets setup for P2P relay connections.
212-
```
213-
214-
---
215-
216-
### Cloud Saves
217-
200+
**Cloud Saves**
218201
```
219202
I want to add cloud saves to my roguelike. I have a single save file in AppData/Local.
220203
```
221204

222-
```
223-
Help me configure Auto-Cloud for cross-platform save syncing.
224-
```
225-
226-
---
227-
228-
### Leaderboards
229-
205+
**Leaderboards**
230206
```
231207
My speedrun game needs a leaderboard for each level. Times in ms, lower is better.
232208
```
233209

234-
```
235-
How do I download and display friends-only leaderboard entries?
236-
```
237-
238-
---
239-
240-
### Friends & Social
241-
210+
**Friends & Social**
242211
```
243212
I want to show "Playing as [Character] on [Map]" in the Steam friends list.
244213
```
245214

246-
```
247-
How do I send game invites to friends from within my game?
248-
```
249-
250-
---
251-
252-
### Controllers & Steam Deck Input
253-
215+
**Controllers & Steam Deck Input**
254216
```
255217
My platformer has move, jump, dash, and pause. Set up Steam Input for Xbox and Steam Deck.
256218
```
257219

258-
```
259-
How do I show the correct button glyphs for whichever controller the player is using?
260-
```
261-
262-
---
263-
264-
### Inventory & Economy
265-
220+
**Inventory & Economy**
266221
```
267222
I want cosmetic hat drops every 2 hours of playtime, plus a Steam Item Store for direct purchases.
268223
```
269224

270-
```
271-
Walk me through the ISteamMicroTxn InitTxn/FinalizeTxn flow.
272-
```
273-
274-
---
275-
276-
### Profile Lookup
277-
225+
**Profile Lookup**
278226
```
279227
Look up the Steam profile for vanity URL "gaben"
280228
```
281229

282-
```
283-
What are my most played games on Steam?
284-
```
285-
286-
---
287-
288-
### Game Comparison
289-
290-
```
291-
Compare Hades, Dead Cells, and Hollow Knight - price, reviews, and current players.
292-
```
293-
230+
**Game Comparison**
294231
```
295232
Compare App IDs 570 and 730 side by side.
296233
```
297234

235+
</details>
236+
298237
## Configuration
299238

300239
### Steam API Key

0 commit comments

Comments
 (0)