sogen
πͺ Windows & Linux userspace emulator
File Explorer
Download Latest Version (.zip)- build-push.yml
- build.yml
- ci-reusable.yml
- claude.yml
- fuzz.yml
- dependabot.yml
- node-pre-script.js
- android-ndk.cmake
- emscripten.cmake
- ios.cmake
- mingw-w64.cmake
- compiler-env.cmake
- fex.cmake
- reflection-check.cmake
- steam-bridge.cmake
- utils.cmake
- base64
- capstone
- CLI11
- CMakeLists.txt
- FEX
- flatbuffers
- googletest
- googletest.cmake
- gtest-parallel
- minidump_cpp
- nanobind
- reflect
- SDL
- sogen-linux-files
- unicorn
- Vulkan-Headers
- zstd
- zstd.cmake
- ARCHITECTURE.md
- README.md
- fex-backend.md
- gpu-paravirtualization.md
- kvm-backend.md
- multi-vcpu-design.md
- steam-bridge-versioning.md
- steam-bridge.md
- windows-ui-emulation.md
- basic_usage.py
- linux_true.py
- README.md
- emulator-worker.js
- linux-emulator-worker.js
- pinata.png
- badge.tsx
- breadcrumb.tsx
- button.tsx
- card.tsx
- checkbox.tsx
- context-menu.tsx
- dialog.tsx
- drawer.tsx
- dropdown-menu.tsx
- input.tsx
- label.tsx
- popover.tsx
- radio-group.tsx
- scroll-area.tsx
- separator.tsx
- sheet.tsx
- sidebar.tsx
- skeleton.tsx
- tabs.tsx
- tooltip.tsx
- app-sidebar.tsx
- cfg-view.tsx
- debugger-view.tsx
- emulation-summary.tsx
- environment-variable-list.tsx
- error-boundary.tsx
- folder.tsx
- install-prompt.tsx
- item-list.tsx
- memory-view.tsx
- output.tsx
- script-console.tsx
- settings-menu.tsx
- status-indicator.tsx
- text-tooltip.tsx
- theme-provider.tsx
- youtube-video.tsx
- api.ts
- scripting.ts
- application-exit.ts
- debug-command-request.ts
- debug-command-response.ts
- debug-event.ts
- emulation-status.ts
- event.ts
- get-memory-regions-request.ts
- get-memory-regions-response.ts
- get-state-request.ts
- get-state-response.ts
- pause-request.ts
- read-memory-request.ts
- read-memory-response.ts
- read-register-request.ts
- read-register-response.ts
- run-request.ts
- state.ts
- write-memory-request.ts
- write-memory-response.ts
- write-register-request.ts
- write-register-response.ts
- debugger.ts
- events.ts
- use-mobile.ts
- utils.ts
- animation.css
- App.css
- App.tsx
- download.ts
- emulator.ts
- filesystem-explorer.tsx
- filesystem.ts
- Header.tsx
- index.css
- Installer.ts
- landing-page.tsx
- Loader.ts
- main.tsx
- pe-icon-parser.tsx
- playground.tsx
- settings.ts
- vite-env.d.ts
- web-ui-host.ts
- zip-file.ts
- .gitignore
- .prettierignore
- .prettierrc
- components.json
- eslint.config.js
- index.html
- package-lock.json
- package.json
- tsconfig.app.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- icon.ico
- CMakeLists.txt
- main.cpp
- resource.rc
- backend_selection.cpp
- backend_selection.hpp
- CMakeLists.txt
- CMakeLists.txt
- fex_x86_64_common.hpp
- fex_x86_64_emulator.cpp
- fex_x86_64_emulator.hpp
- config.toml
- x86_64bit_v1.lang
- x86_64bit_v1.trans
- x86RealV1.lang
- x86RealV1.trans
- x86smmV1.lang
- x86smmV1.trans
- x86V1.lang
- x86V1.trans
- adx.sinc
- avx.sinc
- avx2.sinc
- avx2_manual.sinc
- avx_manual.sinc
- bmi1.sinc
- bmi2.sinc
- cet.sinc
- clwb.sinc
- fma.sinc
- ia.sinc
- lockable.sinc
- lzcnt.sinc
- macros.sinc
- mpx.sinc
- pclmulqdq.sinc
- rdrand.sinc
- sgx.sinc
- sha.sinc
- smx.sinc
- x86-16-real.pspec
- x86-16.cspec
- x86-16.gdis
- x86-16.pspec
- x86-32-golang.cspec
- x86-32-golang.register.info
- x86-64-compat32.pspec
- x86-64-gcc.cspec
- x86-64-golang.cspec
- x86-64-golang.register.info
- x86-64-win.cspec
- x86-64.dwarf
- x86-64.pspec
- x86-64.slaspec
- x86.dwarf
- x86.ldefs
- x86.opinion
- x86.pspec
- x86.slaspec
- x86borland.cspec
- x86delphi.cspec
- x86gcc.cspec
- x86win.cspec
- icicle.rs
- lib.rs
- registers.rs
- .gitignore
- Cargo.lock
- Cargo.toml
- cargo_build_with_retry.cmake
- CMakeLists.txt
- CMakeLists.txt
- icicle_x86_64_emulator.cpp
- icicle_x86_64_emulator.hpp
- CMakeLists.txt
- kvm_x86_64_common.hpp
- kvm_x86_64_emulator.cpp
- kvm_x86_64_emulator.hpp
- CMakeLists.txt
- function_wrapper.hpp
- unicorn.hpp
- unicorn_hook.hpp
- unicorn_memory_regions.hpp
- unicorn_x86_64_emulator.cpp
- unicorn_x86_64_emulator.hpp
- CMakeLists.txt
- whp_x86_64_emulator.cpp
- whp_x86_64_emulator.hpp
- CMakeLists.txt
- address.cpp
- address.hpp
- socket.cpp
- socket.hpp
- tcp_client_socket.cpp
- tcp_client_socket.hpp
- tcp_server_socket.cpp
- tcp_server_socket.hpp
- udp_socket.cpp
- udp_socket.hpp
- buffer_accessor.hpp
- compression.cpp
- compression.hpp
- concurrency.hpp
- container.hpp
- cpu_features.hpp
- file_handle.hpp
- finally.hpp
- function.hpp
- interupt_handler.cpp
- interupt_handler.hpp
- io.cpp
- io.hpp
- lazy_object.hpp
- moved_marker.hpp
- nt_handle.hpp
- object.hpp
- path_key.hpp
- stat.cpp
- stat.hpp
- string.cpp
- string.hpp
- time.cpp
- time.hpp
- timer.hpp
- wildcard.hpp
- win.hpp
- CMakeLists.txt
- CMakeLists.txt
- debug_session.cpp
- debug_session.hpp
- event_handler.cpp
- event_handler.hpp
- events.fbs
- events_generated.hxx
- message_transmitter.cpp
- message_transmitter.hpp
- CMakeLists.txt
- disassembler.cpp
- disassembler.hpp
- address_utils.hpp
- arch_emulator.hpp
- binary_writer.hpp
- CMakeLists.txt
- cpu_interface.hpp
- empty.cpp
- emulator.hpp
- function_calling_convention.hpp
- generic_logger.hpp
- hook_interface.hpp
- logger.cpp
- logger.hpp
- memory_interface.hpp
- memory_permission.hpp
- memory_region.hpp
- scoped_hook.hpp
- serialization.hpp
- serialization_helper.hpp
- stop_reason.hpp
- typed_cpu.hpp
- typed_emulator.hpp
- x86_register.hpp
- audio_backend.hpp
- compiler.hpp
- elf.hpp
- file_management.hpp
- gdi.hpp
- kernel_mapped.hpp
- memory.hpp
- namespace.hpp
- network.hpp
- platform.hpp
- port.hpp
- primitives.hpp
- process.hpp
- registry.hpp
- status.hpp
- synchronisation.hpp
- threading.hpp
- traits.hpp
- ui_backend.hpp
- unicode.hpp
- user.hpp
- win_pefile.hpp
- window.hpp
- CMakeLists.txt
- segment_utils.hpp
- icon.ico
- CMakeLists.txt
- main.cpp
- resource.rc
- std_include.hpp
- CMakeLists.txt
- fuzzer.cpp
- fuzzer.hpp
- input_generator.cpp
- input_generator.hpp
- random_generator.cpp
- random_generator.hpp
- async_handler.cpp
- async_handler.hpp
- checksum.hpp
- CMakeLists.txt
- connection_handler.cpp
- connection_handler.hpp
- filesystem_interface.hpp
- gdb_stub.cpp
- gdb_stub.hpp
- stream_processor.cpp
- stream_processor.hpp
- CMakeLists.txt
- gpu_bridge_protocol.hpp
- vk_feature_chain.hpp
- CMakeLists.txt
- main.cpp
- CMakeLists.txt
- linux_event_handler.cpp
- linux_event_handler.hpp
- elf_mapping.cpp
- elf_mapping.hpp
- linux_module_manager.cpp
- linux_module_manager.hpp
- file.cpp
- io.cpp
- memory.cpp
- process.cpp
- socket.cpp
- thread.cpp
- time.cpp
- CMakeLists.txt
- linux_emulator.cpp
- linux_emulator.hpp
- linux_emulator_utils.hpp
- linux_fd_table.cpp
- linux_fd_table.hpp
- linux_file_system.hpp
- linux_memory_manager.cpp
- linux_memory_manager.hpp
- linux_process_context.cpp
- linux_process_context.hpp
- linux_stat.hpp
- linux_syscall_dispatcher.cpp
- linux_syscall_dispatcher.hpp
- linux_syscall_numbers.hpp
- linux_syscall_utils.hpp
- linux_thread.hpp
- procfs.cpp
- procfs.hpp
- signal_dispatch.cpp
- signal_dispatch.hpp
- std_include.hpp
- vdso.cpp
- vdso.hpp
- CMakeLists.txt
- emulation_test.cpp
- linux_emulation_test_utils.hpp
- network_address_test.cpp
- path_port_mapping_test.cpp
- thread_scheduler_test.cpp
- torture_elf_loader_test.cpp
- torture_poll_select_epoll_test.cpp
- torture_signals_futex_test.cpp
- torture_syscalls_fd_pipe_test.cpp
- torture_syscalls_mmap_brk_test.cpp
- torture_syscalls_openat_getdents_test.cpp
- CMakeLists.txt
- empty.cpp
- linux_x64_gdb_stub_handler.hpp
- x64_gdb_stub_handler.hpp
- x64_register_mapping.hpp
- x64_target_descriptions.hpp
- CMakeLists.txt
- sogen_api_hooks.cpp
- sogen_bindings.hpp
- sogen_bindings_linux_runtime.cpp
- sogen_bindings_runtime.cpp
- sogen_bindings_types.cpp
- sogen_callbacks.cpp
- sogen_helpers.cpp
- sogen_internal.hpp
- sogen_linux_callbacks.cpp
- sogen_linux_wrappers.cpp
- sogen_module.cpp
- sogen_wrappers.cpp
- test.py
- test_linux.py
- bad.cpp
- CMakeLists.txt
- CMakeLists.txt
- hook-sample.cpp
- CMakeLists.txt
- steam_shim.cpp
- steam_shim.def
- steam_shim_reverse.cpp
- steam_shim_runtime.hpp
- steam_shim_tag.cpp.in
- icon.ico
- CMakeLists.txt
- resource.rc
- test.cpp
- CMakeLists.txt
- vulkan_shim.cpp
- vulkan_shim.def
- CMakeLists.txt
- vulkan-shim-test.cpp
- CMakeLists.txt
- CMakeLists.txt
- steam_bridge_protocol.hpp
- .gitignore
- CMakeLists.txt
- steam_host_backend.cpp
- steam_host_backend.h
- steam_host_runtime.hpp
- steam_host_tag.cpp.in
- steam_reverse.cpp
- steam_reverse.hpp
- CMakeLists.txt
- dump-apiset.cpp
- icon.ico
- CMakeLists.txt
- main.cpp
- resource.rc
- .gitignore
- generate.py
- README.md
- generate.py
- .gitignore
- CMakeLists.txt
- create-profile-dirs.ps1
- create-root.bat
- grab-registry.bat
- install-gpu-runtime.ps1
- install-steam-shim.ps1
- CMakeLists.txt
- vk_bridge_marshal.generated.hxx
- vk_bridge_serial.hpp
- analysis.cpp
- analysis.hpp
- analysis_event.hpp
- analysis_reporter.cpp
- analysis_reporter.hpp
- analysis_reporter_common.hpp
- CMakeLists.txt
- console_reporter.cpp
- disassembler.cpp
- disassembler.hpp
- jsonl_reporter.hpp
- main.cpp
- object_watching.hpp
- reflect_extension.hpp
- reflect_type_info.hpp
- snapshot.cpp
- snapshot.hpp
- std_include.hpp
- stdout_file_reporter.cpp
- stdout_file_reporter.hpp
- tenet_tracer.cpp
- tenet_tracer.hpp
- test.py
- apiset.cpp
- apiset.hpp
- default_apiset.hpp
- default_audio_backend.cpp
- sdl_audio_backend.cpp
- afd_endpoint.cpp
- afd_endpoint.hpp
- afd_types.hpp
- console.cpp
- console.hpp
- gpu_bridge.cpp
- gpu_bridge.hpp
- mount_point_manager.cpp
- mount_point_manager.hpp
- mountmgr.hpp
- named_pipe.hpp
- network_store_interface.cpp
- network_store_interface.hpp
- security_support_provider.cpp
- security_support_provider.hpp
- steam_bridge.cpp
- steam_bridge.hpp
- vulkan_host.cpp
- vulkan_host.hpp
- mapped_module.hpp
- module_manager.cpp
- module_manager.hpp
- module_mapping.cpp
- module_mapping.hpp
- dns_lookup.cpp
- dns_lookup.hpp
- i_socket.hpp
- socket_factory.cpp
- socket_factory.hpp
- socket_wrapper.cpp
- socket_wrapper.hpp
- static_socket_factory.cpp
- static_socket_factory.hpp
- api_port.cpp
- api_port.hpp
- audio_service.cpp
- audio_service.hpp
- core_messaging_registrar.cpp
- core_messaging_registrar.hpp
- dns_resolver.cpp
- dns_resolver.hpp
- lsa_policy_lookup.cpp
- lsa_policy_lookup.hpp
- service_control.cpp
- service_control.hpp
- hive_parser.cpp
- hive_parser.hpp
- registry_file.cpp
- registry_file.hpp
- registry_manager.cpp
- registry_manager.hpp
- registry_utils.hpp
- event.cpp
- exception.cpp
- file.cpp
- gdi.cpp
- io_completion.cpp
- license.cpp
- locale.cpp
- memory.cpp
- mutant.cpp
- namespace.cpp
- object.cpp
- port.cpp
- process.cpp
- registry.cpp
- section.cpp
- semaphore.cpp
- system.cpp
- thread.cpp
- timer.cpp
- token.cpp
- trace.cpp
- user.cpp
- worker_factory.cpp
- default_ui_backend.cpp
- sdl_ui_backend.cpp
- web_ui_backend.cpp
- windows_version_manager.cpp
- windows_version_manager.hpp
- CMakeLists.txt
- cpu_context.cpp
- cpu_context.hpp
- debug_font.hpp
- emulator_thread.cpp
- emulator_thread.hpp
- emulator_utils.hpp
- exception_dispatch.cpp
- exception_dispatch.hpp
- file_system.hpp
- handles.hpp
- io_completion_wait.cpp
- io_completion_wait.hpp
- io_device.cpp
- io_device.hpp
- kernel_lock.hpp
- kusd_mmio.cpp
- kusd_mmio.hpp
- memory_manager.cpp
- memory_manager.hpp
- memory_permission_ext.hpp
- memory_utils.hpp
- minidump_loader.cpp
- minidump_loader.hpp
- port.cpp
- port.hpp
- process_context.cpp
- process_context.hpp
- std_include.hpp
- syscall_dispatcher.cpp
- syscall_dispatcher.hpp
- syscall_utils.hpp
- syscalls.cpp
- user_callback_dispatch.hpp
- user_handle_table.hpp
- win32k_userconnect.cpp
- win32k_userconnect.hpp
- window_destroy_orchestrator.cpp
- window_destroy_orchestrator.hpp
- window_show_orchestrator.cpp
- window_show_orchestrator.hpp
- windows_emulator.cpp
- windows_emulator.hpp
- windows_objects.hpp
- windows_path.hpp
- worker_factory_support.hpp
- wow64_heaven_gate.hpp
- CMakeLists.txt
- device_fuzz.cpp
- fuzz_target.hpp
- libfuzzer_main.cpp
- mock_emulator.hpp
- standalone_main.cpp
- CMakeLists.txt
- emulation_test.cpp
- emulation_test_utils.hpp
- fex_register_test.cpp
- file_system_test.cpp
- host_allocation_test.cpp
- host_memory_test.cpp
- minidump_memory_module_test.cpp
- registry_file_test.cpp
- serialization_test.cpp
- time_test.cpp
- unicode_test.cpp
- vulkan_marshal_test.cpp
- CMakeLists.txt
- empty.cpp
- osabi_template.hpp
- register_entry.hpp
- win_x86_64_gdb_stub_handler.hpp
- windows_filesystem.cpp
- windows_filesystem.hpp
- x64_register_mapping.hpp
- x64_target_descriptions.hpp
- x86_64_gdb_stub_handler.hpp
- x86_register_mapping.hpp
- x86_target_descriptions.hpp
- CMakeLists.txt
- alpc_capture.py
- .clang-format
- .clang-format-ignore
- .clang-tidy
- .gitignore
- .gitmodules
- AGENTS.md
- CLAUDE.md
- CMakeLists.txt
- CMakePresets.json
- LICENSE
- MANIFEST.in
- pyproject.toml
- README.md
π Installation Guide
1. Get the code
git clone https://github.com/momo5502/sogen
Downloads the entire project code from GitHub to your computer.
cd sogen
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install sogen
Installs the package published on PyPI directly β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. CMake
MediumPrerequisites
cmake --preset=vs2022
Type this command into your terminal and run it.
Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).
Pulled directly from this repo's README.
4. Node.js
EasyPrerequisites
cd page
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
5. Python
EasyPrerequisites
pip install sogen
Installs the package published on PyPI directly β no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
6. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cd src/backends/icicle-emulator/icicle-bridge
This project's files live in a subfolder, so move into it first.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)