├── .gitattributes ├── requirements.txt ├── python ├── example.py ├── fuiDataStructures │ ├── fuiObject.py │ ├── fuiVert.py │ ├── fuiTimelineEventName.py │ ├── fuiImportAsset.py │ ├── fuiFontName.py │ ├── fuiFillStyle.py │ ├── fuiMatrix.py │ ├── fuiReference.py │ ├── fuiTimelineFrame.py │ ├── fuiColorTransform.py │ ├── fuiSymbol.py │ ├── fuiShape.py │ ├── fuiShapeComponent.py │ ├── fuiTimelineAction.py │ ├── fuiRect.py │ ├── fuiTimeline.py │ ├── fuiBitmap.py │ ├── fuiHeader.py │ ├── fuiEdittext.py │ └── fuiTimelineEvent.py ├── fuiBuilder.py ├── fuiUtil.py ├── fuiFile.py ├── fuiInfoDumper.py └── fuiParser.py ├── .gitignore ├── README.md ├── DOCUMENTATION.md └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto 2 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | opencv-python==4.5.4.60 2 | numpy==1.21.4 3 | -------------------------------------------------------------------------------- /python/example.py: -------------------------------------------------------------------------------- 1 | import sys 2 | 3 | from fuiParser import fuiParser 4 | 5 | def main(): 6 | parser = fuiParser(sys.argv[1]) 7 | print(parser) 8 | 9 | 10 | if __name__ == "__main__" and len(sys.argv) > 1: 11 | main() -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # fui 2 | *.fui 3 | # fui backup file from Hxd 4 | *.fui.* 5 | 6 | # python cache 7 | /**/__pycache__ 8 | 9 | # VS Code & Visual Studio cofig folder 10 | /**/.vs 11 | /**/.vscode 12 | 13 | # misc 14 | /**/*.bin 15 | /**/*.d 16 | /dump_output 17 | /Media 18 | -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiObject.py: -------------------------------------------------------------------------------- 1 | import abc 2 | 3 | class eFuiObjectType: 4 | STAGE = 0 5 | SHAPE = 1 6 | TIMELINE = 2 7 | BITMAP = 3 8 | REFERENCE = 4 9 | EDITTEXT = 5 10 | CODEGENRECT = 6 11 | 12 | class fuiObject(metaclass=abc.ABCMeta): 13 | fmt:str 14 | @abc.abstractmethod 15 | def __init__(self, bytes:bytes) -> None: ... 16 | @abc.abstractmethod 17 | def pack(self) -> bytes: ... -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiVert.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | @dataclass(init=False) 7 | class fuiVert(fuiObject): 8 | fmt = "<2f" 9 | size = struct.calcsize(fmt) 10 | 11 | x:float 12 | y:float 13 | 14 | def __init__(self, raw_bytes:bytes): 15 | self.x, self.y = struct.unpack(self.fmt, raw_bytes) 16 | 17 | def pack(self) -> bytes: 18 | return struct.pack(self.fmt, self.x, self.y) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiTimelineEventName.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | @dataclass(init=False) 7 | class fuiTimelineEventName(fuiObject): 8 | fmt = "<64s" 9 | size = struct.calcsize(fmt) 10 | 11 | name:str 12 | 13 | def __init__(self, raw_bytes:bytes): 14 | self.name = struct.unpack(self.fmt, raw_bytes)[0].decode('UTF-8').strip("\0") 15 | 16 | def pack(self) -> bytes: 17 | return struct.pack(self.fmt, self.name.encode('UTF-8')) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiImportAsset.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | from fuiDataStructures.fuiObject import fuiObject 3 | import struct 4 | 5 | @dataclass(init=False) 6 | class fuiImportAsset(fuiObject): 7 | fmt = "<64s" 8 | size = struct.calcsize(fmt) 9 | 10 | import_name:str = field(default_factory=str) 11 | 12 | def __init__(self, raw_bytes:bytes): 13 | self.import_name = struct.unpack(self.fmt, raw_bytes)[0].decode('UTF-8').strip("\0") 14 | 15 | def pack(self) -> bytes: 16 | return struct.pack(self.fmt, self.import_name.encode('UTF-8')) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiFontName.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | @dataclass(init=False) 7 | class fuiFontName(fuiObject): 8 | fmt = " bytes: 20 | return struct.pack(self.fmt, self.id, self.name.encode('UTF-8')) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiFillStyle.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | 3 | from fuiDataStructures.fuiMatrix import fuiMatrix 4 | @dataclass 5 | class fuiFillStyle: 6 | fmt = "3I" + fuiMatrix.fmt 7 | 8 | class eFuiFillType: 9 | pass 10 | 11 | fillType:int = field(default_factory=int) #! eFuiFillType : 1 == fillWithColor | 5 == use bitmap | 3 == scale bitmap by matrix ?? 12 | color:int = field(default_factory=int) 13 | bitmap_index:int = field(default_factory=int) 14 | matrix:fuiMatrix = field(default_factory=fuiMatrix) 15 | 16 | def __iter__(self): 17 | return iter([self.fillType, self.color, self.bitmap_index, *self.matrix]) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiMatrix.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | 3 | @dataclass(init=False) 4 | class fuiMatrix: 5 | fmt = "6f" 6 | 7 | scale:tuple = field(default_factory=tuple) 8 | rotate_skrew:tuple = field(default_factory=tuple) 9 | translate:tuple = field(default_factory=tuple) 10 | 11 | def __init__(self, scale_x:float, scale_y:float, rotate_skew0:float, rotate_skew1:float, translate_x:float, translate_y:float): 12 | self.scale = (scale_x, scale_y) 13 | self.rotate_skrew = (rotate_skew0, rotate_skew1) 14 | self.translate = (translate_x, translate_y) 15 | 16 | def __iter__(self): 17 | return iter([*self.scale, *self.rotate_skrew, *self.translate]) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiReference.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | @dataclass(init=False) 7 | class fuiReference(fuiObject): 8 | fmt = " bytes: 22 | return struct.pack(self.fmt, self.symbol_index, self.reference.encode('UTF-8'), self.fui_file_index) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiTimelineFrame.py: -------------------------------------------------------------------------------- 1 | import struct 2 | from dataclasses import dataclass, field 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | @dataclass(init=False) 7 | class fuiTimelineFrame(fuiObject): 8 | fmt = "<64s2i" 9 | size = struct.calcsize(fmt) 10 | 11 | frame_name:str 12 | event_index:int 13 | event_count:int 14 | 15 | def __init__(self, raw_bytes:bytes): 16 | data = struct.unpack(self.fmt, raw_bytes) 17 | self.frame_name = data[0].decode('UTF-8').strip("\0") 18 | self.event_index = data[1] 19 | self.event_count = data[2] 20 | 21 | def pack(self) -> bytes: 22 | return struct.pack(self.fmt, self.frame_name.encode("UTF-8"), self.event_index, self.event_count) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiColorTransform.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | 3 | @dataclass(init=False) 4 | class fuiColorTransform: 5 | fmt = "8f" 6 | 7 | mult_terms:list = field(default_factory=list) 8 | add_terms:list = field(default_factory=list) 9 | 10 | def __init__(self, red_mult_term:float, green_mult_term:float, blue_mult_term:float, alpha_mult_term:float, red_add_term:float, green_add_term:float, blue_add_term:float, alpha_add_term:float): 11 | self.mult_terms = list([red_mult_term, green_mult_term, blue_mult_term, alpha_mult_term]) 12 | self.add_terms = list([red_add_term, green_add_term, blue_add_term, alpha_add_term]) 13 | 14 | def __iter__(self): 15 | return iter([*self.mult_terms, *self.add_terms]) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiSymbol.py: -------------------------------------------------------------------------------- 1 | import struct 2 | from dataclasses import dataclass, field 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | @dataclass(init=False) 6 | class fuiSymbol(fuiObject): 7 | fmt = "<64s2i" 8 | size = struct.calcsize(fmt) 9 | 10 | name:str 11 | obj_type:int 12 | #! TODO: find a proper name | DESC.: used to map symbol to specific type list 13 | index:int 14 | 15 | def __init__(self, raw_bytes:bytes): 16 | data = struct.unpack(self.fmt, raw_bytes) 17 | self.name = data[0].decode('UTF-8').strip("\0") 18 | self.obj_type = data[1] 19 | self.index = data[2] 20 | 21 | def pack(self) -> bytes: 22 | return struct.pack(self.fmt, self.name.encode('UTF-8'), self.obj_type, self.index) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FUI-Research Project 2 | 3 | Small project about the FUI file structure used in Legacy Editions of Minecraft.\ 4 | Licensed under the terms of the GNU General Public License, version 3 or later (GPLv3+). 5 | 6 | 7 | ## Documentation 8 | 9 | The FUI File Documentation can be found [here](./DOCUMENTATION.md). 10 | 11 | ## Reference 12 | Reference used can be found [here](https://www.adobe.com/content/dam/acom/en/devnet/pdf/swf-file-format-spec.pdf). 13 | 14 | ## Setup 15 | ```console 16 | git clone https://github.com/NessieHax/fui-research-repo.git 17 | cd fui-research-repo 18 | pip install -r requirements.txt 19 | ``` 20 | 21 | ## Examples 22 | 23 | Python 3 Examples can be found [here](./python/example.py).\ 24 | (developed and tested only on Python 3.10, might work with lower Python 3 versions).\ 25 | **Note**: the current example is only for the command line. 26 | -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiShape.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | from fuiDataStructures.fuiRect import fuiRect 6 | 7 | @dataclass(init=False) 8 | class fuiShape(fuiObject): 9 | fmt = "<3i4f" 10 | size = struct.calcsize(fmt) 11 | 12 | unk_0x0:int 13 | component_index:int 14 | component_count:int 15 | area:fuiRect = field(default_factory=fuiRect) 16 | 17 | def __init__(self, raw_bytes:bytes): 18 | data = struct.unpack(self.fmt, raw_bytes) 19 | self.unk_0x0 = data[0] 20 | self.component_index = data[1] 21 | self.component_count = data[2] 22 | self.area = fuiRect(data[3], data[4], data[5], data[6]) 23 | 24 | def pack(self) -> bytes: 25 | return struct.pack(self.fmt, self.unk_0x0, self.component_index, self.component_count, *self.area) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiShapeComponent.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | from fuiDataStructures.fuiMatrix import fuiMatrix 6 | from fuiDataStructures.fuiFillStyle import fuiFillStyle 7 | 8 | @dataclass(init=False) 9 | class fuiShapeComponent(fuiObject): 10 | fmt = f"<{fuiFillStyle.fmt}2i" 11 | size = struct.calcsize(fmt) 12 | 13 | fillInfo:fuiFillStyle = field(default_factory=fuiFillStyle) 14 | vert_index:int 15 | vert_count:int 16 | 17 | def __init__(self, raw_bytes:bytes): 18 | data = struct.unpack(self.fmt, raw_bytes) 19 | self.fillInfo = fuiFillStyle(data[0], data[1], data[2], fuiMatrix(data[3], data[4], data[5], data[6], data[7], data[8])) 20 | self.vert_index = data[9] 21 | self.vert_count = data[10] 22 | 23 | def pack(self) -> bytes: 24 | return struct.pack(self.fmt, *self.fillInfo, self.vert_index, self.vert_count) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiTimelineAction.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | @dataclass(init=False) 7 | class fuiTimelineAction(fuiObject): 8 | fmt = "<2bh64s64s" 9 | size = struct.calcsize(fmt) 10 | 11 | #! fuiRenderNodeTimeline::handleConstruction 12 | #! TODO 13 | action_type:int 14 | unkn_0x1:int 15 | frame_index:int #! -1 if not needed/used 16 | action_arg0:str 17 | action_arg1:str 18 | 19 | def __init__(self, raw_bytes:bytes): 20 | data = struct.unpack(self.fmt, raw_bytes) 21 | self.action_type = data[0] 22 | self.unkn_0x1 = data[1] 23 | self.frame_index = data[2] 24 | self.action_arg0 = data[3].decode('UTF-8').strip("\0") 25 | self.action_arg1 = data[4].decode('UTF-8').strip("\0") 26 | 27 | def pack(self) -> bytes: 28 | return struct.pack(self.fmt, self.action_type, self.unkn_0x1, self.frame_index, self.action_arg0.encode("UTF-8"), self.action_arg1.encode("UTF-8")) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiRect.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | 3 | @dataclass(init=False, repr=False) 4 | class fuiRect: 5 | fmt = "4f" 6 | 7 | x:tuple 8 | y:tuple 9 | 10 | def __init__(self, min_x:float, max_x:float, min_y:float, max_y:float): 11 | self.x = (min_x, max_x) 12 | self.y = (min_y, max_y) 13 | 14 | def get_size(self) -> tuple: 15 | return (self.get_width(), self.get_height()) 16 | 17 | def get_width(self) -> float: 18 | return self.x[1] - self.x[0] 19 | 20 | def get_height(self) -> float: 21 | return self.y[1] - self.y[0] 22 | 23 | def set_x(self, min_x:float, max_x:float) -> None: 24 | self.x = (min_x, max_x) 25 | 26 | def set_y(self, min_y:float, max_y:float) -> None: 27 | self.y = (min_y, max_y) 28 | 29 | def __iter__(self): 30 | return iter([*self.x, *self.y]) 31 | 32 | def __repr__(self) -> str: 33 | return self.get_size().__repr__() 34 | 35 | def __str__(self) -> str: 36 | return f"{self.x=} {self.y=}" -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiTimeline.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiRect import fuiRect 5 | from fuiDataStructures.fuiObject import fuiObject 6 | 7 | @dataclass(init=False) 8 | class fuiTimeline(fuiObject): 9 | fmt = f" bytes: 29 | return struct.pack(self.fmt, self.symbol_index, self.frame_index, self.frame_count, self.action_index, self.action_count, *self.rect) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiBitmap.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | @dataclass(init=False) 6 | class fuiBitmap(fuiObject): 7 | fmt = "<8i" 8 | size = struct.calcsize(fmt) 9 | 10 | class eFuiBitmapType: 11 | PNG_WITH_ALPHA_DATA:int = 1 #! fully ignored 12 | PNG_NO_ALPHA_DATA:int = 3 #! fully ignored 13 | JPEG_NO_ALPHA_DATA:int = 6 14 | JPEG_UNKNOWN:int = 7 #! TODO: find name 15 | JPEG_WITH_ALPHA_DATA:int = 8 #! if set the zlib_data_start has to be set 16 | 17 | symbol_index:int 18 | format:int 19 | width:int 20 | height:int 21 | offset:int 22 | size:int 23 | zlib_data_start:int 24 | texture_bind_handle:int 25 | 26 | def __init__(self, raw_bytes:bytes): 27 | data = struct.unpack(self.fmt, raw_bytes) 28 | self.symbol_index = data[0] 29 | self.format = data[1] 30 | self.width = data[2] 31 | self.height = data[3] 32 | self.offset = data[4] 33 | self.size = data[5] 34 | self.zlib_data_start = data[6] 35 | self.texture_bind_handle = data[7] 36 | 37 | def pack(self) -> bytes: 38 | return struct.pack(self.fmt, self.symbol_index, self.format, self.width, self.height, self.offset, self.size, self.zlib_data_start, self.texture_bind_handle) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiHeader.py: -------------------------------------------------------------------------------- 1 | import struct 2 | 3 | from fuiDataStructures.fuiRect import fuiRect 4 | from fuiDataStructures.fuiObject import fuiObject 5 | 6 | class fuiHeader(fuiObject): 7 | fmt = "<8sI64s15i4f" 8 | size = struct.calcsize(fmt) 9 | def __init__(self, raw_data:bytes): 10 | data = struct.unpack(self.fmt, raw_data) 11 | self.signature:bytes = data[0] 12 | self.content_size:int = data[1] 13 | self.import_name:str = data[2].decode("UTF-8").strip("\0") 14 | self.data_counts = (self.timeline_count, self.timeline_event_name_count, self.timeline_action_count, 15 | self.shape_count, self.shape_component_count, self.vert_count, 16 | self.timeline_frame_count, self.timeline_event_count, self.reference_count, 17 | self.edittext_count, self.symbol_count, self.bitmap_count, 18 | self.image_sizes, self.font_name_count, self.import_asset_count 19 | ) = data[3:18] 20 | self.rect:fuiRect = fuiRect(data[18], data[19], data[20], data[21]) 21 | 22 | def pack(self) -> bytes: 23 | return struct.pack(self.fmt, self.signature, self.content_size, self.import_name.encode("UTF-8"), *self.data_counts, *self.rect) 24 | 25 | def __repr__(self): 26 | return f""" 27 | Version: {self.signature[0]} 28 | Signature: {self.signature[1:]} 29 | Content Size: {self.content_size} 30 | Header Size: {self.size} 31 | Import Name: {self.import_name} 32 | Stage Size: {self.rect.get_size()} 33 | {self.data_counts} 34 | """ -------------------------------------------------------------------------------- /python/fuiBuilder.py: -------------------------------------------------------------------------------- 1 | from typing import Optional 2 | 3 | from fuiParser import fuiParser 4 | from fuiDataStructures.fuiHeader import fuiHeader 5 | 6 | class fuiBuilder: 7 | def __init__(self) -> None: ... 8 | 9 | def create_blank_fuiheader(self) -> fuiHeader: 10 | header = fuiHeader(bytearray(fuiHeader.header_size)) 11 | header.signature = b'\x01IUF\0\0\0\0' # Default signature 12 | header.import_name = "MIKU_BLANK_FUI" 13 | #! rect size may vary depending on the console 14 | header.rect.set_x(0.0, 1280.0) 15 | header.rect.set_y(0.0, 720.0) 16 | return header 17 | 18 | #! TODO 19 | def build_from_parser(self, parser:fuiParser, file_name:Optional[str] = None) -> None: 20 | header = parser.get_header() 21 | 22 | file = file_name if file_name is not None else f"mod_{header.import_name.replace('.swf','')}" 23 | file += ".fui" 24 | 25 | with open(file, "wb") as modified: 26 | modified.write(header.pack()) 27 | output:bytearray = bytearray() 28 | 29 | for key, data_list in parser._parsed_objects.items(): 30 | for data in data_list: 31 | if key == "images": 32 | output += data 33 | continue 34 | output += data.pack() 35 | 36 | modified.write(output) 37 | 38 | 39 | #! TODO 40 | def __setup_header(self) -> None: ... 41 | 42 | #! TODO 43 | def __calc_content_size_and_set_header_counts(self) -> int: ... -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiEdittext.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct, re 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | from fuiDataStructures.fuiRect import fuiRect 6 | 7 | @dataclass(init=False) 8 | class fuiEdittext(fuiObject): 9 | fmt = f" bytes: 47 | return struct.pack(self.fmt, self.unkn_0x0, *self.size, self.font_id, self.font_scale, self.color, self.alignment, self.unkn_0x24, self.unkn_0x28, self.unkn_0x2c, self.unkn_0x30, self.html_str) -------------------------------------------------------------------------------- /python/fuiDataStructures/fuiTimelineEvent.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | import struct 3 | 4 | from fuiDataStructures.fuiObject import fuiObject 5 | from fuiDataStructures.fuiMatrix import fuiMatrix 6 | from fuiDataStructures.fuiColorTransform import fuiColorTransform 7 | 8 | @dataclass(init=False) 9 | class fuiTimelineEvent(fuiObject): 10 | fmt = f"<4b4h{fuiMatrix.fmt}{fuiColorTransform.fmt}I" 11 | size = struct.calcsize(fmt) 12 | 13 | event_type:int 14 | unkn_0x1:int 15 | obj_type:int 16 | unkn_0x3:int 17 | unkn_0x4:int 18 | index:int 19 | unkn_0x8:int 20 | name_index:int 21 | matrix:fuiMatrix = field(default_factory=fuiMatrix, repr=False) 22 | ColorTransform:fuiColorTransform = field(default_factory=fuiColorTransform, repr=False) 23 | color:int = field(repr=False) 24 | 25 | def __init__(self, raw_bytes:bytes): 26 | data = struct.unpack(self.fmt, raw_bytes) 27 | self.event_type = data[0] 28 | self.unkn_0x1 = data[1] 29 | self.obj_type = data[2] 30 | self.unkn_0x3 = data[3] 31 | self.unkn_0x4 = data[4] 32 | self.index = data[5] 33 | self.unkn_0x8 = data[6] 34 | self.name_index = data[7] 35 | self.matrix = fuiMatrix(data[8], data[9], data[10], data[11], data[12], data[13]) 36 | self.ColorTransform = fuiColorTransform(data[14], data[15], data[16], data[17], data[18], data[19], data[20], data[21]) 37 | self.color = data[22] 38 | 39 | def pack(self) -> bytes: 40 | return struct.pack(self.fmt, self.event_type, self.unkn_0x1, self.obj_type, self.unkn_0x3, self.unkn_0x4, self.index, self.unkn_0x8, self.name_index, 41 | *self.matrix, *self.ColorTransform, self.color) 42 | -------------------------------------------------------------------------------- /python/fuiUtil.py: -------------------------------------------------------------------------------- 1 | import cv2, numpy, zlib 2 | from typing import Union 3 | 4 | from fuiDataStructures.fuiBitmap import fuiBitmap 5 | 6 | def decode_image(raw_data:Union[bytes, bytearray], read_flags:int = cv2.IMREAD_ANYCOLOR | cv2.IMREAD_UNCHANGED) -> numpy.ndarray: 7 | data = numpy.asarray(bytearray(raw_data), dtype=numpy.uint8) 8 | return cv2.imdecode(data, read_flags) 9 | 10 | def get_zlib_buf_size(bitmap:fuiBitmap) -> int: 11 | return bitmap.size - bitmap.zlib_data_start if bitmap.zlib_data_start > 0 else -1 12 | 13 | #! TODO 14 | def get_compressed_zlib_data(data:Union[bytes, bytearray], zlib_start:int, zlib_buf_size:int) -> bytes: 15 | if zlib_start == 0 or zlib_buf_size == 0: 16 | print("zlib start or buffer size is NULL") 17 | return bytes(0) 18 | return data[zlib_start:zlib_start+zlib_buf_size] 19 | 20 | def swap_image_data(img:numpy.ndarray, mode:str = "fui_in") -> numpy.ndarray: 21 | if mode == "fui_in": 22 | return cv2.cvtColor(img, cv2.COLOR_RGBA2BGRA) 23 | elif mode == "fui_out": 24 | return cv2.cvtColor(img, cv2.COLOR_BGRA2RGBA) 25 | raise IOError("Invalid mode.") 26 | 27 | def insert_zlib_alpha_channel_data(img:numpy.ndarray, compressed_zlib_data:Union[bytes, bytearray], zlib_buf_size:int) -> numpy.ndarray: 28 | output = zlib.decompress(compressed_zlib_data, 0, zlib_buf_size) 29 | for i, col in enumerate(img): 30 | for j, color in enumerate(col): 31 | alpha_data = output[i*len(col)+j] 32 | if alpha_data == 0: 33 | color[:4] = 0 34 | continue 35 | maxval = 0xff 36 | color[3] = alpha_data 37 | x = color[:3] / (alpha_data / maxval) 38 | x = numpy.nan_to_num(x, nan=maxval, posinf=maxval, neginf=maxval) 39 | a = numpy.where(maxval-x<=0.0, 255.0, x) 40 | color[:3] = a.astype(numpy.uint8) 41 | return img -------------------------------------------------------------------------------- /python/fuiFile.py: -------------------------------------------------------------------------------- 1 | from io import BufferedReader 2 | from dataclasses import dataclass, field 3 | from fuiDataStructures.fuiHeader import fuiHeader 4 | from fuiDataStructures.fuiTimeline import fuiTimeline 5 | from fuiDataStructures.fuiTimelineFrame import fuiTimelineFrame 6 | from fuiDataStructures.fuiTimelineAction import fuiTimelineAction 7 | from fuiDataStructures.fuiShape import fuiShape 8 | from fuiDataStructures.fuiShapeComponent import fuiShapeComponent 9 | from fuiDataStructures.fuiVert import fuiVert 10 | from fuiDataStructures.fuiTimelineEvent import fuiTimelineEvent 11 | from fuiDataStructures.fuiTimelineEventName import fuiTimelineEventName 12 | from fuiDataStructures.fuiReference import fuiReference 13 | from fuiDataStructures.fuiEdittext import fuiEdittext 14 | from fuiDataStructures.fuiFontName import fuiFontName 15 | from fuiDataStructures.fuiSymbol import fuiSymbol 16 | from fuiDataStructures.fuiImportAsset import fuiImportAsset 17 | from fuiDataStructures.fuiBitmap import fuiBitmap 18 | 19 | @dataclass(slots=True) 20 | class fuiFile: 21 | header: fuiHeader = field(init=False) 22 | timelines: list[fuiTimeline] = field(default_factory=list, repr=False, init=False) 23 | timeline_actions: list[fuiTimelineAction] = field(default_factory=list, repr=False, init=False) 24 | shapes: list[fuiShape] = field(default_factory=list, repr=False, init=False) 25 | shape_components: list[fuiShapeComponent] = field(default_factory=list, repr=False, init=False) 26 | verts: list[fuiVert] = field(default_factory=list, repr=False, init=False) 27 | timeline_frames: list[fuiTimelineFrame] = field(default_factory=list, repr=False, init=False) 28 | timeline_events: list[fuiTimelineEvent] = field(default_factory=list, repr=False, init=False) 29 | timeline_event_names: list[fuiTimelineEventName] = field(default_factory=list, repr=False, init=False) 30 | references: list[fuiReference] = field(default_factory=list, repr=False, init=False) 31 | edittexts: list[fuiEdittext] = field(default_factory=list, repr=False, init=False) 32 | font_names: list[fuiFontName] = field(default_factory=list, repr=False, init=False) 33 | symbols: list[fuiSymbol] = field(default_factory=list, repr=False, init=False) 34 | import_assets: list[fuiImportAsset] = field(default_factory=list, repr=False, init=False) 35 | bitmaps: list[fuiBitmap] = field(default_factory=list, repr=False, init=False) 36 | images: list[bytes] = field(default_factory=list, repr=False, init=False) 37 | 38 | def parse(self, data: BufferedReader) -> None: 39 | self.header = fuiHeader(data.read(fuiHeader.size)) 40 | def __make(container: list, cls, count: int, data: BufferedReader): 41 | [container.append(cls(data.read(cls.size))) for _ in range(count)] 42 | 43 | __make(self.timelines, fuiTimeline, self.header.timeline_count, data) 44 | __make(self.timeline_actions, fuiTimelineAction, self.header.timeline_action_count, data) 45 | __make(self.shapes, fuiShape, self.header.shape_count, data) 46 | __make(self.shape_components, fuiShapeComponent, self.header.shape_component_count, data) 47 | __make(self.verts, fuiVert, self.header.vert_count, data) 48 | __make(self.timeline_frames, fuiTimelineFrame, self.header.timeline_frame_count, data) 49 | __make(self.timeline_events, fuiTimelineEvent, self.header.timeline_event_count, data) 50 | __make(self.timeline_event_names, fuiTimelineEventName, self.header.timeline_event_name_count, data) 51 | __make(self.references, fuiReference, self.header.reference_count, data) 52 | __make(self.edittexts, fuiEdittext, self.header.edittext_count, data) 53 | __make(self.font_names, fuiFontName, self.header.font_name_count, data) 54 | __make(self.symbols, fuiSymbol, self.header.symbol_count, data) 55 | __make(self.import_assets, fuiImportAsset, self.header.import_asset_count, data) 56 | __make(self.bitmaps, fuiBitmap, self.header.bitmap_count, data) 57 | for bitmap in self.bitmaps: 58 | self.images.append(data.read(bitmap.size)) 59 | 60 | -------------------------------------------------------------------------------- /python/fuiInfoDumper.py: -------------------------------------------------------------------------------- 1 | import os, argparse 2 | from fuiParser import fuiParser 3 | from fuiDataStructures.fuiTimeline import fuiTimeline 4 | from fuiDataStructures.fuiShape import fuiShape 5 | from fuiDataStructures.fuiObject import eFuiObjectType 6 | from fuiBuilder import fuiBuilder 7 | 8 | def print_timeline_tree(parser:fuiParser, timeline:fuiTimeline, prefix:str = "") -> None: 9 | print(f"->", timeline) 10 | for frame in parser.get_timeline_frames()[timeline.frame_index:timeline.frame_index + timeline.frame_count]: 11 | print(f"{prefix}-->", frame) 12 | for event in parser.get_timeline_events()[frame.event_index:frame.event_index + frame.event_count]: 13 | print(f"{prefix}---",end="") 14 | print(">", parser.get_timeline_event_names()[event.name_index].name if event.name_index > -1 else "Unknown",end=" ") 15 | print(event) 16 | print(f"{prefix}----",end="") 17 | if event.event_type & 1 == 0: continue 18 | if event.obj_type == eFuiObjectType.SHAPE: 19 | print_shapes(parser, parser.get_shapes()[event.index], prefix+"----") 20 | if event.obj_type == eFuiObjectType.REFERENCE: 21 | print(">", parser.get_references()[event.index]) 22 | if event.obj_type == eFuiObjectType.TIMELINE: 23 | print_timeline_tree(parser, parser.get_timelines()[event.index], prefix+"----") 24 | if event.obj_type == eFuiObjectType.BITMAP: 25 | print(">", parser.get_bitmaps()[event.index]) 26 | if event.obj_type == eFuiObjectType.EDITTEXT: 27 | print(">", parser.get_edittext()[event.index]) 28 | print() 29 | for act in parser.get_timeline_actions()[timeline.action_index:timeline.action_index + timeline.action_count]: 30 | print(f"{prefix}-->", act) 31 | 32 | def print_shapes(parser:fuiParser, shape:fuiShape, prefix:str = "") -> None: 33 | print(">", shape) 34 | for component in parser.get_shape_components()[shape.component_index:shape.component_index+shape.component_count]: 35 | print(f"{prefix}->", component) 36 | for vert in parser.get_verts()[component.vert_index:component.vert_index+component.vert_count]: 37 | print(f"{prefix}-->", vert) 38 | print() 39 | 40 | def print_all_timeline_trees(parser:fuiParser) -> None: 41 | for symbol in parser.get_symbols(): 42 | if symbol.obj_type != eFuiObjectType.TIMELINE: continue 43 | print(symbol.name) 44 | data = parser.get_timelines()[symbol.index] 45 | print_timeline_tree(parser, data) 46 | 47 | def main(): 48 | argvparser = argparse.ArgumentParser() 49 | argvparser.add_argument("fuiFile", type=str, help="FUI File to be Parsed.") 50 | argvparser.add_argument("-sym", "--symbols", action="store_true", default=False, help="Prints out all Symbols contained in a file") 51 | argvparser.add_argument("-d", "--dump", action="store_true", default=False, help="Dumps images(with symbol name) into a folder") 52 | # argvparser.add_argument("-b", "--build", action="store_true", default=False, help="(Re)Builds the fui file") 53 | argvparser.add_argument("-tree", action="store_true", default=False, help="DEBUG") 54 | argvparser.add_argument("-l", "--list", action="store", type=str, metavar="fuiObjectType", default=None, help="Lists a given fuiObject list contained in the fui") 55 | argvparser.add_argument("-o", "--output", action="store", type=str, default="dump_output", help="sets the output path") 56 | argvparser.add_argument("-b-out", "--build-output", action="store", type=str, default="mod_output", help="sets the output path for the building process") 57 | argvparser.add_argument("-r", "--replace", metavar=("Bitmap_name", "image_filename"), type=str, nargs=2, action="append", help="Replaces given index with the passed image") 58 | argvparser.add_argument("-rd","--raw-dump", action="store_true", default=False, help="Dumps all images into a folder") 59 | argvparser.add_argument("-f","--find", metavar="name", type=str, action="store", help="Prints out fui Element's that contain [name]") 60 | argvparser.add_argument("-frefs","--find-references", dest="find_ref", metavar="folder", type=str, action="store", help="Tries to find references contained in Import files") 61 | parsedargs = argvparser.parse_args() 62 | if not parsedargs.fuiFile.endswith(".fui"): raise Exception("Not a fui file") 63 | output_path = os.path.abspath(parsedargs.output) 64 | 65 | with open(parsedargs.fuiFile, "rb") as fui_fd: 66 | parser = fuiParser(fui_fd) 67 | print(parser) 68 | 69 | if parsedargs.dump: 70 | parser.dump_images(output_path) 71 | elif parsedargs.raw_dump: 72 | parser.dump_raw(output_path) 73 | if parsedargs.find: 74 | parser.find(parsedargs.find) 75 | 76 | if parsedargs.symbols: 77 | print("Symbols:") 78 | for symbol in parser.get_symbols(): 79 | print("Type:", symbol.obj_type, "Name:", symbol.name) 80 | 81 | if parsedargs.tree: 82 | print_all_timeline_trees(parser) 83 | 84 | # #! this is disgusting 85 | # if parsedargs.find_ref and os.path.exists(parsedargs.find_ref) and len(parser.get_imported_assets()) > 0: 86 | # fui_parser = [] 87 | # for file in os.listdir(parsedargs.find_ref): 88 | # if file.endswith(".fui"): 89 | # abs_path = os.path.join(os.path.abspath(parsedargs.find_ref),file) 90 | # with open(abs_path, "rb") as fui: 91 | # fui_parser.append((file,fuiParser(fui.read()))) 92 | 93 | # for import_file in parser.get_imported_assets(): 94 | # for (file_name, cur_parser) in fui_parser: 95 | # if cur_parser.header.import_name == import_file.import_name: 96 | # print(f"Found import name({import_file.import_name}) in {file_name}") 97 | 98 | if __name__ == "__main__": 99 | main() -------------------------------------------------------------------------------- /python/fuiParser.py: -------------------------------------------------------------------------------- 1 | from io import BufferedReader 2 | import os, cv2 3 | 4 | from fuiDataStructures.fuiHeader import fuiHeader 5 | from fuiDataStructures.fuiObject import eFuiObjectType 6 | from fuiDataStructures.fuiBitmap import fuiBitmap 7 | from fuiDataStructures.fuiTimeline import fuiTimeline 8 | from fuiUtil import get_zlib_buf_size, insert_zlib_alpha_channel_data, decode_image, swap_image_data 9 | from fuiFile import fuiFile 10 | 11 | class FUIParserError(Exception): ... 12 | 13 | class fuiParser: 14 | def __init__(self, data: BufferedReader): 15 | self._fui = fuiFile() 16 | self._fui.parse(data) 17 | 18 | def validate_folder_dest(self, output_path:str) -> str: 19 | output_path = os.path.join(output_path, f"{self._fui.header.import_name.removesuffix('.swf')}") 20 | if not os.path.exists(output_path): 21 | os.makedirs(output_path) 22 | return output_path 23 | 24 | def get_header(self) -> fuiHeader: 25 | return self._fui.header 26 | 27 | def get_imported_assets(self) -> list: 28 | return self._fui.import_assets 29 | 30 | def get_font_names(self) -> list: 31 | return self._fui.font_names 32 | 33 | #! EXISTING string editing is not recommented due to not being sure if it could mess up the classes that init with it 34 | def get_symbols(self) -> list: 35 | return self._fui.symbols 36 | 37 | def get_timeline_frames(self) -> list: 38 | return self._fui.timeline_frames 39 | 40 | def get_timeline_actions(self) -> list: 41 | return self._fui.timeline_actions 42 | 43 | def get_references(self) -> list: 44 | return self._fui.references 45 | 46 | def get_bitmaps(self) -> list: 47 | return self._fui.bitmaps 48 | 49 | def get_timeline_events(self) -> list: 50 | return self._fui.timeline_events 51 | 52 | def get_timeline_event_names(self) -> list: 53 | return self._fui.timeline_event_names 54 | 55 | def get_timelines(self) -> list: 56 | return self._fui.timelines 57 | 58 | def get_verts(self) -> list: 59 | return self._fui.verts 60 | 61 | def get_shapes(self) -> list: 62 | return self._fui.shapes 63 | 64 | def get_shape_components(self) -> list: 65 | return self._fui.shape_components 66 | 67 | def get_edittext(self) -> list: 68 | return self._fui.edittexts 69 | 70 | def contains_images(self) -> bool: 71 | return len(self.get_bitmaps()) > 0 72 | 73 | def __dump_image(self, output_file:str, bitmap: fuiBitmap, img: bytes) -> None: 74 | data = img 75 | ext, write_flags = ("png", [cv2.IMWRITE_PNG_COMPRESSION]) if (bitmap.format == bitmap.eFuiBitmapType.JPEG_WITH_ALPHA_DATA or bitmap.format < 6) else ("jpeg", [cv2.IMWRITE_JPEG_QUALITY]) 76 | filename = f"{output_file}.{ext}" 77 | print("Dumping:", filename[len(os.getcwd()):]) 78 | img = decode_image(data) 79 | final_image = img 80 | if bitmap.format == fuiBitmap.eFuiBitmapType.JPEG_WITH_ALPHA_DATA: 81 | final_image = cv2.cvtColor(final_image, cv2.COLOR_RGB2RGBA) #! create alpha channel 82 | zlib_buf_sz = get_zlib_buf_size(bitmap) 83 | zlib_data = data[bitmap.zlib_data_start:] 84 | final_image = insert_zlib_alpha_channel_data(final_image, zlib_data, zlib_buf_sz) 85 | elif bitmap.format < 6: 86 | final_image = swap_image_data(img, "fui_out") 87 | 88 | cv2.imwrite(filename, final_image, write_flags) 89 | 90 | def dump_images(self, output_path:str) -> None: 91 | bitmaps = self.get_bitmaps() 92 | if not self.contains_images(): 93 | print("This fui file does not contain any images") 94 | return 95 | output_path = self.validate_folder_dest(output_path) 96 | count = 0 97 | for symbol in self.get_symbols(): 98 | if symbol.obj_type != eFuiObjectType.BITMAP: continue 99 | bitmap = bitmaps[symbol.index] 100 | self.__dump_image(f"{os.path.join(output_path, symbol.name)}", bitmap, self._fui.images[symbol.index]) 101 | count += 1 102 | print("Successfully dumped all images!\n" if count == len(bitmaps) else "", end="") 103 | 104 | def dump_raw(self, output_path:str) -> None: 105 | if not self.contains_images(): 106 | print("This fui file does not contain any images") 107 | return 108 | output_path = self.validate_folder_dest(output_path) 109 | [self.__dump_image(os.path.join(output_path, f"image_{i}"), bitmap, self._fui.images[i]) for i, bitmap in enumerate(self.get_bitmaps())] 110 | 111 | def replace_bitmap(self, index:int, img_data:bytes, img_type:fuiBitmap.eFuiBitmapType = fuiBitmap.eFuiBitmapType.PNG_WITH_ALPHA_DATA) -> None: 112 | if not self.is_valid_index("fuiBitmap", index): 113 | raise IndexError("Invalid Index") 114 | 115 | target_bitmap:fuiBitmap = self.get_bitmaps()[index] 116 | 117 | tmp_img_data = decode_image(img_data) 118 | if img_type == fuiBitmap.eFuiBitmapType.PNG_NO_ALPHA_DATA or img_type == fuiBitmap.eFuiBitmapType.PNG_WITH_ALPHA_DATA: 119 | tmp_img_data = swap_image_data(tmp_img_data) 120 | final_img_data:bytearray = bytearray(cv2.imencode(".png", tmp_img_data)[1].tobytes()) 121 | 122 | height, width = tmp_img_data.shape[:2] 123 | target_bitmap.width = width 124 | target_bitmap.height = height 125 | old_img_size = target_bitmap.size 126 | new_img_size = len(final_img_data) 127 | 128 | offset_diff = new_img_size - old_img_size 129 | print("old", old_img_size) 130 | print("new", new_img_size) 131 | print(offset_diff) 132 | target_bitmap.size = new_img_size 133 | 134 | self._parsed_objects["images"][index] = final_img_data 135 | 136 | for bitmap in self.get_bitmaps()[index+1:]: 137 | bitmap.offset += offset_diff 138 | 139 | self.__header.content_size += offset_diff 140 | print(f"Successfully changed '{self.get_symbols()[bitmap.symbol_index]}'") 141 | 142 | def find(self, name:str) -> tuple[fuiBitmap | fuiTimeline] | None: 143 | results:tuple = () 144 | for symbol in self.get_symbols(): 145 | if name.lower() in symbol.name.lower(): 146 | caller, data_type = (self.get_bitmaps, 'fuiBitmap') if symbol.obj_type == eFuiObjectType.BITMAP else (self.get_timelines, 'fuiTimeline') 147 | data = caller()[symbol.index] 148 | print(f"{symbol.name} | Offset: {'TODO'} | {data}") 149 | results += (data,) 150 | if len(results) > 0: return results 151 | raise FUIParserError(f"Could not find Symbol named '{name}'") 152 | 153 | def __str__(self) -> str: 154 | return self._fui.header.__str__() -------------------------------------------------------------------------------- /DOCUMENTATION.md: -------------------------------------------------------------------------------- 1 | # FUI File Structure Documentation 2 | ## Base Information 3 | FUI Files are Mojangs/4J's way of storing Game UI Assets. 4 | 5 | *FUI files use the LSB(Little Endian) byte order.* 6 | 7 | The following Table gives you Important information about each structure that can be represented in a FUI file: 8 | | Name | Size (per element) | Description | 9 | | :-:|:-:|:-:| 10 | | [fuiHeader](./DOCUMENTATION.md#fui-header) | 0x98 | Header Information (only exists once in each FUI file, always at offset 0) 11 | | [fuiTimeline](./DOCUMENTATION.md#fuiTimeline) | 0x1c | 12 | | [fuiTimelineAction](./DOCUMENTATION.md#fuitimelineaction) | 0x84 | 13 | | [fuiShape](./DOCUMENTATION.md#fuishape) | 0x1c | 14 | | [fuiShapeComponent](./DOCUMENTATION.md#fuishapecomponent) | 0x2c | 15 | | [fuiVert](./DOCUMENTATION.md#fuiVert) | 0x8 | 2D float Vertex 16 | | [fuiTimelineFrame](./DOCUMENTATION.md#fuitimelineframe) | 0x48 | 17 | | [fuiTimelineEvent](./DOCUMENTATION.md#fuitimelineevent) | 0x48 | 18 | | [fuiTimelineEventName](./DOCUMENTATION.md#fuitimelineeventname) | 0x40 | Name for a given event 19 | | [fuiReference](./DOCUMENTATION.md#fuireference) | 0x48 | Reference to Symbols in Imported Assests(Files) 20 | | [fuiEdittext](./DOCUMENTATION.md#fuiedittext) | 0x138 | 21 | | [fuiFontName](./DOCUMENTATION.md#fuifontname) | 0x104 | 22 | | [fuiSymbol](./DOCUMENTATION.md#fuisymbol) | 0x48 | Defined Symbols with Name and Object type (entry point for objects used in-game) 23 | | [fuiImportAsset](./DOCUMENTATION.md#fuiimportasset) | 0x40 | file name to import references from 24 | | [fuiBitmap](./DOCUMENTATION.md#fuibitmap) | 0x20 | Information about an Image contained in the file 25 | | Image Data | vary | Image data where all color channels are swapped (RGBA => ABGR). only affects png files 26 | 27 | ### Used structures in an FUI element 28 | These structures are used in some Elements in an FUI file 29 | | Name | Byte Size | Description | 30 | | :-:|:-:|:-:| 31 | | [fuiRect](./DOCUMENTATION.md#fuiRect) | 0x10 | A Representation of a Rectangle 32 | | [fuiRGBA](./DOCUMENTATION.md#fuiRGBA) | 0x4 | Base Color format used in FUI files 33 | | [fuiMatrix](./DOCUMENTATION.md#fuimatrix) | 0x18 | 2D Matrix for Scale, Rotation and Translation 34 | | [fuiColorTransform](./DOCUMENTATION.md#fuicolortransform) | 0x20 | 35 | | [fuiFillStyle](./DOCUMENTATION.md#fuifillstyle) | 0x24 | Contains Information for filling 36 | | [fuiObject.eFuiObjectType](./python/fuiDataStructures/fuiObject.py#L3) | 0x4 | Describes the Type of an Element 37 | 38 | ## fuiRect 39 | 40 | | Name | Offset | Byte Size | Type | Description | 41 | | :-:|:-:|:-:|:-:|:-:| 42 | | Min. X | 0x0 | 4 | float | Minimun X position 43 | | Max. X | 0x4 | 4 | float | Maximun X position 44 | | Min. Y | 0x8 | 4 | float | Minimun Y position 45 | | Max. Y | 0xc | 4 | float | Maximun Y position 46 | 47 | ## fuiRGBA 48 | 49 | | Name | Offset | Byte Size | Type | Description | 50 | | :-:|:-:|:-:|:-:|:-:| 51 | | Color | 0x0 | 4 | int | 8-bit Color in RGBA byte order 52 | 53 | ## fuiMatrix 54 | 55 | | Name | Offset | Byte Size | Type | Description | 56 | | :-:|:-:|:-:|:-:|:-:| 57 | | Scale X | 0x0 | 4 | float | 58 | | Scale Y | 0x4 | 4 | float | 59 | | Rotate Skew 0 | 0x8 | 4 | float | 60 | | Rotate Skew 1 | 0xc | 4 | float | 61 | | Translate X | 0x10 | 4 | float | 62 | | Translate Y | 0x14 | 4 | float | 63 | 64 | ## fuiColorTransform 65 | This is Untested just referenced by the .swf file docs!!\ 66 | 67 | | Name | Offset | Byte Size | Type | Description | 68 | | :-:|:-:|:-:|:-:|:-:| 69 | | RedMultTerm | 0x0 | 4 | float | 70 | | GrennMultTerm | 0x4 | 4 | float | 71 | | BlueMultTerm | 0x8 | 4 | float | 72 | | AlphaMultTerm | 0xc | 4 | float | 73 | | RedAddTerm | 0x10 | 4 | float | 74 | | GrennAddTerm | 0x14 | 4 | float | 75 | | BlueAddTerm | 0x18 | 4 | float | 76 | | AlphaAddTerm | 0x1c | 4 | float | 77 | 78 | ## fuiFillStyle 79 | 80 | | Name | Offset | Byte Size | Type | Description | 81 | | :-:|:-:|:-:|:-:|:-:| 82 | | Type/Operation | 0x0 | 4 | int | wheather to use a bitmap or fill area with a given color 83 | | Color | 0x4 | 4 | fuiRGBA | color to use when filling area 84 | | Bitmap Index | 0x8 | 4 | int | Index of the bitmap to use 85 | | Matrix | 0xc | 0x18 | fuiMatrix | matrix for area ? 86 | 87 | 88 | ## FUI Header 89 | 90 | **The FUI file Header is the most crucial part of an fui file it holds infomation for 91 | allocating memory at runtime, counts of fui Objects and is part of the in-game `fuifile` class** 92 | 93 | | Name | Offset | Byte Size | Type | Description | 94 | | :-:|:-:|:-:|:-:|:-:| 95 | | Signature | 0x0 | 8 | char[] | FUI File Signature (b'\x01IUF\x00\x00\x00\x00') where (\x01) indecates the version of the fui file 96 | | Content Size | 0x8 | 4 | int | Size of the up coming data in the FUI file 97 | | Swf File Name | 0xc | 0x40 | char[] | Name used to import file 98 | | fuiTimeline Count | 0x4c | 4 | int | Count of fuiTimeline Elements in a file 99 | | fuiTimelineEventName Count | 0x50 | 4 | int | Count of fuiTimelineEventName Elements in a file 100 | | fuiTimelineAction Count | 0x54 | 4 | int | Count of fuiTimelineAction Elements in a file 101 | | fuiShape Count | 0x58 | 4 | int | Count of fuiShape Elements in a file 102 | | fuiShapeComponent Count | 0x5c | 4 | int | Count of fuiShapeComponent Elements in a file 103 | | fuiVert Count | 0x60 | 4 | int | Count of fuiVert Elements in a file 104 | | fuiTimelineFrame Count | 0x64 | 4 | int | Count of fuiTimelineFrame Elements in a file 105 | | fuiTimelineEvent Count | 0x68 | 4 | int | Count of fuiTimelineEvent Elements in a file 106 | | fuiReference Count | 0x6c | 4 | int | Count of fuiReference Elements in a file 107 | | fuiEdittext Count | 0x70 | 4 | int | Count of fuiEdittext Elements in a file 108 | | fuiSymbol Count | 0x74 | 4 | int | Count of fuiSymbol Elements in a file 109 | | fuiBitmap Count | 0x78 | 4 | int | Count of fuiBitmap Elements in a file 110 | | images size | 0x7c | 4 | int | Size of all Images in the file 111 | | fuiFontName Count | 0x80 | 4 | int | Count of fuiFontName Elements in a file 112 | | fuiImportAsset Count | 0x84 | 4 | int | Count of fuiImportAsset Elements in a file 113 | | Frame Size | 0x88 | 0x10 | fuiRect | Size of the frame ? 114 | 115 | ## fuiTimeline 116 | | Name | Offset | Byte Size | Type | Description | 117 | | :-:|:-:|:-:|:-:|:-:| 118 | | Symbol Index | 0x0 | 4 | int | Index of the symbol to use. -1 if it has no symbol linked. 119 | | Frame Index | 0x4 | 2 | short | Index in fuiTimelineFrame array 120 | | Frame Count | 0x6 | 2 | short | Count of how many fuiTimelineFrame's are used 121 | | Action Index | 0x8 | 2 | short | Index in fuiTimelineAction array 122 | | Action Count | 0xa | 2 | short | Count of how many fuiTimelineAction's are used 123 | | Rectangle | 0xc | 0x10 | fuiRect | Unknown fuiRect 124 | 125 | ## fuiTimelineAction 126 | 127 | | Name | Offset | Byte Size | Type | Description | 128 | | :-:|:-:|:-:|:-:|:-:| 129 | | Action Type | 0x0 | 1 | uint8_t | action to make 130 | | Unknown | 0x1 | 1 | uint8_t | 131 | | Frame Index | 0x2 | 2 | short | 132 | | String Arg 0 | 0x4 | 0x40 | char[] | 133 | | String Arg 1 | 0x44 | 0x40 | char[] | 134 | 135 | 136 | ## fuiShape 137 | 138 | | Name | Offset | Byte Size | Type | Description | 139 | | :-:|:-:|:-:|:-:|:-:| 140 | | Unknown | 0x0 | 4 | int | 141 | | Shape Component Index | 0x4 | 4 | int | 142 | | Shape Component Count | 0x8 | 4 | int | 143 | | Rectangle | 0xc | 0x10 | fuiRect | Size of th given Shape(Component) 144 | 145 | ## fuiShapeComponent 146 | 147 | | Name | Offset | Byte Size | Type | Description | 148 | | :-:|:-:|:-:|:-:|:-:| 149 | | Fill Info | 0x0 | 0x24 | fuiFillStyle | Component Fill Info 150 | | Vert Index | 0x24 | 4 | int | 151 | | Vert Count | 0x28 | 4 | int | 152 | 153 | ## fuiVert 154 | 155 | | Name | Offset | Byte Size | Type | Description | 156 | | :-:|:-:|:-:|:-:|:-:| 157 | | X | 0x0 | 4 | float | X Position of the Vertex 158 | | Y | 0x4 | 4 | float | Y Position of the Vertex 159 | 160 | ## fuiTimelineFrame 161 | 162 | | Name | Offset | Byte Size | Type | Description | 163 | | :-:|:-:|:-:|:-:|:-:| 164 | | Frame Name | 0x0 | 0x40 | char[] | Name of the Frame 165 | | Event Index | 0x40 | 4 | int | Index to start from fuiTimelineEvent 166 | | Event Count | 0x44 | 4 | int | Count of fuiTimelineEvents that get used 167 | 168 | ## fuiTimelineEvent 169 | 170 | | Name | Offset | Byte Size | Type | Description | 171 | | :-:|:-:|:-:|:-:|:-:| 172 | | Event Type | 0x0 | 0x1 | uint8_t | 173 | | Unknown | 0x1 | 0x1 | uint8_t | 174 | | Object Type | 0x2 | 0x2 | uint8_t | 175 | | Unknown | 0x3 | 0x1 | uint8_t | 176 | | Unknown | 0x4 | 0x2 | short | 177 | | Index | 0x6 | 0x2 | short | 178 | | Unknown | 0x8 | 0x2 | short | 179 | | Name Index | 0xa | 0x2 | short | index to look up in `fuiTimelineEventName` buffer 180 | | matrix | 0xc | 0x18 | fuiMatrix | 181 | | ColorTransform | 0x24 | 0x20 | fuiColorTransform | Useless 182 | | Color | 0x44 | 4 | fuiRGBA | 183 | 184 | ## fuiTimelineEventName 185 | 186 | | Name | Offset | Byte Size | Type | Description | 187 | | :-:|:-:|:-:|:-:|:-:| 188 | | Event Name | 0x0 | 0x40 | char[] | Name of the Timeline Event 189 | 190 | ## fuiReference 191 | 192 | | Name | Offset | Byte Size | Type | Description | 193 | | :-:|:-:|:-:|:-:|:-:| 194 | | Symbol Index | 0x0 | 4 | int | Index of Symbol (resolved at runtime) 195 | | Name | 0x4 | 0x40 | char[] | Reference to a Symbol that is contained in an Import asset 196 | | Index | 0x44 | 4 | int | fuiFile Index (resolved at runtime) 197 | 198 | ## fuiEdittext 199 | 200 | | Name | Offset | Byte Size | Type | Description | 201 | | :-:|:-:|:-:|:-:|:-:| 202 | | Unknown | 0x0 | 4 | int | 203 | | rectangle | 0x4 | 0x10 | fuiRect | 204 | | Font Id | 0x14 | 4 | int | 205 | | Unknown | 0x18 | 4 | float | 206 | | Color | 0x1c | 4 | fuiRGBA | 207 | | Unknown | 0x20 | 0x18 | int | 6 unknwon int 208 | | Html text | 0x38 | 0x100 | char[] | 209 | 210 | ## fuiFontName 211 | 212 | TODO: get proper names and types! 213 | 214 | | Name | Offset | Byte Size | Type | Description | 215 | | :-:|:-:|:-:|:-:|:-:| 216 | | Id | 0x0 | 4 | int | 217 | | Font Name | 0x4 | 0x40 | char[] | Name of the Font 218 | | Unknown | 0x44 | 4 | int | 219 | | Unknown | 0x48 | 0x40 | char[] | 220 | | Unknown | 0x88 | 4 | int | 221 | | Unknown | 0x8C | 4 | int | 222 | | Unknown | 0x90 | 0x40 | char[] | 223 | | Unknown | 0xd0 | 4 | int | 224 | | Unknown | 0xd4 | 4 | int | 225 | | Unknown | 0xd8 | 0x2c | char[] | 226 | 227 | ## fuiSymbol 228 | 229 | | Name | Offset | Byte Size | Type | Description | 230 | | :-:|:-:|:-:|:-:|:-:| 231 | | Symbol Name | 0x0 | 0x40 | char[] | Name of the Symbol 232 | | Object Type | 0x40 | 4 | int | Symbols can only have two types (2 = Timeline, 3 = Bitmap) 233 | | Index | 0x44 | 4 | int | Index mapped to the object type list 234 | 235 | ## fuiImportAsset 236 | 237 | | Name | Offset | Byte Size | Type | Description | 238 | | :-:|:-:|:-:|:-:|:-:| 239 | | Name | 0x0 | 0x40 | char[] | File Name to import from 240 | 241 | ## fuiBitmap 242 | 243 | | Name | Offset | Byte Size | Type | Description | 244 | | :-:|:-:|:-:|:-:|:-:| 245 | | Symbol Index | 0x0 | 4 | int | Index of a given symbol (-1 if not set). 246 | | Format | 0x4 | 4 | int | Format to use ([see fuiBitmap](./python/fuiDataStructures/fuiBitmap.py#L9)). 247 | | Width | 0x8 | 4 | int | Width of the given Image (possiblly used for memory allocation) 248 | | Height | 0xc | 4 | int | Height of the given Image (possiblly used for memory allocation) 249 | | Offset | 0x10 | 4 | int | Offset of the Image 250 | | Size | 0x14 | 4 | int | Size of the image 251 | | Zlib Data Offset | 0x18 | 4 | int | zlib data start offset (only set when `JPEG_WITH_ALPHA_DATA` is set) 252 | | Texture handle | 0x1c | 4 | int | when set to 0 it'll auto generate the required texture buffer else look it up in a loaded texture map 253 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------