Xeno_Open_Source/XSchem
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add license and readme

Browse Source
This commit is contained in:
Roni Lehto 2021-08-21 16:52:09 +03:00
parent 48f1b43d28
commit 4f3772febf
2 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

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

29
README.md Normal file
View File

@ -0,0 +1,29 @@
XSchem is a tool for converting [Prismarine](https://github.com/PrismarineJS/prismarine-schematic)
compatible schematics into a fairly simple JSON format, e.g. for quick and dirty placement of small buildings or other creations in a plugin.
## Output JSON format
The output JSON is an array of arrays containing key-value-like pairs of blockdata and relative block positions:
```
[
[blockdata, [x0,y0,z0, x1,y1,z1, x2,y2,z2, ...]],
[blockdata, [ ... ]]
]
```
The `blockdata` is a setblock compatible string, for example
* `spruce_wood[axis="y"]`
* `oak_leaves[persistent="false",distance="4"]`
The coordinate array has all of the relative coordinates of this block,
listed in groups of three (so the array must have a length divisible by three).
If a certain block should be placed at e.g.
the relative positions `(x1, y1, z1)` and `(x2, y2, z2)`,
the coordinates would be presented in the array as `[x1,y1,z1, x2,y2,z2]` and so on.
This format stores no information about the size
or the original position of the schematic, so,
its sole meaning is to be a quick and dirty way to store small creations,
e.g. schematics of trees.
## License
This repository is licensed under the MIT license.