Modules.md

Modules

Content, gameplay mechanics, and mostly everything other than the engine that allows the game to run is stored in what we call "modules" which are similar to the traditional meaning of "mods" but intended to be smaller building blocks you'd normally put several of together to make one traditional "mod".

Modules in turn are sometimes grouped in "Gameplay Templates" which are like Minecraft-style mod packs. These are directly available via drop-down at world creation and are the suggested way to enable more content. Do not enable every single module manually! :-)

You can customize module selection with the "Modules" button but you generally should enable very few or rely on the gameplay templates. Some world generator types may be registered by a module and auto-select that and maybe other modules if you choose that world type. Modules may also enable additional console commands (listed by the "help" command when active).

The game can download module updates from our central meta-server and clients connecting to a game server will be automatically sent the right version of any enabled modules!

Be cautious in downloading modules beyond the ones shipped with the "Omega Zip" - other modules not bundled with the game are likely still in development or unstable and may crash the game.

Module source repositories live under the Terasology organization on GitHub, while the engine level projects live under the MovingBlocks organization.

Here's a list of modules bundled with the game by default (this line-up will change now and then). It should roughly match this category in Jenkins: http://jenkins.terasology.org/view/Modules and you can download updated modules from there if needed.

Note about "Tutorial" modules: These are more likely for some time to be for developers/modders to learn about different kinds of content and systems, not for players to actually learn stuff in-game. That's usually handled by actual content modules including their own in-game help system.

