Metadata-Version: 2.1
Name: scsarchive
Version: 1.0.6
Summary: A Python archive format plugin for creating uncompressed SCS (Euro Truck Simulator 2 mod) archives.
Author-email: Allie Nikol Modern <a.modern.freelancing@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/Lil-Allie-Astra/scsarchive
Project-URL: Bug Tracker, https://github.com/Lil-Allie-Astra/scsarchive/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE

# scsarchive

[![PyPI version](https://img.shields.io/pypi/v/scsarchive.svg?color=green&cache-bust=3)](https://pypi.org/project/scsarchive/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Versions](https://img.shields.io/pypi/pyversions/scsarchive)](https://pypi.org/project/scsarchive/)

`scsarchive` is a simple Python utility that registers the `.scs` archive format — an uncompressed `.zip` format used by Euro Truck Simulator 2 and American Truck Simulator mods.

## 🚀 Features

- Register `.scs` as a custom archive format for use with Python's standard `shutil` module.
- Automatically writes `.scs` files as uncompressed `.zip` archives, fully compatible with SCS Software's games.
- Clean, reusable module for integration into modding tools or automation scripts.

## 📦 Installation

```bash
pip install scsarchive
```

## 🛠️ Usage

```python
import scsarchive
from scsarchive import make_scs
make_scs(base_name, root_dir, base_dir)
```

### 🧼 Optional Functions

```python
scsarchive.register_scs_format()
scsarchive.unregister_scs_format()
```

---

## 🌟 Why I Made This

I wanted a more efficient way to update my ETS2 mods without having to 

1. manually zip the directory,
2. set the name and compression,
3. rename from ".zip" to ".scs" after creation,
4. delete the old one in my mods directory,
5. copy and paste from my working directory to my mods directory...

EVERY. TIME.

No more nonesense.

There is now an easier way.

---

## ⚖️ License

```plaintext
MIT License

Copyright (c) 2025 Allie Nikol Modern

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

---

Made with 💖 by ~ Allie ~
