Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. 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 image 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

1. Clone the repo

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

2. Check that all dependencies are installed (Only for debian based distros)

   ./debian.sh
   

3. Initialize Git submodules (C-Compiler)

   git submodule update --init --recursive
   

4. Compile and create image

   make compile
   make img
   

5. Launch QEMU

   make qemu
   

6. Use GRUB (Optional)

   make grub
   

MacOS

Currently MacOS cannot natively compile the build tools as they depend on 32bit x86 code. Docker is the simplest way if you still wish to compile the operating system.

1. Clone the repository

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

2. Initialize Git submodules (C-Compiler)

   git submodule update --init --recursive
   

3. Build using Docker

   docker-compose up --build
   

Windows

Use Docker (see MacOS section) or WSL (see Linux section).

(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

Roadmap

• Custom Bootloader & GRUB compatible
• Stage 2 bootloader
• Wallpapers
• Mountable image
• Users
• Multi-threaded pre-emptive scheduling
• GDT & TSS kernel / userspace separation
• Interrupt handling
• PS/2 Keyboard & Mouse, PIT, VESA (640x480x8), RTC, Serial drivers, E1000
• PCI.
• 8Bit RGB to 8Bit VGA
• Filesystem
• Textmode VGA only
• Networkstack
  • Ethernet, IP, ARP, UDP
  • Socket API
  • Interfaces
    • Loopback
  • DHCP
  • DNS
  • TCP
  • Netcat style commands
  • Webserver
  • FTP
  • IRC
  • SSH
  • Telnet
  • HTTP
  • HTML
• ATA IDE Driver
  • Ext2 (like) Filesystem
  • FAT16, support for up to 32mb files.
  • read / write
  • Atapi
• Memory
  • 32bit Virtual Memory
  • kalloc / kfree (kernel)
  • malloc / free (userspace)
• Graphics
  • Window Manager
  • GFXLib
  • Double framebuffer rendering
  • Mouse events
  • Dynamic resize
  • Fullscreen
  • Widgets Library
  • Custom HTML to Widgets
• Terminal, Window Server, Process Informtaion, Finder.
• Library (printf, memcpy, etc)
• IPC
• System calls
• C Compiler / interpreter to bytecode
• Custom VM to run bytecode.
• Editor with Syntax Highlighting
• Calculator
• 3D Game
• Snake game (Textmode only)
• Userspace threads (shared virtual memory)
• Remote virtual terminal over TCP
• LZ compression library
• Tools
  • Build
  • Sync / Migration Took
  • mkfs
  • Testing
  • Create & Encode icons and wallpapers

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Joe Bayer

Project Link: https://github.com/joexbayer/RetrOS-32

(back to top)