Skip to content

Commit 2584c9b

Browse files
CopilotVen0m0
andauthored
Add comprehensive documentation infrastructure and standardize repository structure (#21)
* Initial plan * docs: Add comprehensive documentation (CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, READMEs) Co-authored-by: Ven0m0 <[email protected]> * docs: Improve and standardize existing README files, remove obsolete TODO Co-authored-by: Ven0m0 <[email protected]> * docs: Complete documentation overhaul - improve READMEs, add EXAMPLES.md, enhance Links.md Co-authored-by: Ven0m0 <[email protected]> * docs: Update main README with complete documentation links Co-authored-by: Ven0m0 <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: Ven0m0 <[email protected]>
1 parent cb5dcdc commit 2584c9b

File tree

23 files changed

+4713
-43
lines changed

23 files changed

+4713
-43
lines changed

.github/README.md

Lines changed: 165 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,180 @@
1-
### Collection of Scripts, that may be useful in automating daily tasks, or just assist you otherwise. Autohotkey is required for every script.
1+
# Scripts - Windows Gaming & Automation Toolkit
22

3-
![GitHub Release](https://img.shields.io/github/v/release/Ven0m0/Scripts?label=Current%20Release)
4-
![GitHub Downloads](https://img.shields.io/github/downloads/Ven0m0/Scripts/total?logo=github&label=GitHub%20Downloads)
5-
![Commit activity](https://img.shields.io/github/last-commit/Ven0m0/Scripts?logo=github)
3+
> **Comprehensive AutoHotkey automation suite for Windows gaming, emulation, and productivity**
64
7-
<a style="text-decoration:none" href="http://www.Autohotkey.com/">
8-
<img height="42" src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQDPJ-OzynAXca5NgC4EGafO0g90Ydl013YEQ&s" alt="AHK">
9-
</a>
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![GitHub Release](https://img.shields.io/github/v/release/Ven0m0/Scripts?label=Current%20Release)](https://github.com/Ven0m0/Scripts/releases)
7+
[![GitHub Downloads](https://img.shields.io/github/downloads/Ven0m0/Scripts/total?logo=github&label=GitHub%20Downloads)](https://github.com/Ven0m0/Scripts/releases)
8+
[![Commit activity](https://img.shields.io/github/last-commit/Ven0m0/Scripts?logo=github)](https://github.com/Ven0m0/Scripts/commits)
9+
10+
---
11+
12+
## Quick Links
13+
14+
- **[Main README](../README.md)** - Full project documentation
15+
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute
16+
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history
17+
- **[CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)** - Community guidelines
18+
19+
---
20+
21+
## Featured Tools
22+
23+
### 🎮 Gaming & Emulation
1024

11-
### [Youtube and Spotify downloader:](Other/Downloader)
25+
#### [YouTube & Spotify Downloader](../Other/Downloader/)
1226

13-
<a style="text-decoration:none" href="Other/Downloader">
14-
<img src="Other/Downloader/Downloader.avif" alt="Windows10">
27+
<a href="../Other/Downloader/">
28+
<img src="../Other/Downloader/Downloader.avif" alt="Downloader GUI" width="600">
1529
</a>
1630

17-
### [Citra mod manager:](Other/Citra_mods)
31+
GUI-based media downloaders for YouTube videos/audio and Spotify playlists/tracks.
1832

19-
<a style="text-decoration:none" href="Other/Citra_mods">
20-
<img src="Other/Citra_mods/Citra_Mod_Manager.avif">
33+
**Features:**
34+
- Download videos or extract audio from YouTube
35+
- Download songs from Spotify playlists
36+
- Quality selection and format conversion
37+
- User-friendly GUI interface
38+
39+
[View Documentation →](../Other/Downloader/README.md)
40+
41+
---
42+
43+
#### [Citra Mod Manager](../Other/Citra_mods/)
44+
45+
<a href="../Other/Citra_mods/">
46+
<img src="../Other/Citra_mods/Citra_Mod_Manager.avif" alt="Citra Mod Manager" width="600">
2147
</a>
2248

23-
### [Playnite auto Fullscreen](Other/Playnite_fullscreen)
49+
GUI for managing mods and HD texture packs for Citra 3DS emulator.
50+
51+
**Features:**
52+
- Enable/disable mods per game
53+
- HD texture pack management
54+
- CSV-based game database
55+
- Per-game settings
56+
57+
[View Documentation →](../Other/Citra_mods/README.md)
58+
59+
---
60+
61+
### 🖥️ Window Management
62+
63+
#### [Borderless Fullscreen](../AHK_v2/Fullscreen.ahk)
64+
65+
Toggle borderless fullscreen on any window with multi-monitor support.
66+
67+
**Features:**
68+
- Multi-monitor aware
69+
- Saves and restores window state
70+
- Works with games lacking native borderless mode
71+
72+
---
73+
74+
#### [Auto-Fullscreen Manager](../Other/AutoStartManager.ahk)
75+
76+
Unified data-driven auto-fullscreen launcher for all major emulators.
77+
78+
**Supported Emulators:**
79+
- Citra, Yuzu, Ryujinx
80+
- RPCS4, PCSX2
81+
- Dolphin, Cemu
82+
- And 10+ more!
83+
84+
---
85+
86+
### 🛠️ System Utilities
87+
88+
#### [Power Plan Automation](../AHK_v2/Powerplan.ahk)
89+
90+
Automatically switch Windows power plan based on running applications.
91+
92+
#### [Controller Quit](../AHK_v2/ControllerQuit.ahk)
93+
94+
Close applications using gamepad button combinations.
95+
96+
#### [GUI Launchers](../AHK_v2/GUI/)
97+
98+
Centralized script launchers with graphical interface for easy management.
99+
100+
---
101+
102+
## Additional Tools
103+
104+
### [Playnite Auto-Fullscreen](../Other/Playnite_fullscreen_v2/)
105+
106+
Multi-monitor setup automation for Playnite with boot videos.
107+
108+
### [Citra Per-Game Config](../Other/Citra_per_game_config/)
109+
110+
Automatically apply per-game configuration settings to Citra emulator.
111+
112+
### [7zEmuPrepper](../Other/7zEmuPrepper/)
113+
114+
On-the-fly game decompression for emulation front-ends.
115+
116+
### [Robocopy Utilities](../Other/Robocopy/)
117+
118+
Batch script wrappers for Windows Robocopy with extension filtering.
119+
120+
---
121+
122+
## Project Statistics
123+
124+
- **61+ AutoHotkey scripts** (v1 and v2)
125+
- **45+ scripts migrated** to AutoHotkey v2
126+
- **15+ emulators supported** for auto-fullscreen
127+
- **Dual library architecture** for v1/v2 compatibility
128+
- **MIT Licensed** - Free and open source
129+
130+
---
131+
132+
## Quick Start
133+
134+
1. **Install AutoHotkey**
135+
- [AutoHotkey v2.0.19+](https://www.autohotkey.com/) for modern scripts
136+
- [AutoHotkey v1.1.37.02+](https://www.autohotkey.com/download/) for legacy scripts
137+
138+
2. **Clone the repository**
139+
```bash
140+
git clone https://github.com/Ven0m0/Scripts.git
141+
cd Scripts
142+
```
143+
144+
3. **Run any script**
145+
- Double-click `.ahk` files
146+
- Or run from command line: `autohotkey script.ahk`
147+
148+
---
149+
150+
## Documentation
151+
152+
- **[README.md](../README.md)** - Main project documentation
153+
- **[CLAUDE.md](../CLAUDE.md)** - Comprehensive developer guide (1700+ lines)
154+
- **[EXAMPLES.md](../EXAMPLES.md)** - Common usage patterns and examples
155+
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Contribution guidelines
156+
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history
157+
158+
---
159+
160+
## CI/CD & Workflows
161+
162+
This directory contains GitHub Actions workflows for:
163+
164+
- **Code Quality** - Syntax validation and formatting checks
165+
- **Automated Builds** - Compilation of .exe releases
166+
- **Version Detection** - Automatic v1/v2 script detection
24167

25-
### [Citra per game auto config](Other/Citra_per_game_config)
168+
See [workflows/](workflows/) for workflow definitions.
26169

27-
### Fake Fullscreen:
170+
---
28171

29-
Simple scripts to set the current window to fullscreen, similar to fullscreen borderless
172+
## Support
30173

31-
[Fullscreen](AHK/Fullscreen.ahk)
174+
- **Issues:** [GitHub Issues](https://github.com/Ven0m0/Scripts/issues)
175+
- **Email:** [email protected]
176+
- **License:** MIT
32177

33-
[Fullscreen Single Key](AHK/Fullscreen_single.ahk)
178+
---
34179

35-
[Fullscreen Double Key](AHK/Fullscreen_double.ahk)
180+
**⭐ Star this repository if you find it useful!**

0 commit comments

Comments
 (0)