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 try to avoid breaking changes. In the unlikely event breaking changes occur, the major version of Planetslib will be bumped (unless the feature is unused.)

Credits

Contributors:

• Tserup (art)
• thesixthroc
• MidnightTigger
• notnotmelon

API Reference

Planet helpers

• PlanetsLib:extend(config) — A wrapper/replacement for data:extend. Throws an error if passed distance or orientation. It instead takes the fields listed below.
  • type — "planet" or "space-location"
  • orbit — Object containing orbital parameters:
    • parent — Object containing name and type fields, corresponding to a parent at data.raw[type][name]. Planets in the original solar system should have an orbit with type = "space-location" and name = "star".
    • 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, this prototype will be removed in data-final-fixes and replaced by its sprites on the starmap (unless neither starmap_icon, starmap_icons nor an orbit sprite are defined, in which case nothing will show).
    • This is useful for constructing stars and other locations that should not have a space platform 'docking ring'.
  • Other valid planet or space-location prototype fields
  • Further notes on PlanetsLib:extend:
    • Should not be called in data-final-fixes.
    • See here or here for usage examples.
• PlanetsLib:update(config) — The same as PlanetsLib:extend, except it updates a pre-existing planet or space location (identified by the passed type and name fields) using the parameters passed. If the orbit field is passed, the distance and orientation fields on the prototype will be updated appropriately. Should not be called in data-final-fixes.
• 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.