Skip to content

README.md

Latest commit

 

History

History
108 lines (70 loc) · 2.79 KB

README.md

File metadata and controls

108 lines (70 loc) · 2.79 KB

Corewar

Corewar is an algorythmic project at Codam (42). The purpose of this project is to recode the programming game “Core War”.

The project was performed in a group:

the virtual machine and the 'champion' were created by @supalarry and @mincentvulder

the assembler, disassembler and the visualizer were my duty

alt text

There is my own buggy vm included in the repo. I am working on it©️.

SUBJECT

RESOURCES

Wikipedia

Championship 2018 (youtube)

Wiki

This project has a guide.

You can read it at the wiki-pages.

Project Structure

This project consists of five parts:

  • Champion
  • Assembler
  • Disassembler (Bonus)
  • Virtual Machine
  • Visualizer (Bonus, a part of the VM)

How to clone?

If you want to clone the project, you can use the following command:

git clone <repository url>

Installation

Clone repository and then go into the created directory and run the following command:

make

Usage

assembler

Usage: ./asm (champion.s)
    champion.s   — convert from assembly to bytecode

disassembler

Usage: ./dasm (champion.cor)
    champion.cor — convert from bytecode to assembly

corewar

Usage: ./corewar [-a (-dump) <num> [-v] [-n <num>] <champion.cor> <...>
    -a          : Print output from "aff" (Default is off)
    -dump <num> : Dump memory (64 octets per line) after <num> cycles and exit
    -v          : Run visualizer
    -n    <num> : Set <num> of the next player
    -L          : Print all the reports 'alive' to the standard output

visualizer

    up/down arrows    : switch between players
    left/right arrows : switch between processes of selected player
    space             : pause/continue execution
    <                 : go to previous cycle and pause the game
    >, tab            : go to next cycle and pause the game
    To change the history depth(amount of previous cycles available to visualizer), modify the HIST_DEPTH in the visual.h

tester

There is a simple tester included in the repo.

To run it:

    cd test
    sh test.sh -all

It will check makefile, Norminette (complinace with the internal 42 coding standards), assembler, disassembler and the vm against the outputs and behaviour of the reference files original_asm and original_corewar from the directory test.

** Important **

If you don't have the norminette script installed on your machine, you may want to delete or comment out lines 27-34 from the file test.sh.