Welcome to the PyTower docs!

PyTower is a high-level Python API for editing CondoData/.map files

Check out the Installation Guide & Troubleshooting section for further information

PyTower has its documentation hosted on Read the Docs.

Note

This project is under active development.

Contents

• Installation Guide & Troubleshooting
  • Dependencies
  • Quick Installation
  • Recommended Installation Instructions
  • Installing From Source
• Getting Started With PyTower
  • Installation
  • General Usage
  • Using pytower run
  • Selection Modes
    • Selection Operators
  • Tool Parameter Format
• Updating PyTower
  • Recommended Steps
  • Alternative Installs
• Backing‐up Canvases Using PyTower
• Fixing Canvases Using PyTower
  • Initial Installation
  • Instructions
    • Verify PyTower Installation
    • Setting Tower Unite install path in PyTower
    • Running pytower fix
  • Troubleshooting
    • “Marked 0/### files for reupload” or “XXX is online but returned status code: ###”
    • “Error while uploading file: HTTPSConnectionPool(host=’catbox.moe’, port=443): Max retries exceeded […]”
• Tool Scripts: Getting Started
  • General Information
  • Tool Script Anatomy
  • Where do I start?
• Tool Script Directives
• API
  • pytower
    • pytower.backup
      • BackupIndex
        • BackupIndex.__init__()
        • BackupIndex.filename
        • BackupIndex.original_path
        • BackupIndex.pytower_version
        • BackupIndex.resources
        • BackupIndex.to_dict()
      • fix_canvases()
      • make_backup()
      • restore_backup()
    • pytower.blueprint
      • make_blueprint()
      • place_blueprint()
    • pytower.config
      • CONFIG
      • TowerConfig
        • TowerConfig.__getitem__()
        • TowerConfig.__init__()
        • TowerConfig.get()
        • TowerConfig.keys()
        • TowerConfig.set()
    • pytower.connections
      • pytower.connections.condo_io
        • Button
          • Button.__init__()
        • Clock
          • Clock.__init__()
        • CondoIO
          • CondoIO.__getattr__()
          • CondoIO.__init__()
          • CondoIO.connect()
          • CondoIO.connect_to_event()
          • CondoIO.events
          • CondoIO.get_event()
        • Counter
          • Counter.__init__()
        • GameWorldEvents
          • GameWorldEvents.__init__()
        • HitTargetVolume
          • HitTargetVolume.__init__()
        • LightSwitch
          • LightSwitch.__init__()
        • Mover
          • Mover.__init__()
        • PhysicsSlot
          • PhysicsSlot.__init__()
        • PlayerEvents
          • PlayerEvents.__init__()
        • Random
          • Random.__init__()
        • Relay
          • Relay.__init__()
        • Timer
          • Timer.__init__()
        • Toggle
          • Toggle.__init__()
        • TriggerVolume
          • TriggerVolume.__init__()
      • pytower.connections.connections
        • FItemDataType
          • FItemDataType.COLOR
          • FItemDataType.DROPDOWN
          • FItemDataType.NONE
          • FItemDataType.TU_BOOL
          • FItemDataType.TU_FLOAT
          • FItemDataType.TU_INT
          • FItemDataType.URL
          • FItemDataType.__repr__()
        • ItemConnectionData
          • ItemConnectionData.__dataclass_fields__
          • ItemConnectionData.__dataclass_params__
          • ItemConnectionData.__eq__()
          • ItemConnectionData.__hash__
          • ItemConnectionData.__init__()
          • ItemConnectionData.__match_args__
          • ItemConnectionData.__repr__()
          • ItemConnectionData.data
          • ItemConnectionData.data_type
        • ItemConnectionObject
          • ItemConnectionObject.__init__()
          • ItemConnectionObject.__iter__()
          • ItemConnectionObject.data
          • ItemConnectionObject.get_data()
          • ItemConnectionObject.get_datatype()
          • ItemConnectionObject.get_delay()
          • ItemConnectionObject.get_dict()
          • ItemConnectionObject.get_event_name()
          • ItemConnectionObject.get_item_guid()
          • ItemConnectionObject.get_listener_event_name()
          • ItemConnectionObject.set_data()
          • ItemConnectionObject.set_datatype()
          • ItemConnectionObject.set_delay()
          • ItemConnectionObject.set_dict()
          • ItemConnectionObject.set_event_name()
          • ItemConnectionObject.set_item_guid()
          • ItemConnectionObject.set_listener_event_name()
          • ItemConnectionObject.to_dict()
      • pytower.connections.events
        • Event
          • Event.__init__()
          • Event.connect()
          • Event.event_name
    • pytower.copy
      • copy_selection()
      • fitem_guid()
      • replace_guids()
    • pytower.image_backends
      • pytower.image_backends.backend
        • ResourceBackend
          • ResourceBackend.__init__()
          • ResourceBackend.upload_file()
          • ResourceBackend.upload_files()
      • pytower.image_backends.catbox
        • CatboxBackend
          • CatboxBackend.__init__()
          • CatboxBackend.upload_file()
          • CatboxBackend.upload_files()
      • pytower.image_backends.custom
        • CustomBackend
          • CustomBackend.__init__()
          • CustomBackend.upload_file()
          • CustomBackend.upload_files()
      • pytower.image_backends.imgur
        • ImgurBackend
          • ImgurBackend.__init__()
          • ImgurBackend.upload_file()
          • ImgurBackend.upload_files()
    • pytower.logging
      • ColorFormatter
        • ColorFormatter.LOG_COLORS
        • ColorFormatter.__init__()
        • ColorFormatter.format()
      • critical()
      • debug()
      • error()
      • info()
      • log()
      • logging_init()
      • success()
      • warning()
    • pytower.mesh
      • OctreeBVH
        • OctreeBVH.__init__()
        • OctreeBVH.add_point()
      • OctreeNode
        • OctreeNode.__init__()
        • OctreeNode.contains()
        • OctreeNode.traverse()
      • TextureBake
        • TextureBake.TEMP_FILENAME
        • TextureBake.__init__()
        • TextureBake.add_triangle()
        • TextureBake.upload()
      • TextureBakeCollection
        • TextureBakeCollection.__init__()
        • TextureBakeCollection.add_triangle()
        • TextureBakeCollection.upload()
      • TowerMesh
        • TowerMesh.__init__()
        • TowerMesh.get_color()
        • TowerMesh.get_material_id()
        • TowerMesh.get_triangle_color()
        • TowerMesh.get_triangles()
        • TowerMesh.get_uvs()
      • TriangleTextureInfo
        • TriangleTextureInfo.__init__()
      • convert_triangle()
      • divide_triangle()
      • load_mesh()
    • pytower.object
      • TowerObject
        • TowerObject.__init__()
        • TowerObject.__lt__()
        • TowerObject.__repl__()
        • TowerObject.__str__()
        • TowerObject.add_connection()
        • TowerObject.compress()
        • TowerObject.connect_to()
        • TowerObject.copy()
        • TowerObject.custom_name
        • TowerObject.deserialize_objects()
        • TowerObject.get_connections()
        • TowerObject.get_custom_name()
        • TowerObject.get_name()
        • TowerObject.get_property()
        • TowerObject.group_id
        • TowerObject.guid
        • TowerObject.is_canvas()
        • TowerObject.matches_name()
        • TowerObject.metadata_scale
        • TowerObject.name
        • TowerObject.position
        • TowerObject.rotation
        • TowerObject.scale
        • TowerObject.set_connections()
        • TowerObject.set_group_id()
        • TowerObject.set_meta_property()
        • TowerObject.set_property()
        • TowerObject.ungroup()
        • TowerObject.url
      • spec_keys()
    • pytower.selection
      • BoxSelector
        • BoxSelector.__init__()
        • BoxSelector.select()
      • CompositionSelector
        • CompositionSelector.__init__()
        • CompositionSelector.select()
      • CustomNameSelector
        • CustomNameSelector.__init__()
        • CustomNameSelector.select()
      • DifferenceSelector
        • DifferenceSelector.__init__()
        • DifferenceSelector.select()
      • EverythingSelector
        • EverythingSelector.__init__()
        • EverythingSelector.select()
      • GroupSelector
        • GroupSelector.__init__()
        • GroupSelector.select()
      • IntersectionSelector
        • IntersectionSelector.__init__()
        • IntersectionSelector.select()
      • ItemSelector
        • ItemSelector.__init__()
        • ItemSelector.select()
      • NameSelector
        • NameSelector.__init__()
        • NameSelector.select()
      • NothingSelector
        • NothingSelector.__init__()
        • NothingSelector.select()
      • ObjectNameSelector
        • ObjectNameSelector.__init__()
        • ObjectNameSelector.select()
      • PercentSelector
        • PercentSelector.__init__()
        • PercentSelector.select()
      • RandomSelector
        • RandomSelector.__init__()
        • RandomSelector.select()
      • RegexSelector
        • RegexSelector.__init__()
        • RegexSelector.select()
      • Selection
        • Selection.__add__()
        • Selection.__hash__()
        • Selection.__iadd__()
        • Selection.__imul__()
        • Selection.__isub__()
        • Selection.__mul__()
        • Selection.__sub__()
        • Selection.centroid
        • Selection.destroy_groups()
        • Selection.get()
        • Selection.group()
        • Selection.group_id
        • Selection.groups()
        • Selection.to_dict()
        • Selection.ungrouped()
      • Selector
        • Selector.__init__()
        • Selector.__repr__()
        • Selector.select()
      • SphereSelector
        • SphereSelector.__init__()
        • SphereSelector.select()
      • TakeSelector
        • TakeSelector.__init__()
        • TakeSelector.select()
      • UnionSelector
        • UnionSelector.__init__()
        • UnionSelector.select()
    • pytower.suitebro
      • Suitebro
        • Suitebro.objects
        • Suitebro.__init__()
        • Suitebro.__iter__()
        • Suitebro.__repl__()
        • Suitebro.add_object()
        • Suitebro.add_objects()
        • Suitebro.find_item()
        • Suitebro.get_max_groupid()
        • Suitebro.group()
        • Suitebro.groups()
        • Suitebro.inventory_count()
        • Suitebro.inventory_items()
        • Suitebro.item_count()
        • Suitebro.items()
        • Suitebro.remove_object()
        • Suitebro.to_dict()
      • get_active_save()
      • get_suitebro_path()
      • load_suitebro()
      • pretty_path()
      • run_suitebro_parser()
      • save_suitebro()
    • pytower.tool_lib
      • ParameterDict
        • ParameterDict.__getattr__()
      • ToolMetadata
        • ToolMetadata.T
        • ToolMetadata.__init__()
        • ToolMetadata.attr_or_default()
        • ToolMetadata.from_dict()
        • ToolMetadata.get_info()
        • ToolMetadata.strattr_or_default()
        • ToolMetadata.to_dict()
      • ToolParameterInfo
        • ToolParameterInfo.__init__()
        • ToolParameterInfo.from_dict()
        • ToolParameterInfo.to_dict()
      • get_indexed_tools()
      • get_tool_scripts()
      • load_tool()
      • load_tools()
      • make_tools_index()
    • pytower.tools
      • pytower.tools.center
        • main()
      • pytower.tools.convert_mesh
        • main()
      • pytower.tools.count
        • main()
      • pytower.tools.cylinder
        • main()
      • pytower.tools.destroy_groups
        • main()
      • pytower.tools.duplicate
        • main()
      • pytower.tools.filter
        • main()
      • pytower.tools.grouper
        • main()
      • pytower.tools.replace
        • main()
        • should_replace()
      • pytower.tools.replace_url
        • main()
        • should_replace()
      • pytower.tools.rotate
        • main()
      • pytower.tools.scale
        • main()
      • pytower.tools.set
        • main()
      • pytower.tools.set_url
        • main()
      • pytower.tools.sphere
        • main()
      • pytower.tools.tile
        • main()
      • pytower.tools.translate
        • main()
    • pytower.tower
      • PyTowerParser
        • PyTowerParser.add_subparsers()
        • PyTowerParser.error()
      • backup()
      • config_confirm_show()
      • convert()
      • find_tool()
      • fix()
      • get_parser()
      • get_resource_backends()
      • get_tool_names()
      • info_tool()
      • list_tools()
      • main()
      • parse_args()
      • parse_parameters()
      • parse_resource_backend()
      • parse_selector()
      • parse_selectors()
      • run()
      • scan()
      • version()
    • pytower.util
      • XYZ
        • XYZ.EPSILON
        • XYZ.__eq__()
        • XYZ.__getitem__()
        • XYZ.__hash__
        • XYZ.__new__()
        • XYZ.clamp()
        • XYZ.distance()
        • XYZ.fold()
        • XYZ.max()
        • XYZ.min()
        • XYZ.norm()
        • XYZ.normalize()
        • XYZ.py_dtype
        • XYZ.to_dict()
        • XYZ.x
        • XYZ.y
        • XYZ.z
      • XYZInt
        • XYZInt.py_dtype
      • XYZW
        • XYZW.__new__()
        • XYZW.to_dict()
        • XYZW.w
      • dict_walk()
      • not_none()
      • read_bytearray()
      • run_if_not_none()
      • xyz()
      • xyz_to_string()
      • xyzint()