Index of useful info
- Installation... Start Here!
- Options... (you are here)
- Styles...
- Schematics...
- Commands...
- Version info...
- Tools I used to make this...
- Copyright...
Options
A Config.yml file is generated when CityWorld first runs and each time it is told to create a new world. These options only affect "new generation", changing them after a world has been generated will produce some odd results.
I have tried to ensure these options all work together but the number of permutations are pretty large. Also some options are exclusive of other options, for example if you decide to not include buildings then asking for the buildings, that you have excluded, to be decayed doesn't make much sense.
Note: Here is what I normally do when creating a new world. It is a little awkward but it works for me.
- Startup your server and create the new world (via whatever technique you like), remember to read the Installation instructions, this will make CityWorld generate the associated configuration section in plugins/CityWorld/config.yml.
- Next I shut down the server go change those newly created settings to what I really want the world to be like.
- Then I delete the previously created world and restart my server. If all goes well the newly created world should be regenerated but now using those new options I picked.
If you are wanting to create a particular world style, like floating, take a look at the Installation instructions.
Observations:
- If you regenerate the world using the same version, options and seed (how you set this depends on your multiverse manager works), you should get a nearly identical world, where only foliage might change. Keep in mind when there is a CityWorld version change, all bets are off though. Similar seeds might/will generated wholly new worlds.
- Two worlds with the same seed but slightly different options very well could create very similar worlds. For example, assuming the seed and all other options are the same, two worlds only differing in the inclusion of the IncludeDecayedBuildings option will create two parallel worlds: One normal, one destroyed.
- If you generate a new world there might not be a city nearby (or mountains, or seas, etc.). That is the nature of Random. If you don't like what you get, trash the world and generate a new one (with a different seed). Keep in mind though, the city of your dreams might be just on the other side of that mountain so go forth and explore!
- Except where otherwise stated, all options default to true and simply control the inclusion or exclusion of a certain feature or not.
Man made features
| Option | Description |
|---|---|
| IncludeRoads | Generate roads |
| IncludeRoundabouts | If roads are generated, then optionally generate roundabouts |
| IncludeSewers | If roads are generated, then generate a maze of sewers under them |
| IncludeBuildings | Generate buildings |
| IncludeBasements | If buildings are generated, then optionally generate basements |
| IncludeHouses | Generate houses |
| IncludeFarms | Generate farms |
| IncludeCisterns | if buildings are generated, then generate cisterns under the parks |
| IncludeMines | Generate maze of mine shafts underground |
| IncludeBunkers | Generate something somewhere... It is a secret |
Natural features
| Option | Description |
|---|---|
| IncludeSeas | Generate sea basins between the mountains and cities |
| IncludeMountains | Generate mountainous bumps between the seas and cities |
| IncludeLavaFields | Include lava pools way down below |
| IncludeCaves | Hollow out caves in the ground |
| IncludeOres | Randomly place ores underground |
Trick or Treat
| Option | Description |
|---|---|
| SpawnersInSewers | If there are sewers then include spawners in them |
| SpawnersInMines | If there are mines then include spawners in them |
| SpawnersInBunkers | If there are bunkers then include spawners in them |
| TreasuresInSewers | If there are sewers then include treasure chests in them |
| TreasuresInMines | If there are mines then include treasure chests in them |
| TreasuresInBunkers | If there are bunkers then include treasure chests in them |
Modifiers
| Option | Description | Default |
|---|---|---|
| IncludeUndergroundFluids | If ores are generated, then generate water and lava as well | true |
| IncludeAbovegroundFluids | If sea basins are generated, then generate water in them | true |
| IncludeWorkingLights | Where lights are made, try to make sure the generate light | true |
| IncludeWoolRoads | If roads are generated, use wool blocks | false |
| IncludeNamedRoads | If roads are generated, add road signs to the intersections | true |
| IncludeDecayedRoads | If roads are generated, destroy them a little | false |
| IncludeDecayedBuildings | If buildings are generated, destroy them a little | false |
| IncludeDecayedNature | Where nature is generated, destroy it a little | false |
| IncludeBuildingInteriors | Put stuff inside of buildings | true |
| ForceLoadWorldEdit | Ignores WorldEdit version numbers | false |
Note: Some of the above options will default a different way in worlds generated in the Nether or The_End.
Generation Range
| Option | Description |
|---|---|
| ConstructChunkRadius | How far do isolated construct chunks generate (oil platforms, radio towers, shacks, etc.), in chunks from the world's center point) |
| RoadChunkRadius | How far do roads chunks generate, in chunks from the world's center point |
| CityChunkRadius | How far do cities chunks generate, in chunks from the world's center point |
| CenterPointOfChunkRadiusX | Where is the center point of the above options, defaults to 0 |
| CenterPointOfChunkRadiusZ | Where is the center point of the above options, defaults to 0 |
Note: If the road radius is larger than the city radius, the roads generate without lights, lines, sewers, etc.
In the above picture the inner circle, centered on world's 0,0, represents the CityChunkRadius (in this case 10 chunks), the outer ring shows the RoadChunkRadius (20 chunks).
Note: that the bridges and tunnels stop abruptly when they hit the road radius specified.
Deprecated options
| Option | Workaround |
|---|---|
| IncludePavedRoads | Use IncludeWoolRoads if you want old style paved roads |
| RoadRange | Replaced with RoadChunkRadius instead to make things clearer |
| CityRange | Replaced with CityChunkRadius instead to make things clearer |
| IncludeTekkitMaterials | ForgeTekkit is now auto-recognized |
Forge/Tekkit Note: The way things are currently written, Tekkit ore and nature generation will only be enabled in normal worlds where IncludeDecayedNature is false. This will likely change in the future but for now, it is what it is.
