RetrOS 32bit

Hobby 32bit operatingsystem project focusing on networking on i386 architecture.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

32bit Hobby Operatingsystem with graphics, multitasking and networking!

Started: 12.05.2022

(back to top)

Login

There are 3 default users: system, admin and guest. The password for admin is 'admin', while guest has no password. Currently there is no difference between admin and guest.

You can create a user with the 'admin' command:

admin create <username> <password>

Built With

This project is built with C & Assembly for the kernel, utilities and build system. C++ for userspace applications and Make for compilation. Docker used for crossplatform compilation.

(back to top)

Hardware

Tested on: Lenovo x240, Asus Eee PC series, Dell Optiplex 780, Samsung N150 Plus, Samsung NP-NC10, IBM Thinkpad a21p

Getting Started

Prerequisites

Crossplatform: Docker to compile the .iso file and QEMU for emulation.
For native compilation you will need:

i386-elf-gcc, i386-elf-ld and i386-elf-g++ for MacOS.
build-essential and gcc-multilib for Linux / WSL (ubuntu)
Also need: grub2, xorriso and xxd (for using Grub as bootloader)

Installation

To compile the kernel and its needed programs you simply need to run make img and make qemu to open QEMU

Linux

Clone the repo

git clone https://github.com/joexbayer/RetrOS-32.git

Compile the kernel and create .img file
```
make img
```
Note: needs sudo to mount the .img file and copy over files!
Launch QEMU
```
make qemu
```
Use GRUB (Optional)
```
make grub
```

MacOS

MacOS can compile the kernel but not the needed tools.

Clone the repo

git clone https://github.com/joexbayer/RetrOS-32.git

Compile the kernel / OS

Docker:
```
sudo docker-compose up
```
Launch QEMU
```
make qemu
```
Use GRUB (Optional)
```
make grub
```

Windows

Using Docker (can also compile in WSL)

Clone the repo

git clone https://github.com/joexbayer/RetrOS-32.git

Compile and Launch QEMU
```
./make.cmd run
```

(back to top)

Usage

To run RetrOS-32:

http://copy.sh/v86/ : Upload .img file as Hard disk image.
QEMU: make qemu or qemu-system-i386 <image name>
Real hardware: Burn .iso file to USB or CD (Use a GRUB iso)

(back to top)

Project Structure (TBD)

NETOS - Project
├── Dockerfile 
├── LICENSE.txt
├── Makefile
├── apps (userspace applications)
│   ├── Makefile
│   ├── <app>
│   ├── libcore.a
│   ├── libgraphic.a
│   ├── libnet.a
│   ├── readme.md
│   └── utils
│       └── *.cpp
├── bin 
│   └── *.o
├── boot (custom bootloader)
│   ├── bootloader.s
│   └── multiboot.ld
├── docker-compose.yml
├── docs (documentation)
│   ├── *.md
├── drivers (kernel drivers)
│   └── *.c
├── fs (filesystem)
│   ├── Makefile
│   ├── bin
│   └── *.c
├── graphics
│   └── *.c
├── include
│   ├── arch
│   │   └── *.h
│   ├── fs
│   │   └── *.h
│   ├── gfx
│   │   └── *.h
│   ├── lib
│   │   └── *.h
│   ├── net
│   │   └── *.h
│   └── *.h
├── kernel (main kernel source files)
│   ├── arch
│   │   └── *.c
│   ├── kthreads
│   │   └── *.c
│   └── *.c
├── legacy (old code)
├── lib (libraries)
│   └── *.c
├── net (networking code)
│   └── *.c
├── readme.md
├── rootfs (root filesystem for the OS)
├── tests (testing code)
│   ├── Makefile
│   ├── bin
│   ├── *_test.c
│   └── readme.md
└── tools (build tools)
    ├── scripts
    └── bin
        └── *.c