dsts-extractor 0.8.1__tar.gz

dsts_extractor-0.8.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nuffle
+
+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.

dsts_extractor-0.8.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: dsts-extractor
+Version: 0.8.1
+Summary: Extract Digimon Story: Time Stranger chr models to FBX + GLB.
+License: MIT
+Requires-Python: >=3.12
+License-File: LICENSE
+Requires-Dist: click==8.1.7
+Requires-Dist: numpy>=1.24
+Requires-Dist: Pillow>=11.0
+Requires-Dist: texture2ddecoder>=1.0
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: lz4>=4.0
+Provides-Extra: optimize
+Requires-Dist: dsts-extractor-gltfpack<2,>=1.2; extra == "optimize"
+Provides-Extra: dev
+Requires-Dist: pytest==8.3.3; extra == "dev"
+Requires-Dist: pyright==1.1.389; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: license-file

dsts_extractor-0.8.1/README.md

@@ -0,0 +1,151 @@
+# dsts-extractor
+
+A fan-made command-line tool for extracting models from **Digimon Story: Time Stranger**.
+
+This project aims to to provide a streamlined way to export game-accurate digimon and NPC models from DSTS that you can drop into your own fan projects and start using them quickly, no manual tweaks or adjustments required.
+
+This is the tool used to extract the models shown in [dsts-viewer](https://nuffle.me/dsts-viewer/) ([source](https://tangled.sh/nuffle.me/dsts-viewer)). Models will not be made available for direct download from that site. Instead, use this tool to extract the same models from your own copy of the game.
+
+## Requirements
+
+- Python 3.12 or later ([Python setup guide](https://realpython.com/installing-python/))
+- Your own Steam installation of [Digimon Story: Time Stranger](https://store.steampowered.com/app/1984270/Digimon_Story_Time_Stranger/)
+- At least ~15 GB additional free disk space to unpack game files
+- (Optional) Blender 4.x if you want to extract models as `.fbx` files
+
+## Quick start
+
+1. `pip install dsts-extractor` - Install the tool with pip
+2. `dsts setup` - First-time setup (unpack game files to prepare for extraction)
+3. `dsts list` - List all models available for extraction
+4. `dsts export renamon` - Extract `renamon.glb` to the current directory
+
+If you get stuck, try:
+
+* Reading the full instructions below
+* Running `dsts setup` again to try and fix any install path or game file errors
+* Running `dsts --help` (or just `dsts`) for a list of commands
+* Running `dsts export --help`, `dsts list --help`, etc. for options that work with a specific command
+
+## Installation
+
+```bash
+# Install the core tool
+pip install dsts-extractor
+
+# (Optional) Install extra binaries if you want to `--optimize` your models (smaller file size)
+pip install dsts-extractor[optimize]
+```
+
+## First-time setup
+
+`dsts setup` finds the Steam install and unpacks everything the exporter needs, straight from the game's own archives. This command configures some default paths for working with game files and will ask you to confirm or override them, including:
+
+- Your DSTS Steam installation path
+- An output directory for unpacked game files
+- Your Blender installation path (optional)
+
+Once confirmed, the command reads the game's `.mvgl` archives and unpacks them to the specified folder. The files must be unpacked before models can be extracted. If you update your game, add DLC, or update this tool, you may need to run setup again to unpack new files.
+
+By default, the command grabs just the model data that it needs, which is about 14.5 GB. Choose the **full unpack** option if you want the entire game archive extracted (~41 GB, which includes maps, audio, and UI) if you want it for additional modding work.
+
+You can re-run `dsts setup` again anytime to walk through the process, which will verify these setup paths and allow you to change them.
+
+## CLI Usage
+
+### Listing available models
+
+```bash
+# List models available for export
+dsts list         # List all models
+dsts list agu     # List all models with name containing 'agu'
+dsts list --filter=digimon   # Only list in-battle digimon, not npcs/bosses/etc.
+```
+
+#### Options
+
+| Option | Values | Description |
+| --- | --- | --- |
+| `--filter` | `digimon`, `npc`, `boss` | Limit results to a specific model type |
+| `--format` | `table` (default), `list`, `raw` | Output format. `table` is human-readable; `list` prints one model name per line; `raw` prints all model names space-separated on a single line (both are handy for scripting). |
+
+### Exporting models
+
+By default, models are exported as self-contained `.glb` files (glTF 2.0 standard) with all meshes and materials intact. You should be able to load them into Blender or a standard model viewer of your choice and begin working with them.
+
+> **NOTE:** This tool does not guarantee that models can be re-imported back into DSTS without significant work. Support for this may be added in the future, but for now be wary of using models directly for modding DSTS.
+
+```bash
+# Export one model
+# Outputs to current dir: renamon.glb
+dsts export renamon
+dsts export chr391                # Outputs renamon by model name: chr391.glb
+dsts export renamon --optimized   # Output with reduced file size, recommended in most cases
+
+# Export multiple models
+# Outputs models to current dir: guilmon.glb, growlmon.glb, wargrowlmon.glb
+dsts export guilmon growlmon wargrowlmon
+
+# Bulk export models, supports same args as `dsts list`
+dsts export-all agu
+dsts export-all --filter=digimon
+```
+
+#### Options
+
+| Option | Values | Description |
+| --- | --- | --- |
+| `--format` | `glb` (default), `fbx` | Output format for exported models (`fbx` requires Blender) |
+| `--optimized` | flag (off by default) | Reduce file size at a small cost to accuracy (see [Optimization](#optimization)) |
+| `-o`, `--out-dir` | directory (default: current dir) | Where to write the model files (the directory must already exist) |
+
+#### Optimization
+
+Passing `--optimized` runs the exported `.glb` through [gltfpack](https://github.com/zeux/meshoptimizer/tree/master/gltf) (meshopt compression). This compresses vertex data from 32-bit precision to 16-bit precision, which reduces model size by about 30% on average. Textures are unaffected. It's recommended for most uses, especially loading models on the web. Leave it off if you want the exact, full-precision export, e.g. for detailed editing in Blender.
+
+`--optimized` needs the `gltfpack` tool. The simplest way to get it is the optional extra, which bundles a prebuilt binary:
+
+```bash
+pip install 'dsts-extractor[optimize]'
+```
+
+The resolution order for the gltfpack dependency is:
+
+1. If gltfpack is found on your PATH, it will use that.
+2. Otherwise, if `dsts-extractor[optimize]` is installed, it will use that.
+3. Otherwise, if Node.js is installed, it will attempt to install gltfpack through npm and use that.
+
+### Inspecting game files
+
+You can use this command
+
+```bash
+# Output: table summary about model's bones, meshes, textures, shaders, etc.
+dsts inspect terriermon
+
+# Supports multiple models as well
+dsts inspect lucemon lucemon-sm lucemon-cm
+```
+
+#### Options
+
+| Option | Values | Description |
+| --- | --- | --- |
+| `--format` | `table` (default), `csv` | Output format of the inspect summary (`csv` for machine parsing) |
+
+## Shaders
+
+DSTS features distinctive cel shaders which do a lot of the heavy lifting in making the models appear anime-like in game. These shaders are **not bundled** with model exports because they require a lot of data about the game's live scenes in order to run properly. So you can't just drop them into a modeling program and expect them to look exactly like they do in-game. The easiest path to getting them looking good in your own fan project is to apply a general toon shader to the models in your scene and tweak it until it looks the way you want.
+
+However, each `.glb` model does include lots of canonical, game-extracted data (like shader uniforms) in the `extras.dsts` section that you can use to drive your own shaders (like how bright a light emission should be, or animation timing information for special effects). This tool's companion project, [dsts-viewer](https://nuffle.me/dsts-viewer/), uses custom shaders that have been reverse-engineered from DSTS itself and uses this model data to drive them. See [data/dsts_extras.schema.json](./data/dsts_extras.schema.json) for details on the available fields.
+
+> **Experimental:** If you want to replicate the dsts-viewer look, you can now download the body cel shader code as GLSL directly from the viewer site (Settings icon -> Cel shaders -> Download) and adapt them to your own project.
+
+## Contributions & feedback
+
+* Suggestions and bug reports welcome as issues
+* Code contributions welcome through pull requests
+* Contact me directly at:
+  * [@nuffle.me on Bluesky](https://bsky.app/profile/nuffle.me)
+  * [@dolphinspired on Discord](https://discord.com/users/263732939815256064)
+  * More links at [nuffle.me](https://nuffle.me/)!

dsts_extractor-0.8.1/pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "dsts-extractor"
+version = "0.8.1"
+description = "Extract Digimon Story: Time Stranger chr models to FBX + GLB."
+license = { text = "MIT" }
+# The CLI + core modules target 3.12+, but modules imported inside Blender's
+# stdlib-only Python 3.11 (blender_import.py and everything it imports —
+# geom, anim, anim_sharing, effects, eyes, extras, nlst, dxbc, paths) must
+# stay 3.11-syntax-safe.
+requires-python = ">=3.12"
+dependencies = [
+    "click==8.1.7",
+    "numpy>=1.24",
+    "Pillow>=11.0",
+    "texture2ddecoder>=1.0",
+    "platformdirs>=4.0",
+    "lz4>=4.0",
+]
+
+[project.optional-dependencies]
+# Node-free `--optimized`: the companion package bundles a prebuilt gltfpack
+# binary (platform wheel). Version tracks the bundled gltfpack version.
+optimize = ["dsts-extractor-gltfpack>=1.2,<2"]
+dev = [
+    "pytest==8.3.3",
+    "pyright==1.1.389",
+    "build",
+]
+
+[project.scripts]
+dsts-extractor = "dsts_extractor.cli:main"
+dsts = "dsts_extractor.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["dsts_extractor*"]
+exclude = ["dsts_extractor.tests*"]
+
+[tool.setuptools.package-data]
+"dsts_extractor" = ["assets/*.png", "data/*.json"]
+
+[tool.pytest.ini_options]
+testpaths = ["src/dsts_extractor/tests"]

dsts_extractor-0.8.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dsts_extractor-0.8.1/src/dsts_extractor/__main__.py

@@ -0,0 +1,4 @@
+from dsts_extractor.cli import main
+
+if __name__ == "__main__":
+    main()