Skip to content

Commit a9fc9ff

Browse files
Added general README
1 parent 1621725 commit a9fc9ff

4 files changed

Lines changed: 77 additions & 0 deletions

File tree

README.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Daz Content Installer
2+
3+
A utility for managing and installing third-party Daz 3D Content. This application helps you keep track of your content library, install new items, and see what you have installed.
4+
5+
## Features
6+
7+
* **Install Content:** Easily install content from compressed archives (`.zip`, `.7z`, etc.).
8+
* **Content Library:** Keeps a database of your installed content for easy management.
9+
* **Status Tracking:** See which archives have been installed.
10+
* **Cross-Platform:** Built with Avalonia, allowing it to run on Windows, macOS, and Linux.
11+
12+
## Screenshots
13+
14+
![UI Overview](/assets/ui.png)
15+
![Library Config](/assets/settings-1.png)
16+
![Settings](/assets/settings-2.png)
17+
18+
## Built With
19+
20+
This project is built with .NET 9 and Avalonia UI. Key dependencies include:
21+
22+
* **[.NET 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)** - The underlying framework.
23+
* **[Avalonia](https://avaloniaui.net/)** - A cross-platform UI framework for .NET.
24+
* **[ReactiveUI](https://reactiveui.net/)** - An MVVM framework for .NET.
25+
* **[Entity Framework Core (SQLite)](https://docs.microsoft.com/en-us/ef/core/)** - For the local database.
26+
* **[SharpSevenZip](https://github.com/JeremyAnsel/SharpSevenZip)** - For handling various archive formats.
27+
28+
## Download & Run
29+
30+
Pre-built releases for Windows are available on the [Releases page](https://github.com/TheSeventhCode/daz-content-installer/releases).
31+
32+
1. **Download**
33+
Go to the [Releases](https://github.com/TheSeventhCode/daz-content-installer/releases) section and download the latest `.zip` file for your system:
34+
- `DazContentInstaller-win-x64.zip` for most modern Windows PCs (64-bit)
35+
- `DazContentInstaller-win-x86.zip` for older 32-bit Windows systems
36+
37+
2. **Extract**
38+
Unzip the downloaded file to a folder of your choice.
39+
40+
3. **Keep files together**
41+
Make sure to keep the extracted files always together, as the application executable depends on those few libraries.
42+
43+
4. **Run**
44+
Double-click `DazContentInstaller.exe` inside the extracted folder to start the application. No installation is required.
45+
46+
> **Note:**
47+
> macOS and Linux users will need to build from source (see the Development section below).
48+
49+
## Archive Compatibility
50+
51+
Not all asset archives will work out of the box. Different people use different ways how they package and distribute their assets. The installer is designed to handle the typical Daz 3D content structure—usually, this means an archive containing a `Content` directory (or similar) with subfolders like `data`, `Runtime`, `People`, etc. Archives following this structure should install easily.
52+
53+
If you encounter an archive that doesn't work as expected, please [create an issue](https://github.com/TheSeventhCode/daz-content-installer/issues) so I can take a look and improve compatibility!
54+
55+
## Development
56+
57+
To build and run this project from source, you will need the .NET 9 SDK installed.
58+
59+
1. **Clone the repository:**
60+
```sh
61+
git clone https://github.com/TheSeventhCode/daz-content-installer.git
62+
cd daz-content-installer
63+
```
64+
65+
2. **Restore dependencies:**
66+
```sh
67+
dotnet restore DazContentInstaller/DazContentInstaller.csproj
68+
```
69+
70+
3. **Run the application:**
71+
```sh
72+
dotnet run --project DazContentInstaller/DazContentInstaller.csproj
73+
```
74+
75+
## License
76+
77+
This project is licensed under the **GNU General Public License v3.0**. See the [LICENSE](LICENSE) file for details.

assets/settings-1.png

24.9 KB
Loading

assets/settings-2.png

18.9 KB
Loading

assets/ui.png

67.6 KB
Loading

0 commit comments

Comments
 (0)