Skip to content

Commit

Permalink
Improve the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
leMaik committed Apr 10, 2020
1 parent d413328 commit bd2714a
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 28 deletions.
136 changes: 108 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,97 @@
# Chunky
<p align="center">
<a href="https://material-ui.com/" rel="noopener" target="_blank"><img width="100" src="https://raw.githubusercontent.com/llbit/chunky-docs/master/images/logo.png" alt="Chunky logo"></a>
</p>
<h1 align="center">Chunky</h1>
<div align="center">

Chunky is a Minecraft mapping and rendering tool.
Chunky is a Minecraft rendering tool that uses Path Tracing to create realistic images of your Minecraft worlds.

Quick links:
[Discord server](https://discord.gg/VqcHpsF) ·
[Documentation][8] ·
[Troubleshooting][2] ·
[Subreddit][3]
</div>

* [![Join our Discord server!](https://raw.githubusercontent.com/llbit/chunky/master/misc/discord.png)](https://discord.gg/VqcHpsF)
* [Documentation][1]
* [Troubleshooting][2]
* [Subreddit][3]
* [Development Blog][4]

## Quick start guide

## Copyright & License
_Prerequisites:_ Chunky requires Java 8. If you haven't installed it yet, [get it from here][13]. Make sure that you have installed the 64-bit version if you have a 64-bit operating system (you most likely do).

Chunky is Copyright (c) 2010-2017, Jesper Öqvist <[email protected]>
1. Download [the Chunky Launcher][12] and open it
2. Install the latest version of Chunky by clicking on _Check for Updates_
3. Click on _Launch Chunky_ start rendering your beautiful buildings

Permission to modify and redistribute is granted under the terms of
the GPLv3 license. See the file `LICENSE` for the full license.
If you have any questions, please don't hesitate to reach out via Reddit, Discord or GitHub.

Chunky uses the following 3rd party libraries:
## Frequently Asked Questions

* **Markdown by John Gruber.**
Markdown is covered by the Modified BSD License.
See the file `licenses/Markdown.txt` for the full license and copyright notice.
* **Apache Commons Math library by the Apache Software Foundation.**
The library is covered by the Apache License, version 2.0.
See the file `licenses/Apache-2.0.txt` for the full license text.
See the file `licenses/commons-math.txt` for the copyright notices.
<details>
<summary>Why is there noise/grain/random bright dots in the render?</summary>

This is not a bug, but an unfortunate effect of [the rendering algorithm][9] used in Chunky. Torches and other small light sources cause a very random illumination and it takes a long time to render such light nicely.


You can disable emitters under the Lighting tab in the Render Controls dialog to remove most of the random bright dots. Note that rendering for a longer time will eventually remove the noise, though it may take a very long time.

Another way of removing the noise is using the [Denoiser Plugin][10]. While this can yield good results in most cases, it may distort the image in some cases.
</details>

<details>
<summary>How long does it take to render an image?</summary>

This depends on your CPU, the size of the image and the lighting conditions of the scene you are rendering. You can use the tips from the previous answer to get away with shorter render times.
</details>

<details>
<summary>Why do I see blue question marks or red crosses instead of blocks?</summary>

Chunky renders blue question marks for unsupported blocks. Maybe your Chunky version is outdated or the block is not yet supported. If the latter is the case, please file a bug report.

Red crosses are caused by missing textures. Please ensure that you're using a texturepack for the Minecraft version for the world you are rendering.
</details>

<details>
<summary>Why can I only open 1.12 worlds but not 1.13+ worlds (or vice versa)?</summary>

Minecraft 1.13 introduced a new world format that is incompatible with the old format. Chunky 2 is only compatible with the new world format and Chunky 1 is only compatible with the old world format.

We [have plans][14] to improve this one day. For now, you'll need to use the appropriate Chunky version for your Minecraft version.
</details>

<details>
<summary>Is GPU rendering supported?</summary>

GPU support is not actively being worked on right now. If you'd like to tackle this, PRs are welcome!
</details>

<details>
<summary>Why are mobs not rendered?</summary>

## Launching Chunky
Chunky currently can't render all entities. Future support for rendering more entities is planned, so stay tuned!
</details>

<details>
<summary>Can Chunky render mod blocks?</summary>

No. Due to the vast number of mods, this is not feasible at the moment.
</details>

<details>
<summary>Where can I find good skymaps?</summary>

The [skymaps page][11] has some good links. Another good place is the #skymaps channel on our Discord server.
</details>

<details>
<summary>Chunky keeps freezing or crashing</summary>

Chunky uses a lot of memory. If Chunky has too little memory to work with it
may slow down to a crawl or crash. The memory limit can be increased in the
Chunky Launcher.
</details>


## Rendering using the command line (Headless Mode)
<details>
<summary>Rendering using the command line (Headless Mode)</summary>

It is possible to render a scene from the command line. First set up a scene
using the GUI. Don't forget to save the scene. Then run the following on the
Expand All @@ -47,9 +102,10 @@ command line:

Where SceneName is the name of the scene to render. You can read more about
[headless rendering here.][5]
</details>


## Shutdown when render completes on Unix-like Systems (Mac OS X, Linux, BSD)
<details>
<summary>Shutdown when render completes on Unix-like Systems (Mac OS X, Linux, BSD)</summary>

In the Advanced tab of the Render Controls window, you can check the checkbox
that says "Shutdown when render completes" to shut down your computer when the
Expand All @@ -75,6 +131,10 @@ You may need to restart or log out and in for this to take effect.

This will only allow `sudo shutdown` to run without a password; no other
commands run with `sudo` will be affected.
</details>

More information about Chunky, including a short getting started guide and
rendering tips are available at the [Chunky Documentation page][1]. For more insights into Chunky's development, see the [development blog][4].


## Hacking on Chunky
Expand Down Expand Up @@ -106,10 +166,23 @@ your code look similar to the rest of the code, and refer to the style guide
when in doubt.


## Additional Information
## Copyright & License

Chunky is Copyright (c) 2010-2019, Jesper Öqvist <[email protected]>

Permission to modify and redistribute is granted under the terms of
the GPLv3 license. See the file `LICENSE` for the full license.

Chunky uses the following 3rd party libraries:

* **Markdown by John Gruber.**
Markdown is covered by the Modified BSD License.
See the file `licenses/Markdown.txt` for the full license and copyright notice.
* **Apache Commons Math library by the Apache Software Foundation.**
The library is covered by the Apache License, version 2.0.
See the file `licenses/Apache-2.0.txt` for the full license text.
See the file `licenses/commons-math.txt` for the copyright notices.

More information about Chunky, including a short getting started guide and
rendering tips are available at the [Chunky Documentation page.][1]

[1]: http://chunky.llbit.se
[2]: http://chunky.llbit.se/troubleshooting.html
Expand All @@ -118,3 +191,10 @@ rendering tips are available at the [Chunky Documentation page.][1]
[5]: http://chunky.llbit.se/headless.html
[6]: https://google.github.io/styleguide/javaguide.html
[7]: https://github.com/llbit/chunky-releasetools
[8]: https://lemaik.github.io/chunky/
[9]: https://chunky.llbit.se/path_tracing.html
[10]: https://github.com/leMaik/chunky-denoiser
[11]: https://chunky.llbit.se/skymaps.html
[12]: http://chunkyupdate.lemaik.de/ChunkyLauncher.jar
[13]: https://java.com/download/
[14]: https://github.com/llbit/chunky/issues/553
Binary file removed misc/discord.png
Binary file not shown.
Binary file added misc/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bd2714a

Please sign in to comment.