0
Commit Graph

272 Commits

Author SHA1 Message Date
Nicolas F
ba5a4bbaed docs: add link to Twitter account to index.rst 2017-03-24 14:40:54 +01:00
Nicolas F
f9148b7e2e docs: Change some http:// URLs to https:// 2017-03-24 14:35:05 +01:00
Nicolas F
d11c9b5aa2 docs: remove remaining references to CentOS 5 2017-03-24 14:30:22 +01:00
Nicolas F
b393489ea9 docs: remove CentOS 5 build instructions
It's EOL in a few days and the instructions only add confusion.
Anyone still using CentOS 5 has bigger issues than not having
documentation on how to build Minecraft-Overviewer.
2017-03-17 17:09:35 +01:00
Nicolas F
99b223fb5a Merge pull request #1356 from overviewer/python2
Replace `python` with `python2`
2017-03-17 16:54:25 +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
Andrew Chin
faa8d8f75c Replace python with python2
A continuation of c7d86eca76
2016-12-24 14:43:52 -05:00
Andrew Chin
5fecdf7477 Some minor changes based on github comment feedback 2016-12-24 14:37:47 -05:00
Andrew Chin
0801791cab Merge PR #1343 2016-12-24 14:33:24 -05:00
Nicolas F
54b93754c7 genPOI/docs: Handle new sign id values
Minecraft now uses minecraft:sign as its id for signs, but also uses
Sign for older versions or chunks that have not yet been updated.

Change the genPOI sign wrangling code and the documentation to reflect
this change.

Fixes #1340.
2016-12-06 15:17:39 +01:00
Mark Vander Stel
d92f00d97d Update strings and items to 1.11
Update all strings and vars to 1.11.
Add new items and blocks to items.py.
2016-11-29 09:13:42 -05:00
Andrew Chin
67b6c4fd65 Updating linux build docs
Include some small text that clarifies how to run overviewer after a `build` step
2016-11-22 11:24:22 -05:00
manuelgu
5862b34e9e Update text for 1.10 2016-08-09 11:59:58 +02:00
Nicolas F
a4b6651072 Update docs version and copyright year 2016-06-30 09:09:58 +02:00
Nicolas F
917e38fd53 Make command line option docs more complete
Mainly, the genPOI options were finally documented.
2016-06-30 09:07:13 +02:00
Nicolas F
0d7731b125 Update client jar version in documentation 2016-06-30 07:57:15 +02:00
Nicolas F
9ae3ac2916 Add mingw-w64 build documentation 2015-08-16 00:17:19 +02: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
Andrew Chin
ddfd88aad7 Update signs.rst
Added small note about how to look for the Markers button on a successful genpoi
2015-06-05 22:07:02 -04:00
Aaron Griffith
aad05b5ecf Merge pull request #1207 from tdierks/docs-import-change
Docs import change
2015-02-23 10:44:54 -05:00
tdierks
fc150a7739 Explain importing for filter functions
This code is correct, but doesn't work correctly with signs since they got JSON text formats in 14w25a. I will try to create another PR with an improved sign function tomorrow, but it's turning out to be complex, so for the moment, I'll stick with this tip on making imports work.
2015-02-11 00:41:51 -05: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
Caleb Sander
a998911d02 Added information about --skip-scan to the docs 2015-01-28 22:44:14 -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
Andrew Chin
5d13030834 Bump versions and docs for 1.8 support! 2014-09-02 10:54:13 -04:00
Franz Dietrich
55bbe26916 Fix error in the config.rst file 2014-08-14 10:35:44 +02:00
Brooks
6cca3ed004 Latest version of minecraft jar
Updated the version variable in the short script to install the latest minecraft jar for textures.
2014-07-30 22:24:23 -04:00
Aaron1011
51e75a7d06 Fix typo 2014-07-09 10:52:12 -04:00
Aaron Griffith
35863578d7 Merge remote-tracking branch 'matrixhacker/master'
Conflicts:
	docs/config.rst
2014-06-26 05:14:49 -04:00
Nicolas F
948d2fa741 Minor fixes to documentation
* Fix the copypasted section in the README

  * Update version and dates
2014-06-04 13:23:30 +02:00
Nicolas F
3c33080e3d Update front page of the docs
lol
2014-06-04 12:23:43 +02: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
John
2c5183e006 --check-tiles note about overestimating
added note about --check-tiles overestimating tiles and remaining processing time
2014-03-06 23:06:33 -05: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
ded35116aa Some initial docs on how to use gist 2014-01-01 22:32:35 -05:00
Aaron Griffith
519e13a34f added note about signed APT repo to install docs 2013-12-31 16:47:43 -05:00
Andrew Chin
329b299664 Merge PR #1037 -- ServerAnnounceObserver.update() updates last_update 2013-12-26 23:36:24 -05:00