def add_from_object_set(self,
object_set_index: int,
graphic_set_index: int = -1):
if graphic_set_index == -1:
graphic_set_index = object_set_index
factory = LevelObjectFactory(object_set_index,
graphic_set_index,
0, [],
vertical_level=False,
size_minimal=True)
object_ids = list(range(0x00, 0x10)) + list(
range(0x10, MAX_ID_VALUE, 0x10))
for domain, obj_index in product(range(MAX_DOMAIN + 1), object_ids):
level_object = factory.from_properties(domain=domain,
object_index=obj_index,
x=0,
y=0,
length=None,
index=0)
if not isinstance(level_object,
LevelObject) or level_object.name in [
"MSG_NOTHING", "MSG_CRASH"
]:
continue
self.add_object(level_object)
def test_object_rendering_8_1(object_index, qtbot):
object_factory = LevelObjectFactory(UNDERGROUND_OBJECT_SET, UNDERGROUND_GRAPHICS_SET, 0, [], False)
object_domain = 0x00
level_object = object_factory.from_properties(object_domain, object_index, 0, 0, None, 0)
_test_object_against_reference(level_object, qtbot)
def test_no_change_to_bytes():
object_factory = LevelObjectFactory(1, 1, 0, [], False)
cloud_bytes = bytearray([0x00, 0x00, 0xE5])
cloud_object = object_factory.from_data(cloud_bytes, 0)
assert cloud_object.to_bytes() == cloud_bytes
def test_object_rendering_2_1(object_index, domain, object_set, graphic_set,
qtbot):
object_factory = LevelObjectFactory(object_set, graphic_set, 0, [], False)
level_object = object_factory.from_properties(domain, object_index, 0, 0,
None, 0)
_test_object_against_reference(level_object, qtbot)
def test_object_rendering_4_2(domain, object_index, qtbot):
object_factory = LevelObjectFactory(HILLY_OBJECT_SET, HILLY_GRAPHICS_SET,
0, [], False)
level_object = object_factory.from_properties(domain, object_index, 0, 0,
None, 0)
_test_object_against_reference(level_object, qtbot)
def test_change_attribute_to_bytes(attribute, increase):
object_factory = LevelObjectFactory(1, 1, 0, [], False)
cloud_object = object_factory.from_properties(0x00, 0xE0, 0, 0, None, 0)
initial_bytes = cloud_object.to_bytes()
setattr(cloud_object, attribute, getattr(cloud_object, attribute) + increase)
assert cloud_object.to_bytes() != initial_bytes
def __init__(self, parent, object_set, graphic_set=1, palette_index=0):
super(ObjectDrawArea, self).__init__(parent)
self.object_factory = LevelObjectFactory(object_set,
graphic_set,
palette_index, [],
False,
size_minimal=True)
self.current_object = self.object_factory.from_data(
bytearray([0x0, 0x0, 0x0]), 0)
self.update_object()
self.resize(QSize())
def test_object_icon(domain, obj_index, qtbot):
factory = LevelObjectFactory(PLAINS_OBJECT_SET, PLAINS_GRAPHICS_SET, 0, [], False, True)
level_object = factory.from_properties(domain, obj_index, 0, 0, None, 0)
widget = QWidget()
widget.setLayout(QVBoxLayout())
widget.layout().addStretch()
widget.layout().addWidget(ObjectIcon(level_object))
widget.layout().addStretch()
widget.show()
widget.adjustSize()
qtbot.wait_for_window_shown(widget)
def _parse_header(self):
self.header = LevelHeader(self.header_bytes, self.object_set_number)
self.object_factory = LevelObjectFactory(
self.object_set_number,
self.header.graphic_set_index,
self.header.object_palette_index,
self.objects,
bool(self.header.is_vertical),
)
self.enemy_item_factory = EnemyItemFactory(
self.object_set_number, self.header.enemy_palette_index)
self.size = self.header.width, self.header.height
self.data_changed.emit()
def gen_object_factories():
ROM(root_dir.joinpath("SMB3.nes"))
for object_set in range(MAX_OBJECT_SET + 1):
if object_set in [WORLD_MAP_OBJECT_SET, MUSHROOM_OBJECT_SET, SPADE_BONUS_OBJECT_SET]:
continue
yield LevelObjectFactory(object_set, object_set, 0, [], False)
def set_object_set(self, object_set_index: int,
graphic_set_index: int) -> None:
factory = LevelObjectFactory(object_set_index,
graphic_set_index,
0, [],
vertical_level=False,
size_minimal=True)
self._on_object_factory_change(factory)
def _load_level_data(self,
object_data: bytearray,
enemy_data: bytearray,
new_level: bool = True):
self.object_factory = LevelObjectFactory(
self.object_set_number,
self.header.graphic_set_index,
self.header.object_palette_index,
self.objects,
bool(self.header.is_vertical),
)
self.enemy_item_factory = EnemyItemFactory(
self.object_set_number, self.header.enemy_palette_index)
self._load_objects(object_data)
self._load_enemies(enemy_data)
if new_level:
self._update_level_size()
self.undo_stack.clear(self.to_bytes())
self._signal_emitter.data_changed.emit()
class ObjectDrawArea(QWidget):
def __init__(self, parent, object_set, graphic_set=1, palette_index=0):
super(ObjectDrawArea, self).__init__(parent)
self.object_factory = LevelObjectFactory(object_set,
graphic_set,
palette_index, [],
False,
size_minimal=True)
self.current_object = self.object_factory.from_data(
bytearray([0x0, 0x0, 0x0]), 0)
self.update_object()
self.resize(QSize())
def change_object_set(self, object_set: int):
self.object_factory.set_object_set(object_set)
self.update_object()
def change_graphic_set(self, graphic_set: int):
self.object_factory.set_graphic_set(graphic_set)
self.update_object()
def resize(self, size: QSize):
if isinstance(self.current_object, Jump):
return
self.setMinimumSize(
QSize(self.current_object.rendered_width * Block.WIDTH,
self.current_object.rendered_height * Block.HEIGHT))
def update_object(self,
object_data: Union[bytearray, LevelObject, Jump] = None):
if object_data is None:
object_data = self.current_object.data
elif isinstance(object_data, (LevelObject, Jump)):
object_data = object_data.data
self.current_object = self.object_factory.from_data(object_data, 0)
self.resize(QSize())
self.update()
def paintEvent(self, event: QPaintEvent):
if not isinstance(self.current_object, LevelObject):
return
painter = QPainter(self)
painter.translate(
QPoint(-Block.WIDTH * self.current_object.rendered_base_x,
-Block.HEIGHT * self.current_object.rendered_base_y))
self.current_object.draw(painter, Block.WIDTH, transparent=True)
class Level(LevelLike):
MIN_LENGTH = 0x10
offsets, world_indexes = _load_level_offsets()
sorted_offsets = sorted(offsets, key=lambda level: level.rom_level_offset)
WORLDS = len(world_indexes)
HEADER_LENGTH = 9 # bytes
def __init__(self, level_name: str, layout_address: int,
enemy_data_offset: int, object_set_number: int):
super(Level, self).__init__(object_set_number, layout_address)
self._signal_emitter = LevelSignaller()
self.attached_to_rom = True
self.object_set = ObjectSet(object_set_number)
self.undo_stack = UndoStack()
self.name = level_name
self.header_offset = layout_address
self.enemy_offset = enemy_data_offset
self.objects: List[LevelObject] = []
self.jumps: List[Jump] = []
self.enemies: List[EnemyObject] = []
rom = ROM()
self.header_bytes = rom.bulk_read(Level.HEADER_LENGTH,
self.header_offset)
self._parse_header()
self.object_offset = self.header_offset + Level.HEADER_LENGTH
object_data = ROM.rom_data[self.object_offset:]
enemy_data = ROM.rom_data[self.enemy_offset:]
self._load_level_data(object_data, enemy_data)
self.changed = False
def _load_level_data(self,
object_data: bytearray,
enemy_data: bytearray,
new_level: bool = True):
self._load_objects(object_data)
self._load_enemies(enemy_data)
if new_level:
self._update_level_size()
self.undo_stack.clear(self.to_bytes())
self._signal_emitter.data_changed.emit()
@property
def width(self):
return self.size[0]
@property
def height(self):
return self.size[1]
@property
def data_changed(self):
return self._signal_emitter.data_changed
@property
def jumps_changed(self):
return self._signal_emitter.jumps_changed
def reload(self):
(_, header_and_object_data), (_, enemy_data) = self.to_bytes()
self.header_bytes = header_and_object_data[:Level.HEADER_LENGTH]
object_data = header_and_object_data[Level.HEADER_LENGTH:]
self._parse_header()
self._load_level_data(object_data, enemy_data, new_level=False)
self.data_changed.emit()
def current_object_size(self):
size = 0
for obj in self.objects:
if obj.is_4byte:
size += 4
else:
size += 3
size += Jump.SIZE * len(self.jumps)
return size
def current_enemies_size(self):
return len(self.enemies) * ENEMY_SIZE
def _parse_header(self):
self.header = LevelHeader(self.header_bytes, self.object_set_number)
self.object_factory = LevelObjectFactory(
self.object_set_number,
self.header.graphic_set_index,
self.header.object_palette_index,
self.objects,
bool(self.header.is_vertical),
)
self.enemy_item_factory = EnemyItemFactory(
self.object_set_number, self.header.enemy_palette_index)
self.size = self.header.width, self.header.height
self.data_changed.emit()
def _load_enemies(self, data: bytearray):
self.enemies.clear()
def data_left(_data: bytearray):
# the commented out code seems to hold for the stock ROM, but if the ROM was already edited with another
# editor, it might not, since they only wrote the 0xFF to end the enemy data
return _data and not _data[
0] == 0xFF # and _data[1] in [0x00, 0x01]
enemy_data, data = data[0:ENEMY_SIZE], data[ENEMY_SIZE:]
while data_left(enemy_data):
enemy = self.enemy_item_factory.from_data(enemy_data, 0)
self.enemies.append(enemy)
enemy_data, data = data[0:ENEMY_SIZE], data[ENEMY_SIZE:]
def _load_objects(self, data: bytearray):
self.objects.clear()
self.jumps.clear()
if not data or data[0] == 0xFF:
return
while True:
obj_data, data = data[0:3], data[3:]
domain = (obj_data[0] & 0b1110_0000) >> 5
obj_id = obj_data[2]
has_length_byte = self.object_set.get_object_byte_length(
domain, obj_id) == 4
if has_length_byte:
fourth_byte, data = data[0], data[1:]
obj_data.append(fourth_byte)
level_object = self.object_factory.from_data(
obj_data, len(self.objects))
if isinstance(level_object, LevelObject):
self.objects.append(level_object)
elif isinstance(level_object, Jump):
self.jumps.append(level_object)
if data[0] == 0xFF:
break
def _update_level_size(self):
self.object_size_on_disk = self.current_object_size()
self.enemy_size_on_disk = self.current_enemies_size()
@property
def size_on_disk(self):
return self.object_size_on_disk + self.enemy_size_on_disk
def get_rect(self, block_length: int = 1):
width, height = self.size
return QRect(QPoint(0, 0), QSize(width, height) * block_length)
def attach_to_rom(self, header_offset: int, enemy_item_offset: int):
self.header_offset = header_offset
self.object_offset = self.header_offset + Level.HEADER_LENGTH
self.enemy_offset = enemy_item_offset
self.attached_to_rom = True
def was_saved(self):
self._update_level_size()
@property
def objects_end(self):
return self.header_offset + Level.HEADER_LENGTH + self.current_object_size(
) + len(b"\xFF") # the delimiter
@property
def enemies_end(self):
return self.enemy_offset + self.current_enemies_size() + len(
b"\xFF\x00") # the delimiter
@property
def next_area_objects(self):
return self.header.jump_level_address
@next_area_objects.setter
def next_area_objects(self, value):
if value == self.header.jump_level_address:
return
value -= LEVEL_POINTER_OFFSET + self.header.jump_object_set.level_offset
self.header_bytes[0] = 0x00FF & value
self.header_bytes[1] = value >> 8
self._parse_header()
@property
def has_next_area(self):
return self.header_bytes[0] + self.header_bytes[1] != 0
@property
def next_area_enemies(self):
return self.header.jump_enemy_address
@next_area_enemies.setter
def next_area_enemies(self, value):
if value == self.header.jump_enemy_address:
return
value -= BASE_OFFSET
self.header_bytes[2] = 0x00FF & value
self.header_bytes[3] = value >> 8
self._parse_header()
@property
def start_y_index(self):
return self.header.start_y_index
@start_y_index.setter
def start_y_index(self, index):
if index == self.header.start_y_index:
return
self.header_bytes[4] &= 0b0001_1111
self.header_bytes[4] |= index << 5
self._parse_header()
# bit 4 unused
@property
def length(self):
return self.header.length
@length.setter
def length(self, length):
"""
Sets the length of the level in "screens".
:param length: amount of screens the level should have
:return:
"""
if length == self.header.length:
return
# screens are 0 indexed, minimum is 1
self.header_bytes[4] &= 0b1111_0000
self.header_bytes[4] |= (length // 0x10) - 1
self._parse_header()
# bit 1 unused
@property
def start_x_index(self):
return self.header.start_x_index
@start_x_index.setter
def start_x_index(self, index):
if index == self.header.start_x_index:
return
self.header_bytes[5] &= 0b1001_1111
self.header_bytes[5] |= index << 5
self._parse_header()
@property
def enemy_palette_index(self):
return self.header.enemy_palette_index
@enemy_palette_index.setter
def enemy_palette_index(self, index):
if index == self.header.enemy_palette_index:
return
self.header_bytes[5] &= 0b1110_0111
self.header_bytes[5] |= index << 3
self._parse_header()
@property
def object_palette_index(self):
return self.header.object_palette_index
@object_palette_index.setter
def object_palette_index(self, index):
if index == self.header.object_palette_index:
return
self.header_bytes[5] &= 0b1111_1000
self.header_bytes[5] |= index
self._parse_header()
self.reload()
@property
def pipe_ends_level(self):
return self.header.pipe_ends_level
@pipe_ends_level.setter
def pipe_ends_level(self, truth_value):
if truth_value == self.header.pipe_ends_level:
return
self.header_bytes[6] &= 0b0111_1111
self.header_bytes[6] |= int(not truth_value) << 7
self._parse_header()
@property
def scroll_type(self):
return self.header.scroll_type_index
@scroll_type.setter
def scroll_type(self, index):
if index == self.header.scroll_type_index:
return
self.header_bytes[6] &= 0b1001_1111
self.header_bytes[6] |= index << 5
self._parse_header()
@property
def is_vertical(self):
return bool(self.header.is_vertical)
@is_vertical.setter
def is_vertical(self, truth_value):
if truth_value == self.header.is_vertical:
return
self.header_bytes[6] &= 0b1110_1111
self.header_bytes[6] |= int(truth_value) << 4
self._parse_header()
@property
def next_area_object_set(self):
return self.header.jump_object_set_number
@next_area_object_set.setter
def next_area_object_set(self, index):
if index == self.header.jump_object_set_number:
return
self.header_bytes[6] &= 0b1111_0000
self.header_bytes[6] |= index
self._parse_header()
@property
def start_action(self):
return self.header.start_action
@start_action.setter
def start_action(self, index):
if index == self.header.start_action:
return
self.header_bytes[7] &= 0b0001_1111
self.header_bytes[7] |= index << 5
self._parse_header()
@property
def graphic_set(self):
return self.header.graphic_set_index
@graphic_set.setter
def graphic_set(self, index):
if index == self.header.graphic_set_index:
return
self.header_bytes[7] &= 0b1110_0000
self.header_bytes[7] |= index
self._parse_header()
self.reload()
@property
def time_index(self):
return self.header.time_index
@time_index.setter
def time_index(self, index):
if index == self.header.time_index:
return
self.header_bytes[8] &= 0b0011_1111
self.header_bytes[8] |= index << 6
self._parse_header()
# bit 3 and 4 unused
@property
def music_index(self):
return self.header.music_index
@music_index.setter
def music_index(self, index):
if index == self.header.music_index:
return
self.header_bytes[8] &= 0b1111_0000
self.header_bytes[8] |= index
self._parse_header()
def is_too_big(self):
return self.too_many_level_objects() or self.too_many_enemies_or_items(
)
def too_many_level_objects(self):
return self.current_object_size() > self.object_size_on_disk
def too_many_enemies_or_items(self):
return self.current_enemies_size() > self.enemy_size_on_disk
def get_all_objects(self) -> List[Union[LevelObject, EnemyObject]]:
return self.objects + self.enemies
def get_object_names(self):
return [obj.description for obj in self.get_all_objects()]
def object_at(self, x: int,
y: int) -> Optional[Union[EnemyObject, LevelObject]]:
for obj in reversed(self.get_all_objects()):
if (x, y) in obj:
return obj
else:
return None
def bring_to_foreground(self, objects: List[Union[LevelObject,
EnemyObject]]):
for obj in objects:
intersecting_objects = self.get_intersecting_objects(obj)
object_currently_in_the_foreground: Union[
LevelObject, EnemyObject] = intersecting_objects[-1]
if obj is object_currently_in_the_foreground:
continue
if isinstance(obj, LevelObject):
objects = self.objects
elif isinstance(obj, EnemyObject):
objects = self.enemies
objects.remove(obj)
index = objects.index(object_currently_in_the_foreground) + 1
objects.insert(index, obj)
def bring_to_background(self, level_objects: List[Union[LevelObject,
EnemyObject]]):
for obj in level_objects:
intersecting_objects = self.get_intersecting_objects(obj)
object_currently_in_the_background: Union[
LevelObject, EnemyObject] = intersecting_objects[0]
if obj is object_currently_in_the_background:
continue
if isinstance(obj, LevelObject):
objects = self.objects
elif isinstance(obj, EnemyObject):
objects = self.enemies
else:
raise TypeError()
objects.remove(obj)
index = objects.index(object_currently_in_the_background)
objects.insert(index, obj)
@overload
def get_intersecting_objects(self, obj: LevelObject) -> List[LevelObject]:
...
@overload
def get_intersecting_objects(self, obj: EnemyObject) -> List[EnemyObject]:
...
def get_intersecting_objects(
self, obj: Union[LevelObject, EnemyObject]
) -> Union[List[LevelObject], List[EnemyObject]]:
"""
Returns all objects of the same type, that overlap the rectangle of the given object, including itself. The
objects are in the order, that they appear in, in memory, meaning back to front.
:param obj: The object to check overlaps for.
:return:
"""
if isinstance(obj, LevelObject):
objects_to_check = self.objects
elif isinstance(obj, EnemyObject):
objects_to_check = self.enemies
else:
raise TypeError()
intersecting_objects = []
for other_object in objects_to_check:
if obj.get_rect().intersects(other_object.get_rect()):
intersecting_objects.append(other_object)
return intersecting_objects
def draw(self, *_):
pass
def paste_object_at(
self, x: int, y: int,
obj: Union[EnemyObject,
LevelObject]) -> Union[EnemyObject, LevelObject]:
if isinstance(obj, EnemyObject):
return self.add_enemy(obj.obj_index, x, y)
elif isinstance(obj, LevelObject):
if obj.is_4byte:
length: Optional[int] = obj.data[3]
else:
length = None
return self.add_object(obj.domain, obj.obj_index, x, y, length)
def create_object_at(self,
x: int,
y: int,
domain: int = 0,
object_index: int = 0):
self.add_object(domain, object_index, x, y, None, len(self.objects))
def create_enemy_at(self, x: int, y: int):
# goomba to have something to display
self.add_enemy(0x72, x, y, len(self.enemies))
def add_object(self,
domain: int,
object_index: int,
x: int,
y: int,
length: Optional[int],
index: int = -1) -> LevelObject:
if index == -1:
index = len(self.objects)
obj = self.object_factory.from_properties(domain, object_index, x, y,
length, index)
self.objects.insert(index, obj)
return obj
def add_enemy(self,
object_index: int,
x: int,
y: int,
index: int = -1) -> EnemyObject:
if index == -1:
index = len(self.enemies)
else:
index %= len(self.objects)
enemy = self.enemy_item_factory.from_data([object_index, x, y], -1)
self.enemies.insert(index, enemy)
return enemy
def add_jump(self):
self.jumps.append(Jump.from_properties(0, 0, 0, 0))
self.data_changed.emit()
def remove_jump(self, jump: Jump):
self.jumps.remove(jump)
self.data_changed.emit()
def index_of(self, obj: Union[EnemyObject, LevelObject]) -> int:
if isinstance(obj, LevelObject):
return self.objects.index(obj)
elif isinstance(obj, EnemyObject):
return len(self.objects) + self.enemies.index(obj)
else:
raise TypeError("Given Object was not EnemyObject or LevelObject.")
def get_object(self, index: int):
if index < len(self.objects):
return self.objects[index]
else:
return self.enemies[index % len(self.objects)]
def remove_object(self, obj: Union[EnemyObject, LevelObject]):
if obj is None:
return
if isinstance(obj, LevelObject):
self.objects.remove(obj)
elif isinstance(obj, EnemyObject):
self.enemies.remove(obj)
def to_m3l(self) -> bytearray:
world_number = level_number = 1
m3l_bytes = bytearray()
m3l_bytes.append(world_number)
m3l_bytes.append(level_number)
m3l_bytes.append(self.object_set_number)
m3l_bytes.extend(self.header_bytes)
for obj in self.objects + self.jumps:
m3l_bytes.extend(obj.to_bytes())
# only write 0xFF, even though the stock ROM would use 0xFF00 or 0xFF01
# this is done to keep compatibility to older editors
m3l_bytes.append(0xFF)
m3l_bytes.append(0x01)
for enemy in sorted(self.enemies,
key=lambda _enemy: _enemy.x_position):
m3l_bytes.extend(enemy.to_bytes())
m3l_bytes.append(0xFF)
return m3l_bytes
def from_m3l(self, m3l_bytes: bytearray):
world_number, level_number, self.object_set_number = m3l_bytes[:3]
self.object_set = ObjectSet(self.object_set_number)
self.header_offset = self.enemy_offset = 0
# update the level_object_factory
self._load_level_data(bytearray(), bytearray())
m3l_bytes = m3l_bytes[3:]
self.header_bytes = m3l_bytes[:Level.HEADER_LENGTH]
self._parse_header()
m3l_bytes = m3l_bytes[Level.HEADER_LENGTH:]
# figure out how many bytes are the objects
self._load_objects(m3l_bytes)
object_size = self.current_object_size() + len(b"\xFF") # delimiter
object_bytes = m3l_bytes[:object_size]
enemy_bytes = m3l_bytes[object_size:]
if len(enemy_bytes) % 3 - len(b"\xFF") == 1:
# compatibility with workshop
enemy_bytes = enemy_bytes[1:]
self._load_level_data(object_bytes, enemy_bytes)
self.attached_to_rom = False
def to_bytes(self) -> LevelByteData:
data = bytearray()
data.extend(self.header_bytes)
for obj in self.objects:
data.extend(obj.to_bytes())
for jump in self.jumps:
data.extend(jump.to_bytes())
data.append(0xFF)
enemies = bytearray()
if self.is_vertical:
enemies_objects = sorted(self.enemies,
key=lambda _enemy: _enemy.y_position)
else:
enemies_objects = sorted(self.enemies,
key=lambda _enemy: _enemy.x_position)
for enemy in enemies_objects:
enemies.extend(enemy.to_bytes())
enemies.append(0xFF)
return (self.header_offset, data), (self.enemy_offset, enemies)
def from_bytes(self,
object_data: Tuple[int, bytearray],
enemy_data: Tuple[int, bytearray],
new_level=True):
self.header_offset, object_bytes = object_data
self.enemy_offset, enemies = enemy_data
self.header_bytes = object_bytes[0:Level.HEADER_LENGTH]
objects = object_bytes[Level.HEADER_LENGTH:]
self._parse_header()
self._load_level_data(objects, enemies, new_level)
def test_ending_object(object_set, graphics_set, qtbot):
object_factory = LevelObjectFactory(object_set, graphics_set, 0, [], False)
ending_object = object_factory.from_properties(0x2, 0x09, 0, 0, None, 0)
_test_object_against_reference(ending_object, qtbot)
