README.md

The DBPF File Format Community Specification

The purpose of these documents is to provide an updated, comprehensive, and detailed description of the DBPF file format. This is a community effort. The DBPF file format is a file format used in various games, including The Sims Series, SimCity, and Spore.

Additionally, without official feedback from EA or Maxis, a lot of this information is speculative and based on prior and ongoing reverse-engineering efforts.

Table of Contents:

• Pre: Background and Acknowledgements
  • This section lists the various community projects and resources that this project is based on. Useful for further research and development of this library.
• The DBPF File Format
  • Introduction
  • Versions
    • Known Versions
  • Structure
    • Header
    • The Tables
      • Table Entries
        • DBPF v1.0 - Table Version 7.0
        • DBPF v1.1 - Table Version 7.1
        • DBPF v2.0
        • DBPF v3.0

Background and Acknowledgements

Currently, the community spec is biased towards The Sims 4, but it is compiled from various community resources across different games, including:

• Wikis:

  • SimCity 4 Devotion (SimCity 4 Encyclopaedia)
  • ModTheSims Wiki
  • Niotso Wiki
  • Sims Wiki
  • Nraas Wiki

• Projects:

  • C#

    • Sims4Tools:
      • Github: s4ptacle/Sims4Tools
    • Sims3Tools:
      • Github: anonhostpi/Sims3ToolsClone
      • SourceForge: projects/sims3tools
    • SimPE:
      • Github: SimTactics/SimPE
      • SourceForge: projects/simpe
    • scDBPF:
      • Github: noah-severyn/scdbpf
    • s3pi:
      • Github: anonhostpi/s3piClone
      • SourceForge: projects/s3pi
    • DBPF-package-manager:
      • Github: owlks4
    • DBPFSharp:
      • Github: 0xC0000054/DBPFSharp
    • DBPF_Utils:
      • Github: LeonPoon/DBPF_Utils
    • OpenTS2:
      • Github: LazyDuchess/OpenTS2
    • Gibbed.Sims4:
      • Github: gibbed/Gibbed.Sims4
    • Gibbed.Sims3:
      • Github: gibbed/Gibbed.Sims3
    • Gibbed.Spore:
      • Github: gibbed/Gibbed.Spore

  • Python:

    • s4py:
      • Github: thequux/s4py
    • sims2py:
      • Github: lingeringwillx/sims2py
    • dbpf:
      • Github: fbstj/dbpf
    • SimTools:
      • Github: Dav1dde/simtools
    • preview-HighHeels:
      • Github: Oops19/preview-HighHeels

  • Java:

    • jDBPFX:
      • Github: memo33/jDBPFX

  • Rust:

    • dbpf:
      • Github: chieltbest/dbpf

  • TypeScript:

    • SporeTools:
      • Github: SporeCommunity/SporeTools

  • C:

    • dbpf_reader:
      • Github: ytaa/dbpf_reader

  • Tcl:

    • HexFiend-templates-sims
      • Github: sw-uci/HexFiend-templates-Sims