Skip to content

Commit 2354602

Browse files
authored
Update README.md
1 parent f2e82f8 commit 2354602

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,39 @@ This script allows arma 3 preset exports from the launcher to be turned into ID
22

33
Ive also Added an example bat for how you might handle downloading workshop items and saving them under their own IDs in your mod folder.
44

5+
# Arma 3 Mod ID Extractor
56

6-
![alt text](https://raw.githubusercontent.com/AdamWaldie/Arma3ModstingGenerator/refs/heads/main/coverimage.png)
7+
A tool for extracting and sanitizing Arma 3 mod IDs and names from preset `.html` files. This tool ensures compatibility by sanitizing mod names and provides various output options for easy use.
8+
9+
I provide a downloadable Python version, as well as a web app version for ease of use.
10+
11+
## Features
12+
- Extract mod IDs and display names from Arma 3 preset files.
13+
- Sanitize mod names for compatibility with file systems.
14+
- Highlight mods that required sanitization.
15+
- Toggle between mod names or IDs in the output.
16+
- Save the extracted list in various formats (newline, semicolon, or comma-separated).
17+
18+
## Usage
19+
1. **Load File**: Click "Load .html File" and select your Arma 3 preset file.
20+
2. **Configure Options**:
21+
- Include `@` prefix for entries.
22+
- Show mod names or IDs in the output.
23+
- Choose the desired output format (newline, semicolon, or comma-separated).
24+
3. **View Results**:
25+
- Extracted data will appear in the "Extracted Output" section.
26+
- Any sanitized mods will be listed in the "Sanitized Mods" section.
27+
4. **Save List**: Click "Save List" to download the output as a text file.
28+
29+
## Live Web App
30+
[Try the tool here](https://adamwaldie.github.io/Arma3ModstingGenerator/Index)
31+
32+
## Screenshots
33+
### Python Interface
34+
![Main Interface](https://raw.githubusercontent.com/AdamWaldie/Arma3ModstingGenerator/refs/heads/main/coverimage.png)
35+
36+
## Credits
37+
Developed by Waldo.
38+
39+
## License
40+
This project is licensed under the MIT License. See the `LICENSE` file for details.

0 commit comments

Comments
 (0)