Skip to content

Progress

This page tracks the current state of the documentation.

See the docs contribution guide if you wish to help expand the docs.

Main

  • Pylon main page
  • Installing Pylon
  • Addon list
  • Commands and permissions
  • Compatibility
  • Placeholders

Creating addons

Tutorials

  • Tutorial 0 - Getting started
  • Tutorial 1 - Your first item
  • Tutorial 2 - Customising items
  • Tutorial 3 - Lore
  • Tutorial 4 - Saving data to items
  • Tutorial 5 - Your first block
  • Tutorial 6 - Customising blocks
  • Tutorial 7 - WAILA
  • Tutorial 8 - Block tickers
  • Tutorial 9 - Saving data to blocks
  • Tutorial 10 - Processor blocks
  • Tutorial 11 - Recipe processor blocks
  • Tutorial 12 - Adding a new fluid
  • Tutorial 13 - Fluid blocks
  • Tutorial 14 - Fluid items
  • Tutorial 15 - Creating GUIs
  • Tutorial 16 - The Rebar guide
  • Tutorial 17 - Virtual inventories
  • Tutorial 18 - Logistic blocks
  • Tutorial 19 - Processors
  • Tutorial 20 - Multiblocks
  • Tutorial 21 - Using display entities
  • Tutorial 22 - Adding a new recipe type
  • Tutorial 23 - Your first entity
  • Tutorial 24 - Custom researches

Discussions

(leave to Idra pls)

  • Discussion 1 - How to write a good addon
  • Discussion 2 - UX and why it matters
  • Discussion 2 - Structuring your code
  • Discussion 3 - A word of caution
  • Discussion 4 - List of best practices

Documentation

  • Blocks
  • Creating new blocks - Idra (TODO explain place context, mention pick override and similar)
  • Block interfaces
  • Interface quick reference
  • Persistent data
  • WAILA - Idra (TODO waila overrides)
  • Settings
  • Processor blocks - Idra
  • Multiblocks
  • Simple multiblocks
  • Multiblock state
  • Interacting with components
  • Custom multiblocks
  • Configs
    • ConfigSection
    • Builtin config adapters
    • Writing a config adapter
  • Language system
    • Tags
    • Unit format - Seggan (unstable - Seggan planning to add derived units)
    • Placeholders - Seggan
    • Progress bars - Idra (added not too long ago so might still change)
  • Fluid system
    • Adding a new fluid
    • Fluid system blocks
    • Fluid tags
    • Fluid hatches - Idra (unstable - changed by electricity PR)
  • Items - Anyone
    • TODO
  • Entities - Anyone (unstable - not used very much yet so will probably evolve)
    • TODO
  • Working with displays - Idra
    • TODO
  • Logistics system - Idra (unstable - potential big changes coming to logistics slots)
    • TODO
  • Recipes - Anyone
    • TODO
  • Guide pages/buttons - Idra
    • TODO
  • Resource pack support - Anyone? Consult with Pandicka/Justin
    • TODO
  • MultiHandler system - Justin
    • TODO
  • Culling system - Justin
    • TODO
  • Researches - Anyone
    • TODO
  • Registries (1 page) - Anyone
  • Gametests - Seggan
    • TODO
  • Appendix
    • Using/creating PersistentDataTypes - Idra (Move from blocks persistent data page)
    • Addon lifecycle - Idra (startup/shutdown)
    • BlockPosition and ChunkPosition (and why they exist and when to use them) - Anyone
    • ItemTypeWrapper - Anyone

Internals

  • Cargo
  • Data-oriented interfaces
  • Fluids
  • Internationalization
  • Recipes
  • Researches
  • BlockStorage
  • EntityStorage
  • Culling
  • Packet based entities
  • Textures
  • Automated tests
  • The history of BlockStorage
  • The schema debacle

Contributing

  • Getting started
  • Parallel dev repo
  • Testing your changes
  • Custom Dokka (migrate from getting started)
  • Contributing to docs
  • Contributing guidelines (including AI usage)