Skip to content
This repository has been archived by the owner on Oct 21, 2020. It is now read-only.

Commit

Permalink
Mostly refactoring, no effective changes here.
Browse files Browse the repository at this point in the history
  • Loading branch information
ahkok committed Dec 7, 2013
1 parent 7006c85 commit dd27353
Show file tree
Hide file tree
Showing 3 changed files with 740 additions and 600 deletions.
114 changes: 94 additions & 20 deletions README
Original file line number Diff line number Diff line change
@@ -1,27 +1,101 @@
Sedimentology - a bukkit plugin that simulates erosion and sedimentation.
Sedimentology

-- a bukkit plugin that simulates erosion and sedimentation.

~~~~

This plugin attempts to create processes that are involved in the
transport and deposition of sediments:

This plugin attempts to create processes that are involved in the transport
and deposition of sediments:
- water picking up material
- transportation down slopes
- weather influence
- material falling down cliffs
- material decaying/degrading into smaller grained materials

The plugin doesn't properly recreate real geologic processes, instead it
mimics the bahavior of erosion and deposition by rolling a dice for
most of the factors involved, and if the roll was succesful, proceed
to the next step.

Material hardness and resistance are taken into account - some materials
are easier displaced than others. Some materials degrade easier than
others. Some materials (sand) have a different angle of repose.

This plugin isn't meant to enhance game play per se, it will operate slowly
over time and vegetation will prevent most of it's effects from taking
a toll on the landscape in most cases, so it will take a long time in
default settings from actually doing anything noticeable. Because dirt
naturally gets a grass cover in Minecraft it will be unlikely that
this plugin does significant damage to your world. Of course, planting
stuff is still advisable if you want to reduce the effects of the plugin
further.
The plugin doesn't properly recreate real geologic processes, instead
it mimics the bahavior of erosion and deposition by rolling a dice
for most of the factors involved, and if the roll was succesful,
proceed to the next step.

Material hardness and resistance are taken into account - some
materials are easier displaced than others. Some materials degrade
easier than others. Some materials (sand) have a different angle
of repose.

This plugin isn't meant to enhance game play per se, it will operate
slowly over time and vegetation will prevent most of it's effects
from taking a toll on the landscape in most cases, so it will
take a long time in default settings from actually doing anything
noticeable. Because dirt naturally gets a grass cover in Minecraft
it will be unlikely that this plugin does significant damage to your
world. Of course, planting stuff is still advisable if you want to
reduce the effects of the plugin further.

~~~~

Commands

/sed is equivalent to /sedimentology.

/sedimentology stats

Display statistics from the plugin. The plugin keeps internal counters
for modifications made and attempts, and this command allows you to
display those statistics.

/sedimentology blocks <integer>

Modify the number of blocks per cycle that the plugin will
attempt to consider for modification. Note that due to the various
factors involved, this number will almost never equal the number of
modifications made per cycle - but increasing it will accelerate the
erosion process.

/sedimentology protect <boolean>

Enable or disable protection if Factions or Towny is present. If they
are not, all land is unprotected. By default, if Factions or Towny
is present there will be no modifications made to claimed blocks.

/sedimentology list

List the worlds that will get the effects of this plugin

/sedimentology enable <world>
/sedimentology disable <world>

Enable or disable the effects of this plugin for a particular world.

/sedimentology help

Displays a help message describing the commands available.

All these plugins require the "sedimentology" permission.

~~~~

Factions / Towny

Both Factions and Towny are optional and this plugin will work even if
they are not installed. If they are present however, the plugin will
stop making modifications to claimed blocks. This can be configured
disabled with the /sedimentology protect command.

While I tested Factions support thoroughly, I can't currently test
Towny integration, so feedback appreciated if you can test this for me.

Bugs / Code For bugs, tips, donations please feel free to contact me:

Auke Kok - auke@foo-projects.org

The project code is hosted on my github page:

https://github.com/sofar/Sedimentology

The bukkit page for this plugin is here:

http://dev.bukkit.org/bukkit-plugins/sedimentology/

More information can be found on the bukkit page. There is also a concepts
discussion article, and screenshots are posted here for viewing as well.
2 changes: 1 addition & 1 deletion plugin.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Sedimentology
main: org.foo_projects.sofar.Sedimentology.Sedimentology
version: 4
version: 5
softdepend: [Factions, Towny]
commands:
sedimentology:
Expand Down
Loading

0 comments on commit dd27353

Please sign in to comment.