https://github.com/corewar/corewar

Typescript implementation of red code parser and core simulator for the classic game Corewar
https://github.com/corewar/corewar

chai corewar corewars game jest redcode sinon typescript

Last synced: 8 days ago
JSON representation

Typescript implementation of red code parser and core simulator for the classic game Corewar

• Host: GitHub
• URL: https://github.com/corewar/corewar
• Owner: corewar
• License: mit
• Created: 2017-11-07T18:40:22.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-01T03:45:17.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T08:52:21.795Z (15 days ago)
• Topics: chai, corewar, corewars, game, jest, redcode, sinon, typescript
• Language: TypeScript
• Homepage:
• Size: 4.35 MB
• Stars: 45
• Watchers: 6
• Forks: 3
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Node.js CI](https://github.com/corewar/corewar/workflows/Node.js%20CI/badge.svg)

![Corewar](https://github.com/corewar/corewar/blob/master/logo.png)

# NOTE: This repository has been deprecated and moved to our new home in the monorepo at: https://github.com/corewar/corewar.io

# Corewar

Typescript / Javascript implementation of the classic game [corewar](https://en.wikipedia.org/wiki/Core_War)

Currently this project contains a redcode parser and core simulator.

In future we hope to include a corewar IDE with debugger, an interactive core simulation and a number of hills. The UI will be provided from this project https://github.com/corewar/corewar-ui

## Getting Started

This project is published to NPM where it is intended to be used as a dependency for UI based projects who wish to use the corewar parser and simulator functionality.

To add it to your UI project, `npm install corewar` and then consume it via an import / require:

`import { corewar } from 'corewar';`

The corewar variable will initialise a new instance of the Api class ready for use.

## Docs

The docs for this project are hosted on [Read the Docs](http://corewar-docs.readthedocs.org)

## API

API documentation is include in the docs: [Read the Docs](http://corewar-docs.readthedocs.io/en/latest/developer/)

## Getting involved

We'd love your feedback, input and PR's. We're a friendly bunch, please contact us through GitHub with questions, suggestions and issues.