0
Commit Graph

118 Commits

Author SHA1 Message Date
Jakub Skorupa
3b0e7f8603 Fix typos and punctuation in documentation 2020-10-06 23:02:11 +02:00
Gijs "Gyzie" Oortgiese
9193b66cdd Clarified overlay transparency instructions (#1619) 2019-08-02 21:06:01 +02:00
Nicolas F
204bcd0310 Add "center" config option
This option allows you to specify your own initial center for a
tileset, which is useful if your map is extremely asymmetric or
you don't really care about what's around the spawn.

Future work needs to be done on the JS side in order to fix the
fromWorldToLatLng and friends, as they're currently off by -24 in X
and +24 in Z direction.

Closes #1350.
2019-07-06 19:06:15 +02:00
Thomas Lake
4b847808eb Update observer import examples for Py3
Based solely on the blog post, not had a chance to double check the usage myself.
2019-06-25 09:15:44 +01:00
Nicolas F
a23682fec8 docs: update optimizeimages instructions for py3 2019-03-21 15:21:43 +01:00
Nicolas F
61ebd35240 Add WebP image format support
Since Firefox 65 added support for WebP, users may be interested
in having maps that use WebP images. Support for this is added in
this commit, along with documentation for it.

A new option, "imglossless", controls whether we write out lossless
or lossy WebP images. The generic name "imglossless" as opposed to
a more specific "webplossless" was chosen in case future image
formats we also implement also support lossless/lossy modes in the
same format (JPEG-XL? AV1 image format?).

It's an okay meme but lossy mode really falls apart on our sorts
of images on the more zoomed out composite tiles, resulting in
pretty blurry messes. Might be due to a PSNR bias in the encoder,
which is to be expected from Google.
2019-03-04 17:04:09 +01:00
Nicolas F
fa1e444890 docs: fix oxipng formatting 2017-03-16 16:44:23 +01:00
Nicolas F
4770af93f7 optimizeimages: add oxipng support 2017-03-16 15:50:02 +01:00
Franz Dietrich
788d90bbf2 Small documentation bug for StructureOverlay.
When adding documentation for the StructureOverlay I missed some
copy and paste error.

fixes #1229
2015-07-03 15:10:54 +02:00
tdierks
0fdd6b70dd Explain ordered nature of renders dict 2015-02-10 20:45:43 -05:00
Aaron Griffith
4eacfa467f Merge remote-tracking branch 'CounterPillow/rcon-observer' 2015-02-01 12:22:34 -05:00
Aaron Griffith
bad4261cb5 Merge remote-tracking branch 'enaut/structure_overlay' 2015-02-01 12:15:56 -05:00
Nicolas F
79e60972e9 optimizeimages: Add documentation for jpegoptim 2014-10-10 21:10:07 +02:00
Nicolas F
16edd622a2 Add documentation for RConObserver 2014-10-06 21:52:21 +02:00
Franz Dietrich
086820ac72 Adding StructureOverlay an overlay to color the map according to structures.
A usecase to demonstrate a possible application of the extended functionality:

**"Rails Overlay that draws only the rails that are on Cobblestone for a subway map."**

With this patch it is very easy to achive that:

```python
MineralOverlay(minerals=[(((0, 0, 0, 66), (0, -1, 0, 4)), (255, 0, 0, 255)),
                         (((0, 0, 0, 27), (0, -1, 0, 4)), (0, 255, 0, 255))])
```

In this case the overlay will be red for rails on cobblestone and green for powerrails on cobblestone.
The syntax is `(<tuple of conditions>, <target color>)`
 * where `<target color>` is a 4 tuple with a `(r, g, b, a)` color
 * and `<tuple of conditions>` is a tuple with an arbitrary number of conditions with the following syntax:
`((relx, rely, relz, blkid), ...)` where the `rel<>` parameters specify the relative coordinates to the block that is checked if it matches bklid.

In the example the fist tuple `(0,0,0,66)` checks if at the current position is a
rail while `(0,-1,0,4)` checks if at one below the current position is a cobblestone.
If both are true then the color `(255, 0, 0, 255)` is used.

A Sample Config file exploiting the capabilities:

``` python
worlds['My World'] = "~/.minecraft/saves/test/"
outputdir = "/tmp/test_render"
rendermode = "lighting"

renders["render1"] = {
    'world': 'My World',
    'title': 'A regular render',
}
renders["render_overlay_dafault_rails"] = {
    'world': 'My World',
    'title': 'Default Rails',
    'rendermode': [ClearBase(), StructureOverlay()],
    'overlay': ['render1'],
}
renders["render_overlay_cust_rails"] = {
    'world': 'My World',
    'title': 'Custom Rails',
    #relative coordinates [[(relx, rely, relz, mineral)], (red, green, blue, alpha)]
    'rendermode': [ClearBase(), StructureOverlay(structures=[(((0, 0, 0, 66), (0, -1, 0, 4)), (255, 0, 0, 255)),
                                                            (((0, 0, 0, 27), (0, -1, 0, 4)), (0, 255, 0, 255))])],
    'overlay': ['render1'],
}
```

The "Default Rails" overlay uses default coloring of the structures overlay. "Custom Rails" uses some custom coloring.

fixes overviewer/Minecraft-Overviewer#556 and fixes overviewer/Minecraft-Overviewer#787
2014-09-03 12:05:11 +02:00
Franz Dietrich
55bbe26916 Fix error in the config.rst file 2014-08-14 10:35:44 +02:00
Aaron Griffith
35863578d7 Merge remote-tracking branch 'matrixhacker/master'
Conflicts:
	docs/config.rst
2014-06-26 05:14:49 -04:00
Nicolas F
57fd1e2ffb config.rst restructuring with new headings
This hopefully makes the page slightly less intimidating.
2014-06-04 12:17:29 +02:00
Nicolas F
192ff4c1a0 Long overdue addition of information to docs
* Add 2 FAQ entries, one concerning mod blocks, the other
    about the maps API.

  * Add note about The End and lighting strength. (Closes #1111)
    (Also, nice quads.)
2014-06-04 11:44:38 +02:00
matrixhacker
bb1c4a7b85 Updated documentation and added an additional validation check for
improperly formatted crop zones.
2014-05-12 14:47:45 -04:00
matrixhacker
b6ac54a2b6 Added the ability to specify multiple crop zones. 2014-05-09 23:44:46 -04:00
CounterPillow
6d28942626 Clarify optimizeimg docs; add warnings
The validator will now warn if it detects that a crushed output
is fed into something that is not a crusher.

The is_crusher method of an optimizer shall return True if the
optimisation process is lossless, and does try to find optimal
encoding parameters as opposed to only removing unneeded channels
or reducing palettes.
2014-05-08 20:56:46 +02:00
Aaron Griffith
4b2cbfb5ee Merge pull request #1074 from CounterPillow/optimizerewrite
Rewrote image optimisation stuff.
2014-05-06 18:25:09 -04:00
Aaron Griffith
7c23d6e86a added rendercheck mode 3, the identity function of rendercheck modes! 2014-05-01 16:48:28 -04:00
Aaron Griffith
a8fc3300b4 general fixes for min/maxzoom, documentation cleared up
hopeful fix for #1086
2014-04-05 20:29:58 -04:00
CounterPillow
09477ed8a0 Rewrote image optimisation stuff.
The old one was broken anyway.
2014-03-04 00:39:59 +01:00
Jeremy Murray
f18008a76d Correct case on observer import example. 2014-02-01 20:04:30 -08:00
Andrew Chin
329b299664 Merge PR #1037 -- ServerAnnounceObserver.update() updates last_update 2013-12-26 23:36:24 -05:00
Andrew Chin
7089eef005 Add a minzoom option
This only affects what's written to overviewerConfig.js.  That is, it
does not change the amount of tiles rendered (it's exactly analogous to
maxzom)

Closes #994
2013-12-26 23:04:20 -05:00
Ean McLaughlin
574c0b0f1d Extend Observers Section
Added sections for MultiplexingObserver and ServerAnnounceObserver.
2013-12-09 23:18:19 -07:00
Andrew Chin
7a1249f1d0 Fix additional typos in docs (thanks tomthorogood) 2013-10-03 18:36:45 -04:00
Tom Thorogood
be0ffa185c Update config.rst
Fix typo in example code that causes error in an actual config file.
2013-09-28 10:55:38 -07:00
Jan Dahl
dcd094bd1b Added clarification on 'northdirection' that it has to do with viewpoint angle 2013-08-25 13:10:24 +02:00
Andrew Brown
66d469c4b8 fixed wording related to texturepath in config docs
Changed to be more accurate with the resource pack changes in minecraft
1.6
2013-07-05 23:55:34 -04:00
Thomas Lake
f4d4c9ff5c Fix reference to stochastic command line option 2013-05-24 20:43:18 +01:00
Nicolas Frattaroli
3986e10af2 Added option showlocationmarker 2013-05-13 15:38:54 +02:00
Andrew Chin
478d44f480 Docs updates for #882 (JSObserver formatting strings) 2013-05-07 21:34:31 -04:00
Andrew Chin
7ae83d014a Fix/improve the --check-terrain option to work with the new texturepacks
Also, updated texturepack-related docs

Related to #907
2013-03-17 12:12:12 -04:00
Andrew Chin
df27633f1a Added an overlay example
See #906
2013-03-15 21:03:58 -04:00
Andrew Chin
2ea1f061ea Stop auto-correcting incorrect slashes. Instead error, and point to our docs.
Also, improve docs slightly to say to *always* use forward slashes

See #906
2013-03-15 20:53:54 -04:00
Nicolas F.
31daa558f9 Fix error in documentation
No parenthesis on the import statement.
2013-03-11 15:29:47 +01:00
Thomas Lake
223b326df1 Add option to configure maxzoom and appropriate documentation 2012-11-28 20:24:29 -05:00
Andrew Chin
dd345980a5 Clarified docs on overlay option
Closes #789
2012-09-22 17:50:23 -04:00
Thomas Lake
c7cb386396 Merge branch 'upstream' into biomesoverlay 2012-08-30 10:16:37 +01:00
Andrew Chin
db6b162c69 Merge branch 'webassets' of git://github.com/tswsl1989/Minecraft-Overviewer into webassets 2012-08-29 19:54:04 -04:00
Thomas Lake
9d43caefaa Add documentation for BiomeOverlay
Have stuck with 'color' as the preferred spelling...
2012-08-23 10:00:20 +01:00
Andrew Chin
e9e9543ba6 Added an example for the MineralOverlay docs
lists of tuples of tuples can be confusing for a non pythoner
2012-08-15 21:05:00 -04:00
Thomas Lake
b7ed14b4a6 Add documentation for customwebassets option 2012-08-12 15:38:08 +01:00
Andrew Chin
68c2f3ee8a Corrected name of blocks option in Hide() docs
Fixes #779
2012-08-03 08:26:04 -04:00
Andrew Chin
cf50d5da46 POI cleanups, js/docs 2012-07-28 20:58:21 -04:00