1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101

//! Libraries for reading/writing Age of Empires 2 data files.
//!
//! ## Data Files
//!
//! > Supported version range: Age of Empires 2: Age of Kings, Age of Conquerors, HD Edition
//!
//! genie-dat can read data files (empires.dat) for Age of Empires 2. When reading a file, the
//! version is detected automatically, based on the amount of terrains included in the file (since
//! that is hardcoded in each game executable).
//!
//! Writing data files is not yet supported, and many of the things that the library reads are not
//! yet exposed in the public API.
//!
//! ```rust
//! # fn main() -> anyhow::Result<()> {
//! use genie::DatFile;
//! let mut input = std::fs::File::open("./crates/genie-dat/fixtures/aok.dat")?;
//!
//! let dat = DatFile::read_from(&mut input)?;
//! assert_eq!(dat.civilizations.len(), 14);
//! assert_eq!(dat.civilizations[1].name(), "British");
//! # Ok(()) }
//! ```
//!
//! ## Scenario Files
//!
//! > Supported version range: AoE1 betas through to Age of Empires 2: HD Edition
//!
//! genie-scx can read and write scenario files for almost all Age of Empires versions. When
//! reading a file, the version is detected automatically. When writing a file, you can choose the
//! version to save it as. For example, you can read an HD Edition scenario file, but save it for
//! AoC 1.0c. Note that scenarios that are converted like this may crash the game, because they may
//! refer to terrains or units that do not exist in the different version.
//!
//! ```rust
//! # fn main() -> anyhow::Result<()> {
//! use genie::Scenario;
//! use genie::scx::VersionBundle;
//!
//! /// Read an AoE1 scenario file
//! let infile = "./crates/genie-scx/test/scenarios/Dawn of a New Age.scn";
//! let input = std::fs::File::open(infile)?;
//! let output = std::fs::File::create("converted.scx")?;
//!
//! let scen = Scenario::read_from(input)?;
//! scen.write_to_version(output, &VersionBundle::aoc())?;
//!
//! # std::fs::remove_file("converted.scx")?;
//! # Ok(()) }
//! ```
//!
//! ### Implementation Status
//!
//! There aren't many ways to edit a scenario file yet. Initially, we'll work towards the necessary
//! features for proper conversion between AoE versions, especially HD → WololoKingdoms. When that
//! is fairly robust, we'll work on adding methods to edit scenarios and create them from scratch.
//!
//! ## Campaign Files
//!
//! > Supported version range: all versions
//!
//! Campaign files are archives that contain a bunch of scenario files. genie-cpx can extract
//! scenarios from campaign archives and create new campaign archives.
//!
//! ## Hotkey Files
//!
//! > Supported version range: all versions
//!
//! Hotkey files contain groups of key mappings for different game areas.
//!
//! ## Palette Files
//!
//! > Supported version range: all versions
//!
//! Palette files contain the 256-bit colour palettes used in different areas of the game. Each
//! palette contains up to 256 r, g, b colour values. Both reading and writing is supported.

#![deny(future_incompatible)]
#![deny(nonstandard_style)]
#![deny(rust_2018_idioms)]
#![deny(unsafe_code)]
#![warn(missing_docs)]
#![warn(unused)]

pub use genie_cpx as cpx;
pub use genie_dat as dat;
pub use genie_drs as drs;
pub use genie_hki as hki;
pub use genie_lang as lang;
pub use genie_rec as rec;
pub use genie_scx as scx;
pub use jascpal as pal;

pub use genie_cpx::Campaign;
pub use genie_dat::DatFile;
pub use genie_drs::{DRSReader, DRSWriter};
pub use genie_hki::HotkeyInfo;
pub use genie_lang::LangFile;
pub use genie_rec::RecordedGame;
pub use genie_scx::Scenario;
pub use jascpal::Palette;