Skip to content

Commit d6067f2

Browse files
authored
updating readme
Making less lame
1 parent a4f73bb commit d6067f2

1 file changed

Lines changed: 25 additions & 82 deletions

File tree

README.md

Lines changed: 25 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -2,116 +2,59 @@
22

33
Welcome to sorzkode's mIRC Scripts Archive - a comprehensive preservation project dedicated to collecting / documenting mIRC scripts.
44

5-
## 🏛️ Purpose
5+
## Stats
6+
- Original scrape: ~3,000 files
7+
- Corrupted (removed): 1,800+
8+
- Scrape window: 1996–2008
9+
- Sources documented: Hawkee.com (complete), others ongoing
10+
> Recognize a script or know its original author? Open a [pull request](https://github.com/sorzkode/mirc_scripts_archive/pulls).
611
7-
To preserve mIRC scripting history and culture. By hosting these files on GitHub, my hope is that they can live on for many more years.
12+
## Purpose
813

9-
## 🤔 But Why?
14+
To preserve mIRC scripting history and culture.
15+
16+
## But Why?
1017

1118
Because scripting was my introduction to programming and I believe this is the case for a lot of coders from my generation. Oh, and because nostalgia is one helluva drug.
1219

13-
## 📰 Background
20+
## Background
1421

1522
In the 90s and early 2000s, when [IRC](https://en.wikipedia.org/wiki/Wikipedia:IRC) was really booming, [mIRC](https://en.wikipedia.org/wiki/MIRC) was the popular chat client. mIRC allowed users to customize / modify their experience by using the [mIRC scripting language (mSL)](https://en.wikipedia.org/wiki/MIRC_scripting_language). This was so popular that there were websites dedicated to hosting these user-built scripts. Now, many of those sites no longer exist (see links below for some that do). However, [The Internet Archive](https://archive.org) indexed many of those sites and some of the files can still be found.
1623

17-
## ⛏️ Methodology
18-
19-
1. Used a Python script to leverage the Internet Archive's CDX (Canonical URL and Timestamp) API to download any available .zip files from the given sites. The original scrape was for the years of 1996-2008 only.
20-
2. Used a script to delete many corrupted folders - original scrape count was nearly 3,000 files but over 1,800 were corrupted.
21-
3. Used a script to extract .zip file information and script information to auto generate README files for each script. This isn't perfect and requires some manual verification in the outputted json files. After verification, I can automate creating the readme files. I have completed this for all hawkee files.
22-
23-
## 📝 Archive Status
24-
25-
### Current State
26-
27-
- **Collection Phase**: ✅ Complete (CDX API scraping finished)
28-
- **Processing Phase**: ✅ Complete (files sorted)
29-
- **Web UI**: ✅ Published @ [Scriptserv.com](https://scriptserv.com)
30-
- **Documentation Phase**: 📝 Ongoing (individual script READMEs)
31-
32-
### Future Plans
33-
34-
1. **Testing**: Manually test scripts in a sandbox environment
35-
2. **Updated documentation**: After testing, include screenshots / demos and notes
36-
37-
### 🕸️ Sources
24+
## Methodology
3825

39-
-**Hawkee.com** [Hawekee Wiki Entry](https://sorzkode.com/wiki/index.php?title=Hawkee.com)
40-
- 📝 **xcalibre.com**
41-
- 📝 **paIRC.com**
42-
- 📝 **Other**
43-
- 📝 **mIRCX.com**
44-
- 📝 **mIRCScripts.org**
45-
- 📝 **mIRC.net**
46-
- 📝 **kegdoctors archive**
47-
- 📝 **IRC-Scripts.com**
26+
I used Python to leverage the Internet Archive's CDX (Canonical URL and Timestamp) API to download any available .zip files from the given mIRC scripting sites. After scraping, I used additional scripts to delete corrupted folders and to extract .zip and script information into JSON files. Those JSON files are manually verified and then used to auto-generate README files for each script. Hawkee files are fully processed; the rest are in progress.
4827

49-
## ⚠️ Universal Disclaimers
28+
### TODO
5029

51-
**Please read carefully before exploring this archive:**
30+
There's many files that need readme and metadata updates. I have started working on a more streamlined pipeline that will hopefully help with this process. Additionally, I've added hundreds of new scripts (locally) to the project and will push all those when the updates are finished (no idea when).
5231

53-
- **I am not the original author** of any scripts in this archive unless explicitly stated
54-
- **Historical Preservation Only**: All content is archived for educational and historical purposes
55-
- **No Support Provided**: I cannot provide support, updates, or fixes for any archived scripts
56-
- **Not Thoroughly Tested**: Scripts have not been tested in modern environments (unless otherwise stated)
57-
- **Use at Your Own Risk**: Any use of these scripts is entirely at your own discretion
58-
- **Legacy Software**: Scripts were designed for much older versions of mIRC and Windows
59-
- **Potential Security Risks**: Some scripts may contain outdated security practices or features
60-
- **Educational Value**: This archive primarily serves researchers, historians, and those interested in IRC culture
32+
In the meantime, see [Contributing](#Contributing) to help out.
6133

62-
## 🗂️ Repository Structure
34+
## Disclaimers
35+
The files contained here may set off your virus detection. Most of these will be false-positives but some may be actual viruses. Also, don't expect many of the scripts to run in modern environments. I would recommend running them in a virtual environment for Windows XP.
6336

64-
```
65-
mirc_scripts_archive/
66-
├── README.md (this file)
67-
├── somewebsite/
68-
│ ├── README.md
69-
│ ├── script_name_1/
70-
│ │ ├── README.md
71-
│ │ └── script files...
72-
```
37+
## Contributing
7338

74-
## 🤝 Contributing to the Archive
75-
76-
### What I'm Looking For
77-
78-
- Historic mIRC scripts (.mrc, .als, .ini files)
79-
- Original documentation and help files
80-
- Screenshots and usage examples
81-
- Historical information about scripts and authors
82-
- Website backups and archives
83-
- Memories and stories / logs
84-
- Links
85-
86-
### How to Contribute
87-
88-
- Via GitHub
39+
**Via GitHub**
8940

9041
1. **Fork this repository**
9142
2. **Add your materials** following the established structure
9243
3. **Create proper documentation** using the README templates
9344
4. **Submit a pull request** with details about the contribution
9445
5. **Provide historical context** when possible
9546

96-
- VIA Website
47+
**VIA Website**
9748

9849
1. [Contact](https://scriptserv.com/contact.html)
9950
2. [Guestbook](https://scriptserv.com/guestbook.html)
10051
3. [Add Links](https://scriptserv.com/links.html) (via +Add button)
10152
4. [Contribute](https://scriptserv.com/) - Select a script and click the "Contribute" button
10253

103-
### Contribution Guidelines
104-
105-
- Include proper attribution to original authors
106-
- Provide historical context and dating when known
107-
- Use the established folder and documentation structure
108-
- Include disclaimers about testing and compatibility
109-
- Respect copyright and intellectual property rights
110-
111-
## 📜 License
112-
113-
This archive operates under the principle of fair use for historical preservation and educational purposes. Individual scripts retain their original copyrights. See individual script folders for specific licensing information when available.
54+
Looking for: historic .mrc / .als / .ini files, original docs and help files, screenshots, author info, website backups, logs, stories, and links.
11455

11556
---
57+
## Other Archival Projects
58+
[hxcmp3.com Music Archive](https://github.com/sorzkode/hxcmp3)
11659

117-
**"IRC 4 Lyfe"**
60+
*"IRC 4 Lyfe"*

0 commit comments

Comments
 (0)