Kevirami - Kevins Virtual Amiga

Kevirami is a project to create -- besides UAE and Fellow -- a third Amiga Emulator. Spreading knowledge
across as much brains as possible to me seems like the best way to ensure the preservation of the AMIGA.

Therefore I am creating an emulator from scratch, not looking into the code of UAE as long as possible.
The focus of Kevirami is also clean code, and a good documentation, so that it can be used as a learning
resource as easy as possible.

All existing emulators are written in C. So instead of adding another attemt to the list, I decided to
bring a more modern language to the table, which also might help with clearly pointing out the structures
in easily readable code.

Python is surely a bad choice when it comes to performance, but I try to get the structures right first. As
soon as performance becomes a concern, Kevirami might be ported to Go or Rust.

Development-Roadmap

Kevirami is developed in several phases. The first phases will focus on the Motorola 68000 CPU, while later
phases will address the amigas custom chips. The plan currently looks as follows:

• Phase 1: CPU Emulation
• Create the decoding hardware for the 68000
• Implement a disassembler that uses the decoding logic
• Use a real amiga (or UAE) to assemble sourcecode to object files. Disassemble the object files, compare to original source.
• Implement the immediate surroundings of the CPU (mainly RAM)
• Implement a Monitor-Application for the CPU.
• Implement the instructions.
• Publish 0.1 on PyPi!
• Phase 2: Emulate Kickstart
• Kickstart-Rom will be stepped through, finding out what it does and what hardware it needs to be there first.
• If kickstart hand appears on screen, publish on PyPi.
• Maybe i'll go into retirement somewhere around this time :-)
• If it's to slow in python, port to Go or Rust. Hopefully AI will be able to do it, when that happens :-)
• Phase 3: Custom Chips
• Currently there is no detailed plan for this phase.
• Progress will be guided by what kickstart needs first.
• Phase 4: Play Emerald Mine!
• I'll guess i'll long be dead when that happens.

Using Kevirami

Developing Kevirami

Project-structure, Installing Dependencies and PYTHONPATH configuration.

This Project houses it's sources below the src/kevirami directory. You have
to have this directory in your module-searchpath to execute the project. It should also
be present in the module-searchpath of your IDE.

If using pycharm or any other Jetbrains-based IDE, use
Settings->Project->Project Structure
to mark as sourcefolder the src-folder of this.

The Project requirements, as well as the dev-requirements are intended to be listed in the
pyproject.toml-file (see there)

By issuing:

pip install -e .

you add all the project dependencies as well as the projects sourcefolder to your
[hopefully virtual!] environment, relieving you of the burden of having to manually
installing anything or having to configure your python path by other means.

Likewise you can install all the dev-dependencies by:

pip install -e .'[dev]'