|
9 | 9 | </p> |
10 | 10 |
|
11 | 11 | <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> |
12 | 13 | <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> |
13 | 14 | <a href="CHANGELOG.md"><img src="https://img.shields.io/badge/version-0.2.0-green.svg" alt="Version"></a> |
14 | 15 | <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 | 21 |
|
21 | 22 | --- |
22 | 23 |
|
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 & 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> • <strong>4 rules</strong> • <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 & Steamworks ecosystem with live data via the companion [Steam MCP Server](https://github.com/TMHSDigital/steam-mcp). |
24 | 29 |
|
25 | 30 | > **No API key required** for most features. Store lookups, player counts, global achievement stats, and app searches all work out of the box. |
26 | 31 |
|
| 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 | + |
27 | 47 | ## Features |
28 | 48 |
|
29 | 49 | ### Skills |
@@ -127,174 +147,93 @@ ln -s "$(pwd)/Steam-Cursor-Plugin" ~/.cursor/plugins/local/steam-cursor-plugin |
127 | 147 |
|
128 | 148 | Once installed, the plugin's skills are available in Cursor's AI chat. Just ask naturally. |
129 | 149 |
|
130 | | ---- |
131 | | - |
132 | | -### Store Lookup |
133 | | - |
134 | 150 | ``` |
135 | 151 | What's the current price and review score for Hollow Knight? |
136 | 152 | ``` |
137 | 153 |
|
138 | 154 | ``` |
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? |
148 | 156 | ``` |
149 | 157 |
|
150 | 158 | ``` |
151 | | -How do I configure DLC depots in Steamworks? |
| 159 | +Compare Hades, Dead Cells, and Hollow Knight - price, reviews, and current players. |
152 | 160 | ``` |
153 | 161 |
|
154 | | ---- |
155 | | - |
156 | | -### API Reference |
| 162 | +<details> |
| 163 | +<summary><strong>More examples (all 14 skills)</strong></summary> |
157 | 164 |
|
| 165 | +**Store Lookup** |
158 | 166 | ``` |
159 | | -How do I get a list of achievements from the Steam API? |
| 167 | +Look up Steam App ID 1245620 |
160 | 168 | ``` |
161 | 169 |
|
| 170 | +**Steamworks Configuration** |
162 | 171 | ``` |
163 | | -What parameters does ISteamUserStats/GetUserStatsForGame accept? |
| 172 | +Set up Steam build configs for my game. App ID is 2345678, Windows and Linux only. |
164 | 173 | ``` |
165 | 174 |
|
166 | | ---- |
167 | | - |
168 | | -### Player Stats |
169 | | - |
| 175 | +**API Reference** |
170 | 176 | ``` |
171 | | -How many people are playing Elden Ring right now? |
| 177 | +What parameters does ISteamUserStats/GetUserStatsForGame accept? |
172 | 178 | ``` |
173 | 179 |
|
| 180 | +**Player Stats** |
174 | 181 | ``` |
175 | 182 | What are the rarest achievements in Celeste? |
176 | 183 | ``` |
177 | 184 |
|
178 | | ---- |
179 | | - |
180 | | -### Workshop |
181 | | - |
| 185 | +**Workshop** |
182 | 186 | ``` |
183 | 187 | I want to add Workshop support to my Unity game. How do I handle uploads and downloads? |
184 | 188 | ``` |
185 | 189 |
|
186 | | -``` |
187 | | -Get details for Workshop item 1234567890 |
188 | | -``` |
189 | | - |
190 | | ---- |
191 | | - |
192 | | -### Achievement Design |
193 | | - |
| 190 | +**Achievement Design** |
194 | 191 | ``` |
195 | 192 | I need achievements for my platformer. Milestones: complete tutorial, beat each world, collect all coins, speedrun under 2 hours. |
196 | 193 | ``` |
197 | 194 |
|
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** |
206 | 196 | ``` |
207 | 197 | How do I set up Steam lobbies for a 4-player co-op game? |
208 | 198 | ``` |
209 | 199 |
|
210 | | -``` |
211 | | -Show me Steam Networking Sockets setup for P2P relay connections. |
212 | | -``` |
213 | | - |
214 | | ---- |
215 | | - |
216 | | -### Cloud Saves |
217 | | - |
| 200 | +**Cloud Saves** |
218 | 201 | ``` |
219 | 202 | I want to add cloud saves to my roguelike. I have a single save file in AppData/Local. |
220 | 203 | ``` |
221 | 204 |
|
222 | | -``` |
223 | | -Help me configure Auto-Cloud for cross-platform save syncing. |
224 | | -``` |
225 | | - |
226 | | ---- |
227 | | - |
228 | | -### Leaderboards |
229 | | - |
| 205 | +**Leaderboards** |
230 | 206 | ``` |
231 | 207 | My speedrun game needs a leaderboard for each level. Times in ms, lower is better. |
232 | 208 | ``` |
233 | 209 |
|
234 | | -``` |
235 | | -How do I download and display friends-only leaderboard entries? |
236 | | -``` |
237 | | - |
238 | | ---- |
239 | | - |
240 | | -### Friends & Social |
241 | | - |
| 210 | +**Friends & Social** |
242 | 211 | ``` |
243 | 212 | I want to show "Playing as [Character] on [Map]" in the Steam friends list. |
244 | 213 | ``` |
245 | 214 |
|
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** |
254 | 216 | ``` |
255 | 217 | My platformer has move, jump, dash, and pause. Set up Steam Input for Xbox and Steam Deck. |
256 | 218 | ``` |
257 | 219 |
|
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** |
266 | 221 | ``` |
267 | 222 | I want cosmetic hat drops every 2 hours of playtime, plus a Steam Item Store for direct purchases. |
268 | 223 | ``` |
269 | 224 |
|
270 | | -``` |
271 | | -Walk me through the ISteamMicroTxn InitTxn/FinalizeTxn flow. |
272 | | -``` |
273 | | - |
274 | | ---- |
275 | | - |
276 | | -### Profile Lookup |
277 | | - |
| 225 | +**Profile Lookup** |
278 | 226 | ``` |
279 | 227 | Look up the Steam profile for vanity URL "gaben" |
280 | 228 | ``` |
281 | 229 |
|
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** |
294 | 231 | ``` |
295 | 232 | Compare App IDs 570 and 730 side by side. |
296 | 233 | ``` |
297 | 234 |
|
| 235 | +</details> |
| 236 | + |
298 | 237 | ## Configuration |
299 | 238 |
|
300 | 239 | ### Steam API Key |
|
0 commit comments