Logo
v1.2.0
  • Getting Started
    • Installation
      • Supported Platforms
      • Install Rust
      • Build Merlon from source
      • Verify Merlon is installed
    • Creating a new package
      • The package directory structure
        • Package manifest
        • Patches
        • README.md
        • LICENSE
    • Initialisation
    • Building
    • Making changes
      • Code changes
      • Asset changes
    • Dependencies
    • Distribution
  • Star Rod
    • Comparison with Star Rod
    • Using the Star Rod Map and Sprite Editors with Merlon
  • Recommended Emulators
  • Glossary
    • Decomp
    • Distributable
    • Package
    • Package manifest
    • Patch
    • Shiftability
    • ROM

Advanced

  • Python
    • Installation
    • Usage
    • API Reference
      • version()
      • Package
        • Package.copyright_notice()
        • Package.current()
        • Package.export_distributable()
        • Package.id
        • Package.manifest()
        • Package.path
        • Package.readme()
        • Package.to_initialised()
        • Package.uuid_equals()
      • Manifest
        • Manifest.metadata
      • Metadata
        • Metadata.authors
        • Metadata.description
        • Metadata.id
        • Metadata.is_valid()
        • Metadata.name
        • Metadata.validate()
        • Metadata.version
      • ApplyOptions
        • ApplyOptions.baserom
        • ApplyOptions.build_rom_options
      • Distributable
        • Distributable.apply()
        • Distributable.manifest()
        • Distributable.open_to_dir()
        • Distributable.path()
      • ExportOptions
        • ExportOptions.baserom
        • ExportOptions.output
      • OpenOptions
        • OpenOptions.baserom
        • OpenOptions.output
      • AddDependencyOptions
        • AddDependencyOptions.path
      • BuildRomOptions
        • BuildRomOptions.clean
        • BuildRomOptions.output
        • BuildRomOptions.skip_configure
      • InitialiseOptions
        • InitialiseOptions.baserom
        • InitialiseOptions.rev
      • InitialisedPackage
        • InitialisedPackage.add_dependency()
        • InitialisedPackage.baserom_path()
        • InitialisedPackage.build_rom()
        • InitialisedPackage.from_initialised()
        • InitialisedPackage.initialise()
        • InitialisedPackage.is_git_dirty()
        • InitialisedPackage.is_initialised()
        • InitialisedPackage.package
        • InitialisedPackage.package_id()
        • InitialisedPackage.registry()
        • InitialisedPackage.set_registry()
        • InitialisedPackage.setup_git_branches()
        • InitialisedPackage.subrepo_path()
        • InitialisedPackage.update_patches_dir()
      • Registry
        • Registry.add_direct_dependency()
        • Registry.all_dependencies()
        • Registry.calc_dependency_patch_order()
        • Registry.check_version_compatibility()
        • Registry.delete_orphans()
        • Registry.get_dependencies()
        • Registry.get_direct_dependencies()
        • Registry.get_orphans()
        • Registry.has()
        • Registry.has_dependency()
        • Registry.register()
        • Registry.take()
        • Registry.topological_ordering()
      • run_rom()
      • Rom
        • Rom.path
        • Rom.read_bytes()
        • Rom.sha1_string()
  • Rust
Merlon
  • Search

© Copyright 2023, Alex Bates. The authors are not affiliated with Nintendo Co., Ltd. in any way. PAPER MARIO is a trademark owned by Nintendo Co., Ltd. Revision 98cdfd04.

Built with Sphinx using a theme provided by Read the Docs.