Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aleksilassila/litematica-printer
An extension for Litematica that adds the missing printer functionality for 1.19, 1.18 and 1.17
https://github.com/aleksilassila/litematica-printer
fabric java minecraft minecraft-mod
Last synced: 26 days ago
JSON representation
An extension for Litematica that adds the missing printer functionality for 1.19, 1.18 and 1.17
- Host: GitHub
- URL: https://github.com/aleksilassila/litematica-printer
- Owner: aleksilassila
- License: agpl-3.0
- Created: 2020-10-04T09:37:24.000Z (about 4 years ago)
- Default Branch: printing
- Last Pushed: 2024-07-02T19:21:14.000Z (4 months ago)
- Last Synced: 2024-09-30T08:20:42.554Z (about 1 month ago)
- Topics: fabric, java, minecraft, minecraft-mod
- Language: Java
- Homepage:
- Size: 6.55 MB
- Stars: 303
- Watchers: 6
- Forks: 74
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Litematica Printer
This extension adds printing functionality for [Litematica fabric](https://github.com/maruohon/litematica) 1.20, 1.19, 1.18
and
1.17 versions. Printer allows players to build
big structures more quickly by automatically placing the correct blocks around you.
## Installation
1. Download and install [Fabric](https://fabricmc.net/use/installer/) if you haven't already.
2. Download the latest Litematica Printer release for your Minecraft version from the
[releases page](https://github.com/aleksilassila/litematica-printer/releases) (The files can be found under
"assets").
3. Download [Litematica + MaLiLib](https://www.curseforge.com/minecraft/mc-mods/litematica)
and [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api/) (≠ Fabric).
4. Place the downloaded .jar files in your `mods/` folder.
[If this is the first fabric mod you are installing, here's an informative video on how to install Fabric mods.](https://www.youtube.com/watch?v=x7gmfib4gHg)
## How To Use
Using the printer is straightforward: You can toggle the feature by pressing `CAPS_LOCK` by default. To configure
variables such as
printing speed and range, open Litematica's settings by pressing `M + C` and navigate to "Generic" tab. Printer's
configuration can be
found at the bottom of the page. You can also rebind the printing toggle under "Hotkeys" tab. Holding down `V` by
default will also
print regardless if the printer is toggled on or off.
## Issues
If you have issues with the printer, **do not** bother the original creator of
Litematica (maruohon) with them. Contact me instead. Feature requests or bugs can
be reported via [GitHub issues](https://github.com/aleksilassila/litematica-printer/issues),
or in [Discord](https://discord.gg/enypPQh6pz). I'll try to keep a todo list of things
I'm planning to implement and fix, so please look for duplicates there first.
Before creating an issue, make sure you are using the latest version of the mod.
To make fixing bugs easier, include the following information in your issue:
- Minecraft version
- Litematica version
- Printer version
- Detailed description of how to reproduce the issue
- If you can, any additional information, such as error logs, screenshots or **the incorrectly printed schematics**.
### List of know issues
Currently, the following features are still broken or missing:
- Placing liquids (printing **in** liquids works though)
- Printing without support directly in air (printInAir)
- Current algorithm for placing rails isn't perfect,
sometimes it can't place all the rails (to avoid placing anything incorrectly).
- Legit mode? (for anticheats)
Also, I have decided that features that fix existing builds,
such as automatic excavation or correcting incorrectly placed blocks are out of the scope of this mod.
## Building and Contributing
Each Minecraft version has its own submodule, that has the default fabric mod development tasks
and contains the version-specific code. To reduce the amount of work I have to do to make
it work for multiple Minecraft versions, I created this hacky gradle script that copies the
common code over to the other version implementations. Currently, the script copies everything,
except `implementation/` folder, which should therefore be the only places containing any
version specific code.
If you want to make changes to the mod, I would recommend you to first implement them for
the latest Minecraft version (1.19), and then running the `syncImplementations` gradle task,
found **in the same subproject** as your changes, to copy the common code of that submodule
to the other implementations. After that you will only have to write / copy manually
the version-specific code (found in the `implementation` folder) to the other versions and do some testing to ensure
everything works.
Contributions are welcome and appreciated! I have recently rewritten the whole project,
so that it would be much easier to work with.
Also, if you know a better way to develop for multiple
Minecraft versions that doesn't involve multiple git branches or hacky gradle scripts
(perhaps a way to share common code between the implementations?), please let me know.
Useful gradle tasks:
- `[v1_19/v1_18/v1_17]:syncImplementations`
- Copy over common code to other implementations
- `buildAll`
- Build all implementations and copy their jars to `build/` directory for easy distribution.
- `[v1_19/v1_18/v1_17]:runClient`
- Start the target Minecraft version