Welcome to Ducky’s documentation!

Ducky is a simple virtual CPU/machine simulator, with modular design and interesting features.

About

• ducky
  • Features
  • Need help?
• Getting started
  • Installing
  • Prerequisites
  • “Hello, world!” tutorial
• Virtual hardware
  • CPU
  • Control coprocessor
  • Exception Vector Table
  • Hardware Description Table
  • Memory
• Software
  • Calling convention
  • Software interrupts
• Tools
  • Common options
  • as
  • ld
  • coredump
  • objdump
  • profile
  • vm
  • img
• Examples
  • “Hello, world!”
  • “Hello, world!” using library
  • VGA
  • Clock
• Glossary

Code Documentation

• ducky.boot module
• ducky.config module
• ducky.console module
• ducky.cpu package
  • Subpackages
    • ducky.cpu.coprocessor package
  • Submodules
    • ducky.cpu.instructions module
    • ducky.cpu.registers module
  • Module contents
• ducky.cpu.coprocessor package
  • Submodules
    • ducky.cpu.coprocessor.control module
    • ducky.cpu.coprocessor.math_copro module
  • Module contents
• ducky.debugging module
• ducky.devices package
  • Submodules
    • ducky.devices.keyboard module
    • ducky.devices.rtc module
    • ducky.devices.snapshot module
    • ducky.devices.storage module
    • ducky.devices.terminal module
    • ducky.devices.tty module
    • ducky.devices.svga module
  • Module contents
• ducky.errors module
• ducky.hdt module
• ducky.interfaces module
• ducky.log module
• ducky.machine module
• ducky.mm package
  • Submodules
    • ducky.mm.binary module
  • Module contents
• ducky.patch module
• ducky.profiler module
• ducky.reactor module
• ducky.snapshot module
• ducky.streams module
• ducky.tools package
  • Submodules
    • ducky.tools.as module
    • ducky.tools.coredump module
    • ducky.tools.defs module
    • ducky.tools.img module
    • ducky.tools.ld module
    • ducky.tools.objdump module
    • ducky.tools.profile module
    • ducky.tools.vm module
  • Module contents
• ducky.util module

Indices and tables

• Index
• Module Index
• Search Page