Ore Distribution Configurator for Starbound

Requires: Starbound v. Enraged Koala
Python v3
File version: 2014FEB18
Readme version: 2014FEB19
Credits: Leyic
Download: http://community.playstarbound.com/index.php?resources/ore-distribution-configurator.1506/
http://www.nexusmods.com/starbound/mods/449/?

----------------------------------------------------------------------
Description:

Important: This is not a simple drag-and-drop mod. Python3, and the
knowledge of how to open and save .csv files are required. Knowing how
asset files relate to oredistributions.configfunctions will help, but
is not necessary.

This is a tool consisting of two Python3 scripts that can convert the
oredistributions.configfunctions asset file into a set of .csv files
and back again. Each .csv file corresponds to a single threat level,
and contains the ore distribution table sorted by 'depth'. This allows
for a different, and potentially easier or more intuitive way, of
changing the frequencies by which various ores appear in your game.
This does not affect the distribution of dirt, sand, stone, etc.

----------------------------------------------------------------------
Install/Uninstall Instructions:

Place the uncompressed "Ore Distribution Configurator" directory into
Starbound's mods directory. By default, this is within the Steam
directory at ...\SteamApps\common\Starbound\mods.

To uninstall, delete the directory.

----------------------------------------------------------------------
How to Use (changing distribution of vanilla ores):
The utility comes with the vanilla oredistributions.configfunctions
file. Use read.py to convert it into ten .csv files. Load these files
into your preferred spreadsheet program (use comma delimiter if given
a choice). You will see a single table, with depths on the rows and
ores on the columns. The values correspond to how frequent the ore
will appear, with higher numbers resulting in more ore. Change the
values to fit your preferences. (Don't insert negative values,
letters, blanks, etc. Starbound expects a zero or positive number and
may crash with anything else.) Once you have finished making your
changes, use write.py to convert the .csv files back into the
oredistributions.configfunctions file (this will overwrite the current
file without warning). You are finished and can now play the game with
your modded ore distribution tables.

----------------------------------------------------------------------
How to Use (changing distribution of modded ores):
You must replace the oredistributions.configfunctions file that comes
with this utility with the corresponding file that comes with the mod.
This should be in the mod's biomes directory. If the mod is packed,
you will first need to unpack it. Once you've replaced the file,
follow the instructions above to modify the file. Once the file is
modified, move (do not copy) it back into the mod's biomes directory.
You are finished and can now play the game with your modded ore
distribution tables.

----------------------------------------------------------------------
How to Use (adding ores and/or depth levels):
Use read.py to convert your current oredistributions.configfunctions
file (convert the vanilla file that comes with this utility if you
don't yet have your own version). You can add ores by adding columns,
and depth levels by adding rows. The names must each be a single word,
and you must consistently change all ten .csv files. Make certain that
each cell of each table is filled with a valid value, blanks are not
acceptable. You must also change related asset files to completely add
the ores and depth levels to your mod; failure to do so may make
Starbound unstable. After you have modified your tables, run write.py,
and move (do not copy) the resulting oredistributions.configfunctions
to your mod's biomes directory.

----------------------------------------------------------------------
Contact:

'Leyic' at Chucklefish Games Forums.
'Leyic' at Nexus Mods.

----------------------------------------------------------------------
History:

2014FEB18
Updated for Enraged Koala.

2014FEB07
Initial release.

----------------------------------------------------------------------
Legal/Licensing:

You maintain full rights to all asset and intermediary files created
with this utility as far as is permissible by Starbound's EULA.

The Python3 scripts and documentation are licensed under the
University of Illinois/NCSA Open Source License:

Copyright (c) 2014 Leyic
All rights reserved.

Developed by: Leyic

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal with the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimers.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimers in
the documentation and/or other materials provided with the
distribution.
* Neither the names of Leyic, nor the names of its contributors may
be used to endorse or promote products derived from this Software
without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.