cemu - GitLite

KO | EN

gitlite — search

#javascript #python #llm #go #linux #docker #java #cli #awesome-list #vue #pytorch #ios #openai #open-source

cemu

(★ 1,018)

Cheap EMUlator: lightweight multi-architecture assembly playground

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
- - build.yml
  - codeql-analysis.yml
  - notify.yml
  - publish.yml
- CONTRIBUTING.md
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- stale.yml
- - __init__.py
  - __main__.py
  - const.py
  - core.py
  - emulator.py
  - errors.py
  - exceptions.py
  - exports.py
  - log.py
  - memory.py
  - os.py
  - settings.py
  - shortcuts.py
  - utils.py
- test_arch.py
- test_basic.py
- test_memory.py
- test_utils.py
.editorconfig
.gitattributes
.gitignore
.pre-commit-config.yaml
.python-version
LICENSE
MANIFEST.in
pyproject.toml
README.md
requirements-dev.lock
requirements.lock

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/hugsy/cemu

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd cemu

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Python

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).

python3 -m pip install install cemu

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python3 -m pip install --user --upgrade git+https://github.com/hugsy/cemu.git@main#egg=cemu

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python3 -m cemu

파이썬 스크립트(또는 모듈)를 실행합니다.

python -m cemu --cli

파이썬 스크립트(또는 모듈)를 실행합니다.

✅ 에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img alt="Logo" src="src/cemu/img/new_logo.png" width=20%>
</p>

<h2 align="center">CEmu : The Cheap (Assembly) Emulator</h2>

<p align="center">
  <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
  <a href="https://github.com/hugsy/cemu/blob/master/LICENSE"><img alt="Licence MIT" src="https://img.shields.io/packagist/l/doctrine/orm.svg?maxAge=2592000?style=plastic"></a>
  <img alt="Python-Version 3.10" src="https://img.shields.io/pypi/pyversions/cemu.svg">
  <a href="https://pypi.org/project/cemu/"><img alt="CEmu on PyPI" src="https://img.shields.io/pypi/v/cemu.svg"></a>
  <a href="https://discord.gg/qBn9MbG9vp"><img alt="CEmu on Discord" src="https://img.shields.io/badge/Discord-CEmu-green"></a>
  <a href="https://pepy.tech/project/cemu"><img alt="Downloads" src="https://static.pepy.tech/badge/cemu"></a>
</p>

## Description

Writing 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.

**CEmu** is built upon:
 * [Keystone](https://github.com/keystone-engine/keystone) for compiling assembly to bytecode
 * [Capstone](https://github.com/aquynh/capstone) for disassembling bytecode
 * [Unicorn](https://github.com/unicorn-engine/unicorn/) for the emulation

And the GUI is powered by in a Qt6.

It allows to test binary samples, check your shellcodes or even simply learn how to write assembly code, all of this for the following architectures:

- x86-32 / x86-64
  - ARM / AArch64
  - MIPS / MIPS64
  - SPARC / SPARC64
  - PPC (but not emulation)

`CEmu` was mostly tested to work on Linux and Windows, but should work on MacOS.

## Installation ##

__Notes__

Since 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 <= 0.2.1 and on Python2, please uninstall it and install it using Python3.

In addition, Python >= 3.10 is required, starting `0.6`.

### Quick install with PIP ###

Last stable from PyPI:

```bash
python3 -m pip install install cemu
```

Last stable from Github:

```bash
python3 -m pip install --user --upgrade git+https://github.com/hugsy/cemu.git@main#egg=cemu
```

For 99% of cases, that's all you need to do. `cemu` will be installed in the associated `Scripts` directory:
 * On Linux by default the executable will be found as `/usr/local/bin/cemu` if installed as root, `~/.local/bin/cemu` for non-root
 * On Windows, `%PYTHON_DIR%\Scripts\cemu.exe` if installed with privileges, `%APPDATA%\Python\Python310\Scripts\cemu.exe` if not

## Usage

### As a GUI

After installing with `pip`, simply run the executable, or invoke via Python

```bash
python3 -m cemu
```

This should produce a GUI similar to this:

![cemu-gui](https://raw.githubusercontent.com/hugsy/cemu/main/src/cemu/img/cemu-windows-light.png)
![cemu-gui](https://raw.githubusercontent.com/hugsy/cemu/main/src/cemu/img/cemu-windows-dark.png)

### In the terminal

```bash
python -m cemu --cli
```

From where you'll end up in a REPL, allowing you to build and run the emulation environment.

![cemu-cli](https://i.imgur.com/SyRJmI5.png)

### As a Library

```bash
python -i -c "import cemu"
```

Then use the provided API to build and run your environment.

## Contribution

`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).

[ ![contributors-img](https://contrib.rocks/image?repo=hugsy/cemu) ](https://github.com/hugsy/cemu/graphs/contributors)

To make contributions, the easiest way to get started is by using [`rye`](https://rye-up.sh) to get everything setup:

```bash
curl -sSf https://rye.astral.sh/get | bash  # opt
rye sync
```

Before 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:

```bash
rye lint
rye fmt
```

Note that any non-compliance will make CI validation fail, therefore preventing your code being merged.

But 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.
And if you can, consider [sponsoring me](https://github.com/hugsy/sponsors) - it really helps dedicating time and resources to the projects!