8086.js

KO | EN

gitlite — search

#javascript #python #react #llm #golang #rust #deep-learning #linux #macos #kubernetes #awesome-list #pytorch #security #open-source

(★ 19)

A basic web-based 8086 emulator built with Javascript :rocket:

8086.js Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Issues][issues-shield]][issues-url]

[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](https://raw.githubusercontent.com/roerohan/8086.js/master/)

<a href="https://github.com/roerohan/8086.js">
 <img src="https://roerohan.github.io/8086.js/8086.svg" alt="Logo" width="240">
 </a>

A basic web-based 8086 emulator built with Javascript.
 
 <a href="https://github.com/roerohan/8086.js">Explore the docs »</a>
 
 
 <a href="https://github.com/roerohan/8086.js">View Demo</a>
 ·
 <a href="https://github.com/roerohan/8086.js/issues">Report Bug</a>
 ·
 <a href="https://github.com/roerohan/8086.js/issues">Request Feature</a>

## Table of Contents

* [About the Project](#about-the-project)
  * [Built With](#built-with)
* [Getting Started](#getting-started)
  * [Prerequisites](#prerequisites)
  * [Installation](#installation)
* [Usage](#usage)
* [Basic Workflow](#basic-workflow)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contributors](#contributors-)

## About The Project

`8086.js` is a basic 8086 emulator built using Javascript, hosted at [https://roerohan.github.io/8086.js/](https://roerohan.github.io/8086.js/).

### Built With

* [React.js](https://arkdownreactjs.org/docs/getting-started.html)
* [Redux](https://redux.js.org/tutorials/essentials/part-1-overview-concepts)
* [Material UI](https://material-ui.com/getting-started/usage/)
* [Ace](https://github.com/ajaxorg/ace)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

You will need the following to be able to run the project.

* [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
* [node (Node.js)](https://nodejs.org)

### Installation
 
1. Clone the Repo

```sh
git clone https://github.com/roerohan/8086.js.git
```

2. Install NPM packages using (npm or yarn)

### Using npm

```sh
npm install
```

### Using yarn

```
yarn install
```

**Note:** If installing the packages with `npm` you get errors use `yarn` to install them.

## Usage

> Note: `8086.js` does not support all instructions, pre-processor directives and interrupts yet. You can check out the supported instructions in the `switch-case` [here](./src/emulator/cpu/core.js).

To run the React App locally, you can run the following command.

1. Run the React App

### Using npm

```sh
npm start
```

### Using yarn

```sh
yarn start
```

## Basic Workflow

The UI is split into 2 major halves, the right half is the `editor` and the left half is the `emulator`. Instructions can be written in the editor, and when they are executed, the registers and memory in the emulator get updated accordingly. There are a few steps which happen in the background to make this possible.

1. An object of the [Emulator](./src/emulator/emulator.js) class is exported, which is the point of interaction between the frontend and the emulation logic.

2. First, the [lexer](./src/emulator/parser/lexer.js) divides the source code into tokens and sends them to a [parser](./src/emulator/parser/parser.js). The parser is responsible for extracting instructions from the tokens and converting them to a form that the `CPU` understands.

3. The [CPU](./src/emulator/cpu/core.js) reads the mnemonic and the operands that were sent to it by the parser, and according to these values, it executes the instructions.

> Note: The communication between the parser and the CPU is NOT in terms of `shellcode`, i.e, `opcode`s and `operands`. The CPU recognizes an instruction by it's `mnemonic`, such as `MOV` or `ADD`.

## Roadmap

See the [open issues](https://github.com/roerohan/8086.js/issues) for a list of proposed features (and known issues).

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'feat: Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

You are requested to follow the contribution guidelines specified in [CONTRIBUTING.md](./CONTRIBUTING.md) while contributing to the project :smile:.

## License

Distributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.

[roerohan-url]: https://roerohan.github.io
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square
[issues-url]: https://github.com/roerohan/8086.js/issues

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tr>
 <td align="center"><a href="https://github.com/roerohan"><img src="https://avatars0.githubusercontent.com/u/42958812?v=4" width="100px;" alt=""/> Rohan Mukherjee</a> <a href="https://github.com/roerohan/8086.js/commits?author=roerohan" title="Code">💻</a> <a href="https://github.com/roerohan/8086.js/commits?author=roerohan" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/thebongy"><img src="https://avatars1.githubusercontent.com/u/7080652?v=4" width="100px;" alt=""/> Rishit Bansal</a> <a href="https://github.com/roerohan/8086.js/commits?author=thebongy" title="Code">💻</a> <a href="https://github.com/roerohan/8086.js/commits?author=thebongy" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/ritika-07"><img src="https://avatars2.githubusercontent.com/u/46575784?v=4" width="100px;" alt=""/> Ritika</a> <a href="https://github.com/roerohan/8086.js/commits?author=ritika-07" title="Code">💻</a></td>
 <td align="center"><a href="https://github.com/capellini"><img src="https://avatars3.githubusercontent.com/u/75311?v=4" width="100px;" alt=""/> Rob Capellini</a> <a href="https://github.com/roerohan/8086.js/commits?author=capellini" title="Code">💻</a></td>
 <td align="center"><a href="https://josesp.netlify.com/"><img src="https://avatars3.githubusercontent.com/u/23442814?v=4" width="100px;" alt=""/> Jose M. Segura Polanco</a> <a href="https://github.com/roerohan/8086.js/commits?author=DarkCode01" title="Code">💻</a></td>
 <td align="center"><a href="https://devenv.now.sh/"><img src="https://avatars1.githubusercontent.com/u/49075129?v=4" width="100px;" alt=""/> Pranav P</a> <a href="https://github.com/roerohan/8086.js/commits?author=pranavp10" title="Code">💻</a></td>
 <td align="center"><a href="https://ffcs.ooo"><img src="https://avatars0.githubusercontent.com/u/14910957?v=4" width="100px;" alt=""/> Namit Nathwani</a> <a href="https://github.com/roerohan/8086.js/commits?author=namsnath" title="Code">💻</a></td>
 </tr>
 <tr>
 <td align="center"><a href="https://github.com/Sanjana-R"><img src="https://avatars0.githubusercontent.com/u/48384242?v=4" width="100px;" alt=""/> Sanjana Rai</a> <a href="https://github.com/roerohan/8086.js/commits?author=Sanjana-R" title="Documentation">📖</a></td>
 <td align="center"><a href="https://github.com/vikitor566"><img src="https://avatars3.githubusercontent.com/u/5832796?v=4" width="100px;" alt=""/> vikitor566</a> <a href="https://github.com/roerohan/8086.js/commits?author=vikitor566" title="Code">💻</a></td>
 </tr>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

8086.js

8086.js Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

8086.js

8086.js Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README