papillon88 / tectonicus

Automatically exported from code.google.com/p/tectonicus
0 stars 0 forks source link

Update misleading/out-of-date config information #8

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Tectonicus configuation documentation is out-of-date, contradictory and 
misleading to the point most users cannot get custom block configurations to 
work.  It took me a couple hours of trial and error to get it to work, and most 
docs lead me down wrong paths.

1.) The exampleConfig.xml file that is included with Tectonicus 2.14 is 
out-of-date and does not work.
Exception in thread "main" java.lang.RuntimeException: Old or incompatible 
config file. Please update to the latest format

The config file was from version 1, and you should really include a version 2 
config file or at least one that can run in 2.14.

2.)  The custom blocks feature and documentation was written during the 
Tectonicus 2.x version, but the docs on custom blocks at:
http://www.minecraftwiki.net/wiki/Programs_and_Editors/Tectonicus/Custom_Blocks

refer to <layer dimension="terra" renderStyle="normal"
       useDefaultBlocks="true"
       customBlocks="C:/customBlockConfig.xml">

This was copy/pasted out of the version 1 config which is now the map tag.

The version 2 config documentation at:       
http://www.minecraftwiki.net/wiki/Programs_and_Editors/Tectonicus/TectonicusConf
igFormat
has no reference on how to include a custom blocks xml.

Placing customBlocks attribute in every possible element in the version 2 
config finally yielded results at map/layer tag.  The layer element in the 
version 2 docs do not mention this is a valid attribute.

3.)  The commandline arguments documentation is out of date.  If there is a way 
to pass in a custom blocks xml using this, it is unknown.  The config parameter 
is not even mentioned in this documentation.

Original issue reported on code.google.com by Zekao...@gmail.com on 2 May 2012 at 2:09

GoogleCodeExporter commented 9 years ago
The sample xml config files have been updated. See the links below.
The custom blocks config settings are now in the fullConfig.xml sample/doc.
The commandline arguments are not officialy supported any longer. Dig through 
the source code if you really want to find them.

Sample configs:

http://tectonicus.googlecode.com/svn/trunk/tectonicus/Docs/simpleConfig.xml

http://tectonicus.googlecode.com/svn/trunk/tectonicus/Docs/exampleConfig.xml

http://tectonicus.googlecode.com/svn/trunk/tectonicus/Docs/fullConfig.xml

Original comment by sambened...@gmail.com on 2 May 2012 at 4:00