Farming Simulator 25 mod project for extending biogas plant gameplay.
This repository is the staging ground for early design and implementation. The mod shape is intentionally minimal while the first gameplay loop is proven.
- Explore BGA-related gameplay extensions for Farming Simulator 25.
- Keep the mod source clean, versioned, and package-ready.
- Document design decisions as they are made.
mod/- Farming Simulator mod source files.docs/- design notes, references, and planning documents.tools/- local helper scripts for packaging or maintenance.addons/- optional compatibility add-ons with their own provider dependencies.examples/- copyable examples such as the GBW data-pack template.
Each shipped mod version should get a GitHub release and retain its old releases
as the project timeline. See docs/release-process.md; the GitHub Actions
Release workflow builds the versioned package set, creates or verifies a
vX.Y.Z.W tag, and publishes a GitHub prerelease by default.
The current implementation provides PlanET-compatible biomass intake modules, Wet Substrate Prep, a Fermentation Vessel, a Process Supply Hub, a Process Pallet Dock, a Dry Fuel Processor, and scaled dry fuel yards. The intake modules convert forage, manure, and assisted low-grade straw routes into the internal feedstocks used by FS25_PlanET_BGA_Modular; Wet Substrate Prep makes wet/root/produce mash families; Fermentation Vessel turns mash and assisted pellet substrates into PlanET feedstock; the supply hub distributes process water; the pallet dock distributes silage additive and molasses; Dry Fuel Processor converts straw and hay into Straw Harvest pellets using water and molasses; dry fuel yards store WOODCHIPS, STRAW_PELLETS, and HAY_PELLETS for heat-plant logistics; and the Orchards/Greenhouses compatibility add-on includes runtime-gated waste-aware wet substrate prep, a waste-aware large biomass intake, and a GBW Compost Bay for physical composting/logistics. Lua helper behavior is self-contained in each package.
Maize+/MaizePlus integration is parked until a production-ready FS25 release is installed and explicitly selected as a target. Corn Production Pack remains observation-only.
The broader design remains registry-driven for later optional integrations. Optional add-ons are shipped separately so provider fillTypes such as POTATO_WASHED, ORGANICWASTE, and COMPOST never enter core XML without their providers. Stage 1 of the GBW data-pack API validates third-party route packs without injecting recipes yet. See docs/data-pack-api.md, docs/implementation-approach.md, docs/integration-strategy.md, docs/dependency-contract.md, docs/guarded-compatibility.md, docs/performance-targets.md, docs/measurement-and-automation.md, docs/runtime-smoke-tests.md, docs/issue-management.md, docs/energy-carrier-strategy.md, docs/construction-menu-categories.md, docs/model-fit-decisions.md, docs/visual-assets.md, docs/known-log-lines.md, docs/biomass-crop-ranking.md, docs/conversion-process.md, and the draft registry at mod/config/biomassCropRegistry.xml.
Gekko BioWorks
This project uses dual licensing:
- Code (Lua scripts, XML definitions, tools, and documentation): MIT License
- Assets (textures, icons, images, models, and other media): CC BY-NC-SA 4.0
Forks and addons are encouraged. Code is permissively licensed for integration. Assets are protected from commercial use and must preserve attribution and ShareAlike terms.