Un-Banished API documentation

The Rust API documentation of the libraries of Un-Banished, generated by cargo doc from the source code. Each crate's first page is its README, with examples. Every ported item names the original function it came from in its last line, Original.

About this documentation · Apps and crates · The website

• banished-coreExact maths, the game's random numbers, Perlin noise, game time and the calendar.
• banished-terrainMap generation from a seed, the terrain mesh, rivers, ground height and cell types.
• banished-pathThe A* pathfinder, walkable regions and the sector graph.
• banished-gameThe game rules: citizens, jobs, buildings, farming, trade, nature and disasters.
• banished-formatsReaders for the game's packages, resources and save files.
• banished-uiThe game's interface system: elements, layout, text, controls and input.
• banished-gfxRendering shared by the game and the viewer, with wgpu.
• banished-audioSound decoding and playback: the 64-channel device and the sound scene.
• banished-wmaA decoder for Windows Media Audio v2, the codec of the game's sounds.
• banished-modsThe mod list shared by the game and the mod manager: packages, order and conflicts.
• banished-nexusOptional Nexus Mods support: search Banished mods and install their packages.
• banished-banishedinfoOptional banishedinfo.com support: list and search its Banished mods and install them.
• banished-netMultiplayer networking: the relay protocol and a WebSocket connection, natively and in the browser.