https://github.com/crayder/sm-model-to-blueprint
A project for converting 3D models to Scrap Mechanic creation blueprints.
https://github.com/crayder/sm-model-to-blueprint
Last synced: 2 months ago
JSON representation
A project for converting 3D models to Scrap Mechanic creation blueprints.
- Host: GitHub
- URL: https://github.com/crayder/sm-model-to-blueprint
- Owner: Crayder
- License: gpl-3.0
- Created: 2024-09-15T15:44:46.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T21:32:07.000Z (8 months ago)
- Last Synced: 2025-01-25T04:49:17.604Z (4 months ago)
- Language: Python
- Size: 163 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Model Scrapper
## Introduction
The **Model Scrapper** is a tool designed to transform 3D models in OBJ format into blueprints compatible with the game **Scrap Mechanic**. It provides a user-friendly interface to customize various aspects of the conversion process, allowing for detailed and accurate imports of custom models into the game.
---
## Features
- **OBJ to Blueprint Conversion**: Converts OBJ files into Scrap Mechanic blueprints.
- **Model Transformation Options**: Scale, offset, and rotate models before conversion.
- **Custom Block Materials and Colors**: Choose specific blocks and colors for your model.
- **Scrap Mechanic Color Palette Support**: Use colors from the game's palette.
- **Interior Filling**: Option to fill the interior of models to make them solid.
- **User-Friendly GUI**: Easy-to-use interface built with Tkinter.
---
## Usage
**Run the Application**:
Each of the modules can be run individually, but the main application is `launcher.py`. Run the following command to start the application:
```bash
python launcher.py
```
---
## Building an Executable
1. **Install PyInstaller**:
```bash
pip install pyinstaller
```
2. **Install Project Dependencies**:
Install the required packages using pip:
```bash
pip install numpy trimesh scipy tqdm
```
3. **Build the Executable**:
Navigate to the project directory and run the following command:
```bash
pyinstaller --onefile --windowed --icon=icon.ico --add-data "blueprint_schematic;blueprint_schematic" --add-data "doc;doc" launcher.py
```
This will create a single executable file in the `dist` directory.