zhangyuheng/ObjToSchematic
1
0
Fork 0
forked from mirror/ObjToSchematic
Code Pull Requests 1 Activity
150 Commits 6 Branches 10 Tags 25 MiB
TypeScript 94.9%
GLSL 2.7%
CSS 1.9%
JavaScript 0.3%
HTML 0.2%
33135e186d
Go to file
Lucas Dower 33135e186d Added ordered dithering and config options
2021-11-19 02:05:59 +00:00
.vscode Added VSCode debugging launch options 2021-11-06 20:32:50 +00:00
resources Updated default-ignore-list.txt, added MSE logging 2021-11-06 20:32:18 +00:00
shaders Added command-line tool to create block atlas 2021-10-13 23:26:26 +01:00
src Added ordered dithering and config options 2021-11-19 02:05:59 +00:00
tools Updated default-ignore-list.txt, added MSE logging 2021-11-06 20:32:18 +00:00
.gitignore Added command-line tool to create block atlas 2021-10-13 23:26:26 +01:00
index.html Minor changes and fixes 2021-10-30 20:42:54 +01:00
LICENSE Added LICENSE 2021-07-01 16:28:23 +01:00
package.json Merge branch 'redesign' into main 2021-10-30 00:52:24 +01:00
README.md Update README.md 2021-11-06 20:38:33 +00:00
styles.css Glass redesign 2021-10-05 00:32:03 +01:00
tsconfig.json Added VSCode debugging launch options 2021-11-06 20:32:50 +00:00

README.md

ObjToSchematic

A tool to convert .obj model files into Minecraft Schematics or Litematica.

Preview

Preview

Usage

You can either download the latest release or build it yourself by following the instructions below.

  • Download and install Node.js.
  • Run git clone https://github.com/LucasDower/ObjToSchematic.git in your command line.
  • Navigate to /ObjToSchematic-main.
  • Run npm install.
  • Run npm start.
  • Note, for now, all .obj models must be triangulated before importing.

Support for choosing the block palette is not yet supported. Instead, you can edit /tools/default-ignore-list.txt to include blocks you don't want to be used and then run npm run-script atlas. You can also place custom textures in /tools/blocks/ for more accurate block-colour matching when building with resource packs.

Progress

0.1

  • ✔️ .json model loading
  • ✔️ Model voxelisation
  • ✔️ Optimised voxelisation & rendering overhaul
  • ✔️ Basic .obj file loader UI

0.2

  • ✔️ Greedy voxel meshing
  • ✔️ Export to schematic

0.3

  • ✔️ Faster voxel splitting
  • ✔️ Ambient occlusion
  • ✔️ Quality of life
    • ✔️ Model PSR, ✔️ height limit warnings
  • ✔️ .mtl support for block choice
    • ✔️ PNG support, ✔️ JPEG support
  • ✔️ Convert to TypeScript

0.4

  • ⌛ Block choice exported
    • ✔️ Export to .litematic
    • Export to .nbt (structure blocks)
  • Alpha support
    • Alpha texture maps
    • Transparent blocks
  • ✔️ Support for non-uniform block models (i.e. not all sides have same texture e.g. Oak Log, Crafting Table)
  • ✔️ UI Redesign
    • Block palette (choose blocks to export with)
    • Options for toggling fallable blocks
  • Buffer refactor to support OES_element_index_uint WebGL extension (support for uint32 index buffers instead of uint16)
  • Dithering

0.5

  • ⌛ Multithreading (see web-workers)
    • Progress bar
  • Node.js C++ addons

0.6

  • Block painting
  • Building guides
  • Slice viewer
  • .fbx import support
  • Support for non-block models (e.g. slabs, stairs, trapdoors, etc.)

Disclaimer

⚠️ This repo is in development and proper error handling is not currently my priority. Contributions are welcome.

This is an non-commercial unofficial tool that is neither approved, endorsed, associated, nor connected to Mojang Studios. Block textures used are from Minecraft and usage complies with the Mojang Studios Brand And Assets Guidelines.

MinecraftPreview

Debugging

To allow for your favourite debugging tools like breakpoints and call stacks, I've included launch options for debugging in VSCode. Use Ctrl+Shift+D, and run "Debug Main Process" and once the Electron window has initialised, run "Attach to Render Process".