{"id":13838360,"url":"https://github.com/hugsy/cemu","last_synced_at":"2025-05-15T11:07:21.528Z","repository":{"id":37747387,"uuid":"58852357","full_name":"hugsy/cemu","owner":"hugsy","description":"Cheap EMUlator: lightweight multi-architecture assembly playground","archived":false,"fork":false,"pushed_at":"2024-08-13T16:35:08.000Z","size":1008,"stargazers_count":986,"open_issues_count":6,"forks_count":99,"subscribers_count":41,"default_branch":"main","last_synced_at":"2025-05-13T00:07:05.224Z","etag":null,"topics":["aarch64","arm","assembly","capstone","keystone","mips","powerpc","shellcode","sparc","unicorn","x86-32","x86-64"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hugsy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":["hugsy"]}},"created_at":"2016-05-15T08:53:50.000Z","updated_at":"2025-05-02T23:54:05.000Z","dependencies_parsed_at":"2024-08-13T19:35:15.316Z","dependency_job_id":"9c22c5cc-8b57-47e1-917c-f62d7afd138f","html_url":"https://github.com/hugsy/cemu","commit_stats":{"total_commits":278,"total_committers":12,"mean_commits":"23.166666666666668","dds":0.4388489208633094,"last_synced_commit":"3f07c36f58ea7a8446241c74d05f33ef8c3a9dbe"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugsy%2Fcemu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugsy%2Fcemu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugsy%2Fcemu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugsy%2Fcemu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugsy","download_url":"https://codeload.github.com/hugsy/cemu/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254328384,"owners_count":22052632,"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":["aarch64","arm","assembly","capstone","keystone","mips","powerpc","shellcode","sparc","unicorn","x86-32","x86-64"],"created_at":"2024-08-04T15:01:52.686Z","updated_at":"2025-05-15T11:07:21.500Z","avatar_url":"https://github.com/hugsy.png","language":"Python","funding_links":["https://github.com/sponsors/hugsy"],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Logo\" src=\"src/cemu/img/new_logo.png\" width=20%\u003e\n\u003c/p\u003e\n\n\u003ch2 align=\"center\"\u003eCEmu : The Cheap (Assembly) Emulator\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hugsy/cemu/blob/master/LICENSE\"\u003e\u003cimg alt=\"Licence MIT\" src=\"https://img.shields.io/packagist/l/doctrine/orm.svg?maxAge=2592000?style=plastic\"\u003e\u003c/a\u003e\n  \u003cimg alt=\"Python-Version 3.10\" src=\"https://img.shields.io/pypi/pyversions/cemu.svg\"\u003e\n  \u003ca href=\"https://pypi.org/project/cemu/\"\u003e\u003cimg alt=\"CEmu on PyPI\" src=\"https://img.shields.io/pypi/v/cemu.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://discord.gg/qBn9MbG9vp\"\u003e\u003cimg alt=\"CEmu on Discord\" src=\"https://img.shields.io/badge/Discord-CEmu-green\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pepy.tech/project/cemu\"\u003e\u003cimg alt=\"Downloads\" src=\"https://static.pepy.tech/badge/cemu\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n## Description\n\nWriting assembly is fun. Assembly is the lowest language (humanly understandable) available to communicate with computers, and is crucial to understand the internal mechanisms of any machine. Unfortunately, setting up an environment to write, compile and run assembly for various architectures (x86, ARM, MIPS, SPARC) has always been painful. **CEmu** is an attempt to fix this by providing GUI, CLI and library that allows to write and test assembly quickly.\n\n**CEmu** is built upon:\n * [Keystone](https://github.com/keystone-engine/keystone) for compiling assembly to bytecode\n * [Capstone](https://github.com/aquynh/capstone) for disassembling bytecode\n * [Unicorn](https://github.com/unicorn-engine/unicorn/) for the emulation\n\nAnd the GUI is powered by in a Qt6.\n\nIt allows to test binary samples, check your shellcodes or even simply learn how to write assembly code, all of this for the following architectures:\n\n  - x86-32 / x86-64\n  - ARM / AArch64\n  - MIPS / MIPS64\n  - SPARC / SPARC64\n  - PPC (but not emulation)\n\n`CEmu` was mostly tested to work on Linux and Windows, but should work on MacOS.\n\n\n## Installation ##\n\n__Notes__\n\nSince version 0.2.2, `cemu` is now Python3 only for simplicity and mostly also due to the fact that Python2 is not developed any longer. If your current installation of `cemu` is \u003c= 0.2.1 and on Python2, please uninstall it and install it using Python3.\n\nIn addition, Python \u003e= 3.10 is required, starting `0.6`.\n\n\n### Quick install with PIP ###\n\nLast stable from PyPI:\n\n```bash\npython3 -m pip install install cemu\n```\n\nLast stable from Github:\n\n```bash\npython3 -m pip install --user --upgrade git+https://github.com/hugsy/cemu.git@main#egg=cemu\n```\n\nFor 99% of cases, that's all you need to do. `cemu` will be installed in the associated `Scripts` directory:\n * On Linux by default the executable will be found as `/usr/local/bin/cemu` if installed as root, `~/.local/bin/cemu` for non-root\n * On Windows, `%PYTHON_DIR%\\Scripts\\cemu.exe` if installed with privileges, `%APPDATA%\\Python\\Python310\\Scripts\\cemu.exe` if not\n\n## Usage\n\n### As a GUI\n\nAfter installing with `pip`, simply run the executable, or invoke via Python\n\n```bash\npython3 -m cemu\n```\n\nThis should produce a GUI similar to this:\n\n![cemu-gui](src/cemu/img/cemu-windows-light.png)\n![cemu-gui](src/cemu/img/cemu-windows-dark.png)\n\n### In the terminal\n\n```bash\npython -m cemu --cli\n```\n\nFrom where you'll end up in a REPL, allowing you to build and run the emulation environment.\n\n![cemu-cli](https://i.imgur.com/SyRJmI5.png)\n\n### As a Library\n\n```bash\npython -i -c \"import cemu\"\n```\n\nThen use the provided API to build and run your environment.\n\n## Contribution\n\n`cemu` was created and maintained by myself, [`@_hugsy_`](https://twitter.com/_hugsy_), but kept fresh thanks to [all the contributors](https://github.com/hugsy/cemu/graphs/contributors).\n\n[ ![contributors-img](https://contrib.rocks/image?repo=hugsy/cemu) ](https://github.com/hugsy/cemu/graphs/contributors)\n\nTo make contributions, the easiest way to get started is by using [`rye`](https://rye-up.sh) to get everything setup:\n\n```bash\ncurl -sSf https://rye.astral.sh/get | bash  # opt\nrye sync\n```\n\nBefore submitting a Pull Request, ensure that both linting and formatting of your new code comply with the project's standards. This can be achieved easily as such:\n\n```bash\nrye lint\nrye fmt\n```\n\nNote that any non-compliance will make CI validation fail, therefore preventing your code being merged.\n\n\nBut if you just like the tool as a user, consider dropping on Discord (or Twitter or other) a simple *\"thanks\"*, it is always very appreciated.\nAnd if you can, consider [sponsoring me](https://github.com/hugsy/sponsors) - it really helps dedicating time and resources to the projects!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugsy%2Fcemu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugsy%2Fcemu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugsy%2Fcemu/lists"}