PlanetsLib

Code, graphics and conventions to help modders creating planets, moons and other systems. This library is a community project and will grow over time. Feel free to contribute via pull requests on Github.

We will try to avoid breaking changes. When breaking changes need to be made to features used by live mods, the major version of Planetslib will be bumped.

Credits

Contributors:

• Tserup - Art
• thesixthroc
• MidnightTigger
• notnotmelon

API Reference

Planet helpers

• PlanetsLib:extend(config) - A wrapper for data:extend that only accepts planet and space-location definitions. Throws an error if passed distance or orientation. It instead takes the fields listed below.
• orbit - Object containing orbital parameters:
  • parent - Object containing name and type fields, corresponding to a parent at data.raw\[type]\[name].
  • distance - Number: orbital distance from parent
  • orientation - Number: orbital angle from parent (0-1). Note that orientation is absolute, not relative to the parent's orientation.
  • sprite - Object: Sprite for the orbit, centered on its parent.
• sprite_only - Boolean (optional): If true, the prototype will be removed in data-final-fixes and replaced by a sprite on the starmap. This is used for the central star (data.raw\["space-location"].star) internally.
• Any other valid planet or space-location prototype fields
• Notes:
  • Can accept a single config object or an array of configs
  • Returns array of created planet prototypes
  • See here for a usage example.
• PlanetsLib:borrow_music(source_planet, target_planet) - Clones music tracks from an existing planet to a new one.
• PlanetsLib:set_default_import_location(item_name, planet) - Sets the default import location for an item on a planet.

Planet Cargo Drops Technology

The library provides automatic functionality to restrict cargo drops on your planet until a technology is researched. To implement:

• Define a technology with name pattern: [planet-name]-cargo-drops
• Use the provided helper functions:
• PlanetsLib.technology_icons_planet_cargo_drops
• PlanetsLib.technology_effect_cargo_drops

Players will be unable to drop cargo (excluding players and construction robots) to planets with that name before researching the technology.

Support for moons

• PlanetsLib.technology_icons_moon - Standardized icon for moon discovery technology.
• subgroup=satellites - A new Factoriopedia row for satellites (below the planets row).

Surface conditions

Documentation pending.