mirror of
https://github.com/LucasDower/ObjToSchematic.git
synced 2024-12-15 02:59:55 +08:00
Update README.md
This commit is contained in:
parent
24aaa00c7c
commit
a6345a0adf
21
README.md
21
README.md
@ -1,35 +1,48 @@
|
||||
# ObjToSchematic
|
||||
A tool to convert .obj files into Minecraft Schematics
|
||||
|
||||
:warning: This repo is in development and is not ready for use. Contributions are welcome.
|
||||
:warning: This repo is in development and proper error handling is not currently my priority. Contributions are welcome.
|
||||
|
||||
![Preview](/resources/preview.png)
|
||||
|
||||
![MinecraftPreview](/resources/minecraft.png)
|
||||
|
||||
![DebugPreview](/resources/debug_preview.png)
|
||||
|
||||
![MeshingPreview](/resources/greedy_meshing.png)
|
||||
|
||||
![MinecraftPreview](/resources/minecraft.png)
|
||||
|
||||
# Progress
|
||||
0.1
|
||||
[0.1](https://github.com/LucasDower/ObjToSchematic/releases/tag/v0.1-alpha)
|
||||
* ✔️ **.json model loading**
|
||||
* ✔️ **Model voxelisation**
|
||||
* ✔️ **Optimised voxelisation & rendering overhaul**
|
||||
* ✔️ **Basic .obj file loader UI**
|
||||
|
||||
0.2
|
||||
[0.2](https://github.com/LucasDower/ObjToSchematic/releases/tag/v0.2-alpha)
|
||||
* ✔️ **Greedy voxel meshing**
|
||||
* ✔️ **Export to schematic**
|
||||
|
||||
0.3
|
||||
* Multithreading
|
||||
* Quality of life
|
||||
* Model centreing, scaling, and voxel size preview, progress bar
|
||||
|
||||
0.4
|
||||
* .mtl support for block choice
|
||||
* Building guides
|
||||
* Slice viewer
|
||||
|
||||
0.5
|
||||
* .fbx support
|
||||
* Block painting
|
||||
|
||||
# Usage
|
||||
You can either download the [latest release](https://github.com/LucasDower/ObjToSchematic/releases) or build it yourself by following the instructions below.
|
||||
|
||||
* Download and install [Node.js](https://nodejs.org/en/).
|
||||
* Execute `git clone https://github.com/LucasDower/ObjToSchematic.git` in your command line.
|
||||
* Navigate to `/ObjToSchematic-main`.
|
||||
* Run `npm install`.
|
||||
* Run `npm start`.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user