• AlterationEffects - module for storing some buff/debuff type effects
• AnotherWorld - world gen module, includes features like ore placement and caves, used by WoodAndStone's world
• AnotherWorldPlants - farming and tree growth for AnotherWorld
• BlockDetector - adds a simple little tool that can detect specific blocks (beeping in proximity)
• BlockNetwork - a framework to support blocks that can communicate with each other in some fashion
• BlockPicker - allows the player access to an infinite block inventory with the B key
• Books - books and bookcases
• Breathing - without this you can't breathe! But you also don't need to. Enable it to drown properly in water (or not!)
• BuilderSampleGameplay - gameplay front for engine alone to show lack of inventory and health can work
• CakeLie - the cake may be a lie, but these cake and candy blocks are delicious!
• Caves - a cave generation module (actually an ore vein generator placing air veins!) based on CustomOreGen
• ChangingBlocks - allows blocks to change over time (such as switching to a more dusty / worn looking block after x amount of days)
• CheatsForAll - if enabled on a server allows the use of cheat commands for any player connected without any additional admin setup
• ChrisVolume1OST - official game soundtrack by Chris Köbke - volume 1
• ChrisVolume2OST - official game soundtrack by Chris Köbke - volume 2
• Cities - procedural city placer and plot organizer, also places roads to connect cities. Later split into Static and Dynamic variants
• ClimateConditions - A library module for managing temperature, humidity, and other climate factors
• CommonWorld - general world generation utility module
• ComputerMonitors - allows for the creation of functional multi-block monitors in-game - ModularComputers puts them to work!
• CopperAndBronze - another era for throughout the ages, this time copper and bronze (comes after wood and stone)
• Core - mandatory content needed for normal game launch
• CoreSampleGameplay - gameplay front for Core - allows modules to depend on Core without the default starting inventory
• CustomOreGen - library containing an ore distribution algorithm based on JRoush's CustomOreGen
• DamagingBlocks - allows blocks like lava to hurt the player
• Dialogs - supports opening dialogs for interactions with NPCs and such
• Durability - library module to support destructible items (wear and tear eventually breaks them)
• DynamicCities - variant of Cities that places then grows cities dynamically over time
• Economy - a module to simulate a basic supply & demand economy system
• Equipment - an equipment system with a character screen (c) showing stats and slots for various equipment types
• EventualSkills - a time-based skill system, a bit akin to EVE Online's system
• Fences - fences!
• Fluid - adds support for fluid in non-world situations (such as for storage in workstations)
• FluidComputerIntegration - allows for interactions with fluids via computers
• FunnyBlocks - cheese wheels and bowling pins - why not
• Genome - genetics WOO! Complete with DNA letters and mutating plants. Part of the Wood & Stone line-up
• GooeysQuests - spawn our mascot Gooey (console: spawnPrefab gooey) then e click to interact for commands and quests!
• GrowingFlora - organically growing (step by step) trees and such
• Hunger - makes the player slowly gets hungry (needs actual GUI work and ways to then actually eat food though). Console hungerCheck for stats
• InGameHelp - system for showing help in-game, default key P
• IRLCorp - Industrialized Reduction of Labor Corporation - Helping workmen everywhere
• ItemRendering - a library for displaying "holographic" items in the world
• JoshariasSurvival - formerly known as TerraTech - gameplay template for a machine-centric survival style
• Journal - allows the player to use an in-game journal for gameplay notifications and such. Default toggle key 'J'
• Lakes - add lakes to any enabled world generator, both surface lakes and subterranean ones (water and lava both!)
• LegacyMusic - older music pieces predating the official soundtrack
• LightAndShadow - main module for the Light & Shadow gameplay
• LightAndShadowResources - IMMA FIRIN’ MAH LASR!! Art assets for the Light & Shadow concept
• Machines - machine infrastructure library module
• Malicious - a series of module security tests to check that modules cannot do naughty things when running
• ManualLabor - tools and logic for manual labor (digging, chopping, etc)
• ManualLaborEventualSkills - bridge module for adding EventualSkills to ManualLabor
• MarcinScIncubator - parking lot for tools used in @MarcinSc's many modules without a more explicit home yet
• MarkovChains - Library module with some pseudo random math stuff
• MasterOfOreon - Master the Oreons, or others like them, from the throne-world of the Ancients! A menu command system, default show/hide key 'O'
• Maze - a maze generator. Right-click with the provided maze tool on one block then again on another and a maze will generate between the two points (in multiple layers if the area is tall enough)
• MedievalCities - a set of building templates for a medieval era city
• Minerals - a large collection of mineral blocks
• Miniion - base creature control system, used by MasterOfOreon - old module that has gone through a few redesigns
• Minimap - a basic minimap. Show/hide with M by default and zoom with numpad - and +
• MobileBlocks - supports blocks that can move their location based on some directions
• ModularComputers - central module for the creation of computers that themselves can have "hardware modules" of sorts added to them in-game to add interesting functionality
• MoreLights - assorted illuminated blocks
• MultiBlock - supports the concept of multiple blocks being part of the same structure
• MusicDirector - allows music assets to be prepared for dynamic inclusion in appropriate contexts (like time of day)
• NameGenerator - can create random themed names for use by other modules, or via console using commands like generateNameList 10
• OreGeneration - ore generation plugin system based on CustomOreGen (this one enables easy definition of what ores you want in a world)
• Oreons - little sentient cookie people! Don't do much yet. Place with spawnPrefab OreonGuard in the console (other types exist)
• Pathfinding - framework for pathfinding used by other modules
• PhysicalStats - introduces a basic attributes system akin to traditional RPGs
• PlantPack - more plants! Used by the Throughout the Ages gameplay
• PolyWorld - creates very neat island worlds based on the map generating algorithm by Amit Patel of Red Blob Games
• Portals - allows placement of portal blocks that'll spawn Oreons giveBlock portal
• PotentialEnergyDevices - A library for creating entities that build up potential energy
• Potions - contains a set of assorted potions the player can consume to gain various effects
• QuestExamples - samples for developers to help create quests
• Rails - railroads and trains! Press 'e' to start a caboose or enter a cart. Use the wrench to attach carts
• Sample - miscellaneous example content showcasing module usage
• Seasons - adds seasons to the game
• ShatteredPlanes - a world generator focused on canyons, sky islands, and other somewhat radical terrain features
• Signalling - circuitry implementation based on BlockNetwork, similar to redstone
• SimpleFarming - easy to understand growing of foods
• SimpleLiquids - lets water propagate in the world - beware of floods!
• Soils - a small pack of different soil types
• Spawning - split out from Portals to serve as general utility for anything needing stuff to spawn
• StaticCities - variant of Cities that places all cities during world generation without later dynamic growth
• StructuralResources - a set of structural shapes suitable for buildings and such
• StructureTemplates - a system for placing structures as per some template
• SubstanceMatters - library for the definition and usage of materials in various contexts, such as tools with dynamic looks based on material
• Tasks - allows for the definition of tasks/quests
• ThroughoutTheAges - gameplay module for a large content series letting you slowly climb a tech tree to improve your available tools, foods, and so on
• TutorialAssetSystem - a tutorial module covering our asset system, see also its wiki
• TutorialDynamicCities - GSOC 2016 project tutorial / docs. Covers how dynamic cities function. Shared wiki with DynamicCities
• TutorialGraphicTweaks - GSOC 2016 project tutorial / docs. Contains examples of how to modify rendering from a module (pending some refactoring before final merge of needed changes to the engine)
• TutorialNui - GSOC 2016 project tutorial / docs. Includes details both on NUI itself as well as its editor in the wiki
• TutorialWorldGeneration - a world generation tutorial module, goes with a guide in its wiki
• Valentines - What is love? Gooey don't hurt me, don't hurt me, no more ... ♫
• WeatherManager - simple weather foundation, tracks whether, maintains a single cloud layer, and so on
• WildAnimals - a module containing animals, initially a deer you can spawn in-world via console with spawnPrefab deer then watch wander idly
• WoodAndStone - big content module including "from scratch" crafting, starting with wood here
• Workstation - workstations offer a way to use blocks in-world for advanced purposes
• WorkstationInGameHelp - bridging module to bring in-game help to workstation screens
• WorldlyTooltip - a little tooltip that shows you what you're looking at (hold alt for debug details)

Some of the modules in action: