{"id":17693850,"url":"https://github.com/lah7/sims2-4k-ui-patch","last_synced_at":"2025-04-13T00:50:58.331Z","repository":{"id":131592038,"uuid":"461562885","full_name":"lah7/sims2-4k-ui-patch","owner":"lah7","description":"Work in progress patch program to upscale The Sims 2's UI for 2K/4K displays ","archived":false,"fork":false,"pushed_at":"2025-04-09T15:56:57.000Z","size":630,"stargazers_count":46,"open_issues_count":19,"forks_count":2,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-09T16:51:59.885Z","etag":null,"topics":["dbpf","maxis","sims2"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lah7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-20T17:29:38.000Z","updated_at":"2025-04-09T16:08:20.000Z","dependencies_parsed_at":"2024-06-29T17:36:17.771Z","dependency_job_id":"3b8644d5-963c-46ff-996d-675dbb798847","html_url":"https://github.com/lah7/sims2-4k-ui-patch","commit_stats":null,"previous_names":["lah7/sims2-4k-ui-patch"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lah7%2Fsims2-4k-ui-patch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lah7%2Fsims2-4k-ui-patch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lah7%2Fsims2-4k-ui-patch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lah7%2Fsims2-4k-ui-patch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lah7","download_url":"https://codeload.github.com/lah7/sims2-4k-ui-patch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248650435,"owners_count":21139672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dbpf","maxis","sims2"],"created_at":"2024-10-24T13:47:11.417Z","updated_at":"2025-04-13T00:50:58.310Z","avatar_url":"https://github.com/lah7.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"assets/icon.svg\" alt=\"Project Logo\" height=\"96\"/\u003e\n\n\n# 4K UI Patcher for The Sims 2\n\nA patch utility to upscale The Sims 2's user interface for HiDPI (2K/4K) displays.\n\n\n## About\n\nThrough the use of [graphic rules], it's easy to play The Sims 2 at high\nresolutions, but the buttons, text and interface become super tiny.\n\nThere were no 4K modifications out there to fix the UI. However, I discovered\nthe modularity of the game files allows us to double the UI geometry and graphics,\nsuch as fonts and various `.package` files.\n\nThis project is a patcher program to automatically upscale UI resources from your copy of the game.\n\n[graphic rules]: https://simswiki.info/wiki.php?title=Graphics_Rules_(for_The_Sims_2)\n\n\n## Does it work?\n\nYes, but there's [few visual UI glitches] that may degrade the gameplay experience!\n\nIf you've like to **get involved**, [check out the issues] or [report any glitches].\nSome things are still misaligned or could be improved. Still a work in progress!\n\n[few visual UI glitches]: https://github.com/lah7/sims2-4k-ui-patch/issues?q=is%3Aissue+is%3Aopen+label%3A%22visual+bug%22\n[check out the issues]: https://github.com/lah7/sims2-4k-ui-patch/issues?q=is%3Aissue+is%3Aopen+label%3A%22visual+bug%22\n[report any glitches]: https://github.com/lah7/sims2-4k-ui-patch/issues/new/choose\n\n\n## Compatibility\n\nThis program is compatible with all copies of The Sims 2, expansions and stuff\npacks for PC, and likely the Life Stories series too.\n[The Sims™ 2 Legacy Collection] and [The Sims™ 2: Super Collection] haven't\nbeen tested.\n\nAny downloads or custom content that alters the user interface from your\nThe Sims 2 save folder or game installation folder are not yet patched by\nthis program. It is recommended to disable/uninstall these mods until this is\nintegrated, but you can hack the code to include them[\u003csup\u003e[1]\u003c/sup\u003e](https://github.com/lah7/sims2-4k-ui-patch/issues/46#issuecomment-2289635309)\n\nIt seems that [The Sims™ 2 Legacy Collection] (2025 re-release) is scaling\nthe UI using pixel resolution scaling, but under the hood, it's still at\nits original scaling. Since our patcher modifies the geometry and assets,\nours is native 4K UI, providing much crisper fonts and Sim detail.\n\n[The Sims™ 2 Legacy Collection]: https://store.steampowered.com/app/3314070\n[The Sims™ 2: Super Collection]: https://apps.apple.com/us/app/the-sims-2-super-collection/id883782620?mt=12\n\n\n## Instructions\n\nYour game files are always backed up, so you can revert without reinstalling the game,\nor to repatch later using a newer version of this program with fixes and improvements.\n\nWhile patching, you should have **at least 2 GB of RAM free**. It may take\na while to complete, depending on the performance of your CPU.\n\nThe program automatically checks this repository for an update, to ensure you have the latest version.\n\n\n### Windows\n\n1. Download the latest `windows-x64` asset from the [Releases] page.\n2. Extract the contents and run `sims2-4k-ui-patcher.exe`.\n   * You'll need to run as administrator to modify the game files.\n   * If you don't want to do that, change the permissions of your EA GAMES directory, usually at `C:\\Program Files (x86)\\EA GAMES`.\n3. Click \"Patch\"!\n\nTo run the program, you may need to install [Microsoft Visual C++ Redistributable (x64)](https://aka.ms/vs/17/release/vc_redist.x64.exe).\n\n\n### Linux\n\nFor users who play The Sims 2 under the Wine/Proton compatibility layer. [It works well with DXVK!](https://github.com/lah7/sims2-wine-patches/blob/master/README-D9VK.md)\n\n1. Download the latest `linux-x64` asset from the [Releases] page.\n2. Extract the contents and run `./sims2-4k-ui-patcher`.\n    * You may need to mark it as executable first (usually by right clicking → Properties → Permissions tab).\n3. Find your \"EA GAMES\" directory, e.g. a wine prefix at `~/.wine/drive_c/Program Files (x86)/EA GAMES`.\n4. Click \"Patch\"!\n\n\n### macOS\n\nWe don't have a pre-built binary for macOS, but you can run the Python script directly. See [Development](#development) for instructions.\n\nThis patch program will work fine if you play the game under a Wine compatibility layer.\nHowever, if you purchased the [The Sims™ 2: Super Collection],\nwe don't know whether files are exposed in a way that is compatible with this program. Please let us know!\n\n\n[Releases]: https://github.com/lah7/sims2-4k-ui-patch/releases/latest\n\n\n## Development\n\nThis project is written in Python. To start hacking, clone this repository\nand set up a [virtual environment](https://docs.python.org/3/library/venv.html#creating-virtual-environments)\nto install [requirements.txt](requirements.txt).\n\nPython 3.10 is the minimum supported version.\n\nFor Windows, [install Python 3.13](https://www.python.org/downloads/windows/), and run:\n\n    python -m venv venv\n    venv\\Scripts\\activate\n    pip install --upgrade pip\n    pip install -r requirements.txt\n    python sims2_4k_ui_patcher.py\n\nFor Linux, your distribution likely already has Python 3 installed:\n\n    python3 -m venv venv\n    source venv/bin/activate\n    pip install --upgrade pip\n    pip install -r requirements.txt\n    python3 sims2_4k_ui_patcher.py\n\nAlternatively, you could use your system's interpreter by installing packages\nthat provides the dependencies (names vary by distro):\n\n    python-requests python-pillow python-pyqt6\n\nFor macOS, [install Python 3.13](https://www.python.org/downloads/macos/), and run:\n\n    python3 -m venv venv\n    source venv/bin/activate\n    pip install --upgrade pip\n    pip install -r requirements.txt\n    python3 sims2_4k_ui_patcher.py\n\n\n### Tests\n\nUnit tests check everything is in working order.\n\nYou'll need to copy a file from The Sims 2 University into the `tests/files` folder:\n\n    724723ddc5b020a55bdefc60a7cf1304    The Sims 2 University/TSData/Res/UI/ui.package\n\n**File not included.** With this file present, you can locally run the tests:\n\n    python -m unittest discover ./tests/\n\nThis checks the modules and compression procedures are working correctly.\n\n\n## License\n\n[GNU General Public License v3](LICENSE) (GPLv3)\n\n\n## Acknowledgements\n\nIf you wish to let the wider Sims community know,\nbe sure to leave them a link to this repository!\n\n**Thank you to the following:**\n\nThese wiki pages for documenting the UI, DBPF and compression format:\n\n* \u003chttps://www.wiki.sc4devotion.com/index.php?title=UI\u003e\n* \u003chttps://www.wiki.sc4devotion.com/index.php?title=DBPF\u003e\n* \u003chttps://simswiki.info/wiki.php?title=DBPF\u003e\n* \u003chttps://simswiki.info/index.php?title=DBPF_Compression\u003e\n* \u003chttps://simswiki.info/index.php?title=E86B1EEF\u003e\n* \u003chttps://modthesims.info/wiki.php?title=List_of_Sims_2_Formats_by_Name\u003e\n* \u003chttps://simswiki.info/wiki.php?title=List_of_Sims_2_Formats_by_Name\u003e\n\nThis implementation of the QFS compression algorithm, which we ported to Python:\n\n* https://github.com/memo33/jDBPFX (Java, GPLv3)\n\nAnd [contributors](https://github.com/lah7/sims2-4k-ui-patch/graphs/contributors) who committed fixes!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flah7%2Fsims2-4k-ui-patch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flah7%2Fsims2-4k-ui-patch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flah7%2Fsims2-4k-ui-patch/lists"}