Project Zomboid Extender is an extension framework for Project Zomboid. It aims to expose more of the game than is currently available for modding and introduce its own developer experience and quality of life features.
The work here is largely inspired by the work started at Zomboid Storm.
Scripting with Kotlin offers direct unrestricted access to the Zomboid java environment while being able to listen to the same events that Lua scripts can. Additionally, integration with IntelliJ provides a much improved development experience for script authors.
All of Project Zomboid's dedicated server options can be configured via an environment variable in addition to editing server.ini. Where an environment variable is available, it takes precedence over any option set in the ini file.
Server options are prefixed with ZOMBOID_ and converted to UPPER_SNAKE_CASE. For example, to set FireSpread=false
with an environment variable the syntax is:
ZOMBOID_FIRE_SPREAD=false
All logs (except those from native code) are now routed to logback via SLF4J.
Game Server metrics are exported via HTTP in a format consumable by Prometheus.
An HTTP server is launched alongside the game server to server requests to a simple HTTP API that responds with information on the game. This is currently limited to basic information such as world date, players online, etc.
Example request:
GET /info
Content-Type: application/json
{
"players": {
"current": 19,
"max": 48,
},
"world": {
"daysElapsed": 3.5,
"weather": "sunny"
}
}TODO
TODO