Skip to content

Commit 0292bad

Browse files
committed
Add cursor rules for formatting and update license to CC BY-NC-ND 4.0. Adjusted various documentation files to replace em dashes with regular dashes for consistency. Updated CHANGELOG to reflect license change.
1 parent 2dec466 commit 0292bad

21 files changed

Lines changed: 143 additions & 125 deletions

File tree

.cursor-plugin/plugin.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
"name": "steam-cursor-plugin",
33
"displayName": "Steam Developer Tools",
44
"version": "0.2.0",
5-
"description": "Integrates Steam and Steamworks APIs for game developers and power users. 14 skills covering store data, multiplayer networking, cloud saves, leaderboards, input, inventory, social features, profile lookups, and game comparisons plus 3 rules for App ID validation, secrets detection, and Steam Deck compatibility.",
5+
"description": "Integrates Steam and Steamworks APIs for game developers and power users. 14 skills covering store data, multiplayer networking, cloud saves, leaderboards, input, inventory, social features, profile lookups, and game comparisons - plus 3 rules for App ID validation, secrets detection, and Steam Deck compatibility.",
66
"author": {
77
"name": "TMHSDigital",
88
"url": "https://github.com/TMHSDigital"
99
},
1010
"homepage": "https://github.com/TMHSDigital/Steam-Cursor-Plugin",
1111
"repository": "https://github.com/TMHSDigital/Steam-Cursor-Plugin",
12-
"license": "MIT",
12+
"license": "CC-BY-NC-ND-4.0",
1313
"keywords": [
1414
"steam",
1515
"steamworks",

.cursorrules

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Cursor Rules
2+
3+
## Formatting
4+
5+
- Never use em dashes (—). Use a regular dash (-) or rewrite the sentence instead.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3131
- **steam-achievement-designer** skill: design achievements, generate VDF/JSON config snippets, and get unlock code for C++, C#, and GDScript
3232
- **steam-appid-validation** rule: validates App ID consistency across project files and warns if steam_appid.txt is missing
3333
- **steamworks-secrets** rule: prevents committing API keys, partner credentials, and auth tokens
34-
- Plugin manifest, README, CONTRIBUTING guide, and MIT license
34+
- Plugin manifest, README, CONTRIBUTING guide, and license
3535

3636
[0.2.0]: https://github.com/TMHSDigital/Steam-Cursor-Plugin/releases/tag/v0.2.0
3737
[0.1.0]: https://github.com/TMHSDigital/Steam-Cursor-Plugin/releases/tag/v0.1.0

CLAUDE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
66

77
**Steam Developer Tools** is a Cursor IDE plugin (v0.2.0) that integrates Steam and Steamworks APIs for game developers and power users. It provides AI-assisted workflows for querying Steam store data, managing Steamworks configurations, building multiplayer networking, implementing cloud saves, leaderboards, input, inventory/economy, social features, looking up API docs, fetching player statistics, integrating Workshop UGC, designing achievements, looking up player profiles, and comparing games.
88

9-
This is a **static, documentation-only plugin** no build system, no npm, no compiled code. All plugin logic is expressed in Markdown skill files and MDC rule files.
9+
This is a **static, documentation-only plugin** - no build system, no npm, no compiled code. All plugin logic is expressed in Markdown skill files and MDC rule files.
1010

1111
## Plugin Architecture
1212

1313
```
14-
.cursor-plugin/plugin.json Plugin manifest (name, version, skills/rules directory pointers)
15-
skills/<skill-name>/SKILL.md AI workflow definitions (one per skill)
16-
rules/<rule-name>.mdc Code quality and security rules (applied by Cursor AI)
14+
.cursor-plugin/plugin.json - Plugin manifest (name, version, skills/rules directory pointers)
15+
skills/<skill-name>/SKILL.md - AI workflow definitions (one per skill)
16+
rules/<rule-name>.mdc - Code quality and security rules (applied by Cursor AI)
1717
```
1818

1919
### Skills (14 total)
@@ -49,7 +49,7 @@ Each `SKILL.md` uses YAML frontmatter followed by markdown sections: **Trigger**
4949

5050
No build step required. Changes to `skills/` and `rules/` are picked up by Cursor automatically.
5151

52-
**Local testing symlink the plugin directory:**
52+
**Local testing - symlink the plugin directory:**
5353

5454
Windows (PowerShell as Admin):
5555
```powershell
@@ -66,7 +66,7 @@ ln -s "$(pwd)" ~/.cursor/plugins/local/steam-cursor-plugin
6666
- **Skill API names:** `ACH_` prefix, uppercase with underscores (e.g. `ACH_BEAT_FINAL_BOSS`). Stable after release.
6767
- **Depot ID pattern:** `appid + N` (e.g., App ID `2345678` → depots `2345679` (Win), `2345680` (macOS), `2345681` (Linux))
6868
- **Steam API key:** Never hardcode. Use the `STEAM_API_KEY` environment variable or a `.env` file (already in `.gitignore`).
69-
- **App ID `480`** (SpaceWar) is the Steam SDK test app the `steam-appid-validation` rule warns if it appears in production contexts.
69+
- **App ID `480`** (SpaceWar) is the Steam SDK test app - the `steam-appid-validation` rule warns if it appears in production contexts.
7070
- **Secrets rule** flags: 32-char hex strings near "steam"/"api", `*.ssfn` files, `config.vdf`, steamcmd login lines, CEG/DRM keys.
7171

7272
## Steam API Quick Reference

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ rules/ # 3 rule files
5959
---
6060
```
6161
3. Structure the body with these sections:
62-
- **Trigger** when Cursor should load this skill
63-
- **Required Inputs** what the user must provide
64-
- **Workflow** step-by-step instructions for the agent
65-
- **Example Interaction** sample prompt and response
62+
- **Trigger** - when Cursor should load this skill
63+
- **Required Inputs** - what the user must provide
64+
- **Workflow** - step-by-step instructions for the agent
65+
- **Example Interaction** - sample prompt and response
6666

6767
## Adding a Rule
6868

@@ -80,7 +80,7 @@ rules/ # 3 rule files
8080

8181
## Pull Request Process
8282

83-
1. Keep changes focused one skill or rule per PR when possible
83+
1. Keep changes focused - one skill or rule per PR when possible
8484
2. Ensure all frontmatter is valid YAML
8585
3. Test the skill/rule locally in Cursor before submitting
8686
4. Write a clear PR description explaining what the change does and why

LICENSE

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
MIT License
2-
3-
Copyright (c) 2026 TMHSDigital
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International
2+
3+
Copyright (c) 2026 TM Hospitality Strategies
4+
5+
This work is licensed under the Creative Commons
6+
Attribution-NonCommercial-NoDerivatives 4.0 International License.
7+
8+
You are free to:
9+
10+
Share - copy and redistribute the material in any medium or format.
11+
12+
The licensor cannot revoke these freedoms as long as you follow the
13+
license terms.
14+
15+
Under the following terms:
16+
17+
Attribution - You must give appropriate credit, provide a link to the
18+
license, and indicate if changes were made. You may do so in any
19+
reasonable manner, but not in any way that suggests the licensor
20+
endorses you or your use.
21+
22+
NonCommercial - You may not use the material for commercial purposes.
23+
24+
NoDerivatives - If you remix, transform, or build upon the material,
25+
you may not distribute the modified material.
26+
27+
No additional restrictions - You may not apply legal terms or
28+
technological measures that legally restrict others from doing
29+
anything the license permits.
30+
31+
Full license text:
32+
https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode
33+
34+
SPDX-License-Identifier: CC-BY-NC-ND-4.0

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
<h1 align="center">Steam Developer Tools</h1>
66

77
<p align="center">
8-
<em>Steam &amp; Steamworks integration for Cursor IDE &mdash; built for game developers and power users.</em>
8+
<em>Steam &amp; Steamworks integration for Cursor IDE - built for game developers and power users.</em>
99
</p>
1010

1111
<p align="center">
12-
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
12+
<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>
1313
<a href="CHANGELOG.md"><img src="https://img.shields.io/badge/version-0.2.0-green.svg" alt="Version"></a>
1414
<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>
1515
<a href="https://github.com/TMHSDigital/Steam-Cursor-Plugin/commits/main"><img src="https://img.shields.io/github/last-commit/TMHSDigital/Steam-Cursor-Plugin" alt="Last Commit"></a>
@@ -19,7 +19,7 @@
1919

2020
---
2121

22-
Query Steam store data, manage Steamworks app configurations, build multiplayer networking, implement cloud saves, design achievements, compare games, and look up player profiles &mdash; all from within Cursor's AI chat. 14 skills and 3 rules covering the full Steam &amp; Steamworks ecosystem.
22+
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 3 rules covering the full Steam &amp; Steamworks ecosystem.
2323

2424
> **No API key required** for most features. Store lookups, player counts, global achievement stats, and app searches all work out of the box.
2525
@@ -41,8 +41,8 @@ Query Steam store data, manage Steamworks app configurations, build multiplayer
4141
| **Steam Friends & Social** | Integrate friends list, rich presence, game invites, Steam Overlay, and avatar/persona retrieval into your game. |
4242
| **Steam Input / Controllers** | Set up Steam Input with action sets, digital/analog bindings, and controller glyph retrieval for Xbox, PlayStation, Switch, and Steam Deck. |
4343
| **Steam Inventory & Economy** | Implement item systems, drops, crafting, the Steam Item Store, and in-game purchases via ISteamInventory and ISteamMicroTxn. |
44-
| **Steam Profile Lookup** | Look up any Steam user's public profile games, playtime, level, badges, friends, and recent activity. |
45-
| **Steam Game Comparison** | Compare two or more Steam games side by side price, reviews, player counts, genres, and platforms in a formatted table. |
44+
| **Steam Profile Lookup** | Look up any Steam user's public profile - games, playtime, level, badges, friends, and recent activity. |
45+
| **Steam Game Comparison** | Compare two or more Steam games side by side - price, reviews, player counts, genres, and platforms in a formatted table. |
4646

4747
### Rules
4848

@@ -55,8 +55,8 @@ Query Steam store data, manage Steamworks app configurations, build multiplayer
5555
## Quick Start
5656

5757
1. **Install** the plugin from the Cursor marketplace (or [manually](#manual-installation))
58-
2. **Ask** Cursor anything about Steam &mdash; try: `What's the current price for Hades?`
59-
3. **Get results** &mdash; the plugin fetches live data from Steam's public APIs and formats it for you
58+
2. **Ask** Cursor anything about Steam - try: `What's the current price for Hades?`
59+
3. **Get results** - the plugin fetches live data from Steam's public APIs and formats it for you
6060

6161
That's it. No configuration needed for basic usage.
6262

@@ -252,7 +252,7 @@ What are my most played games on Steam?
252252
### Game Comparison
253253

254254
```
255-
Compare Hades, Dead Cells, and Hollow Knight price, reviews, and current players.
255+
Compare Hades, Dead Cells, and Hollow Knight - price, reviews, and current players.
256256
```
257257

258258
```
@@ -303,8 +303,8 @@ These work immediately without any API key:
303303
## Roadmap
304304

305305
- [ ] Steam MCP server for live, structured API calls
306-
- [x] ~~Steam Deck compatibility checker~~ &mdash; added in v0.2.0 as a rule
307-
- [x] ~~Steamworks SDK code generation~~ &mdash; covered by multiplayer, cloud, leaderboard, input, and inventory skills
306+
- [x] ~~Steam Deck compatibility checker~~ - added in v0.2.0 as a rule
307+
- [x] ~~Steamworks SDK code generation~~ - covered by multiplayer, cloud, leaderboard, input, and inventory skills
308308
- [ ] Steam review sentiment analysis skill
309309
- [ ] Steam sale / price history tracking
310310
- [ ] SteamVR integration skill
@@ -315,7 +315,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute skill
315315

316316
## License
317317

318-
MIT &mdash; see [LICENSE](LICENSE) for details.
318+
CC BY-NC-ND 4.0 - see [LICENSE](LICENSE) for details.
319319

320320
<details>
321321
<summary><strong>Steam API Reference Links</strong></summary>

rules/steam-deck-compat.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ When editing or reviewing game project files, watch for these common Steam Deck
3333
## Anti-Cheat
3434

3535
6. **Anti-cheat compatibility.** If the project references EasyAntiCheat (EAC), BattlEye, or other anti-cheat systems, note:
36-
- EAC and BattlEye both support Proton/Linux but it must be explicitly enabled in the Steamworks Partner site
36+
- EAC and BattlEye both support Proton/Linux - but it must be explicitly enabled in the Steamworks Partner site
3737
- Kernel-level anti-cheat will NOT work under Proton
3838
- Provide link: https://partner.steamgames.com/doc/steamdeck/proton
3939

rules/steamworks-secrets.mdc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ When reviewing, creating, or editing files, watch for these sensitive patterns a
99

1010
## Patterns to Flag
1111

12-
1. **Steam Web API keys** 32-character hexadecimal strings typically assigned to variables like:
12+
1. **Steam Web API keys** - 32-character hexadecimal strings typically assigned to variables like:
1313
- `STEAM_API_KEY`, `STEAM_WEB_API_KEY`, `steamApiKey`, `steam_key`
1414
- Any 32-char hex string near the word "steam" or "api"
1515

skills/steam-achievement-designer/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Use this skill when the user:
1717

1818
## Required Inputs
1919

20-
- **Achievement list** at minimum, names and descriptions for each achievement
21-
- **App ID** the game's Steam App ID (for code examples)
20+
- **Achievement list** - at minimum, names and descriptions for each achievement
21+
- **App ID** - the game's Steam App ID (for code examples)
2222

2323
## Workflow
2424

@@ -38,7 +38,7 @@ For each achievement, define these fields:
3838
### 2. Naming Conventions
3939

4040
- API names: `ACH_` prefix, uppercase, underscores. E.g., `ACH_COLLECT_ALL_ITEMS`
41-
- Keep API names stable changing them after release breaks existing unlock data
41+
- Keep API names stable - changing them after release breaks existing unlock data
4242
- Display names: title case, concise (under 64 characters)
4343
- Descriptions: one sentence, under 128 characters, describe the unlock condition
4444

0 commit comments

Comments
 (0)