Skip to content

Commit cef1a35

Browse files
authored
Update README.md
1 parent cea588d commit cef1a35

File tree

1 file changed

+42
-66
lines changed

1 file changed

+42
-66
lines changed

README.md

Lines changed: 42 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
1-
2-
# 🔁 Page Replacement Algorithms Simulator (FIFO, LRU, Optimal)
1+
# Virtual Memory Simulator
32

43
## 📌 Overview
54

6-
This project is a Unity-based simulation of **three classic page replacement algorithms**:
7-
- FIFO (First-In, First-Out)
8-
- LRU (Least Recently Used)
9-
- OPT (Optimal)
10-
11-
It was developed as part of an asynchronous final activity for April 11, 2025, in accordance with the instructions from the CCS course's Chapter 10 (Virtual Memory Management).
5+
This project is a Unity-based simulation program that demonstrates the concepts of **Page Replacement Algorithms**:
6+
- **FIFO** (First In First Out)
7+
- **LRU** (Least Recently Used)
8+
- **OPT** (Optimal Replacement)
129

1310
---
1411

15-
## 🎯 Objectives
16-
17-
- Simulate **FIFO**, **LRU**, and **Optimal** page replacement algorithms.
18-
- Use a **randomly generated page reference string** (pages 0–9).
19-
- Accept a **custom number of page frames** at runtime.
20-
- Track and display the **number of page faults** for each algorithm.
21-
- Show **step-by-step GUI representations** for each algorithm.
22-
- Provide **screen captures** and documentation for evaluation.
12+
## 🎮 How to Play
13+
- Select the **number of page frames** and **reference string length** at the start.
14+
- Press the **Generate** Button.
15+
- Press the **Simulate** Button.
16+
- Choose an algorithm (**FIFO**, **LRU**, or **OPT**) to simulate.
17+
- View the number of page faults and simulation details!
2318

2419
---
2520

@@ -36,69 +31,56 @@ Replaces the page that will not be used for the longest time in the future.
3631

3732
---
3833

39-
## 💻 Technologies Used
34+
## 📦 Download & Installation
4035

41-
- Unity (C#)
42-
- TextMeshPro for UI
43-
- Visual Studio Code / Unity Editor
36+
| Version | Link | Instructions |
37+
|:--------|:-----|:-------------|
38+
| Windows (.exe) | **[Download EXE Build](#)** | Download the `.zip` → Extract → Run the `.exe` file |
39+
| Android (.apk) | **[Download APK Build](#)** | Download the `.apk` → Transfer to your phone → Install APK (Allow "Unknown Sources" if needed) |
40+
| Web Browser | **[Play Web Version]([#](https://mumei-28.github.io/VirtualMemorySimulator/))** | Open the link → No installation needed! Just click and play! |
4441

42+
next time ko na update nalang yung exe at apk 😵‍💫
4543
---
4644

47-
## 🗂️ Repository Contents
48-
49-
```
50-
📁 Assets/
51-
├── Scripts/
52-
│ ├── FIFOAlgorithm.cs
53-
│ ├── LRUAlgorithm.cs
54-
│ ├── OptimalAlgorithm.cs
55-
│ └── DataManager.cs
56-
├── Prefabs/
57-
│ ├── FrameSlot.prefab
58-
│ └── FaultText.prefab
59-
├── Scenes/
60-
│ └── MainScene.unity
61-
📄 PageReplacementDocumentation.pdf
62-
📄 PageReplacementExecutable.exe
63-
📄 README.md
64-
```
45+
## 💻 Technologies Used
46+
47+
- Unity (C#)
48+
- TextMeshPro for UI
49+
- Visual Studio Code
50+
- Unity Editor 2022.3.49f1
6551

6652
---
6753

6854
## 📸 Sample Screenshots
6955

70-
The documentation includes **screen captures of three sample inputs and outputs** for each algorithm, showcasing how the system responds to different random reference strings and frame counts.
71-
72-
---
56+
![image](https://github.com/user-attachments/assets/81503940-1247-41b0-a076-e3d57761727a)
7357

74-
## 🚀 How to Run
58+
![image](https://github.com/user-attachments/assets/971769e0-179c-4b5d-a74c-d86ab8326411)
7559

76-
1. Clone the repository:
77-
```bash
78-
git clone https://github.com/your-username/PageReplacementSimulator.git
79-
```
60+
![image](https://github.com/user-attachments/assets/4099109c-8000-41a4-935e-68bf8453abdb)
8061

81-
2. Open the project in **Unity Hub**.
62+
![image](https://github.com/user-attachments/assets/983f3d66-ee6a-4e9a-85dd-133c03e53219)
8263

83-
3. Load the `MainScene.unity`.
64+
![image](https://github.com/user-attachments/assets/190e795c-e411-41f5-bd98-8a87ea6a9d29)
8465

85-
4. Enter the number of frames and click **Generate** to simulate.
66+
![image](https://github.com/user-attachments/assets/9a0a33cd-c44b-461d-9f97-54213f3751f2)
8667

87-
5. Use the respective buttons to simulate:
88-
- FIFO
89-
- LRU
90-
- OPT
68+
---
9169

92-
6. View GUI rendering and fault count per algorithm.
70+
## 🎨 Assets Used
71+
| Asset | Link |
72+
|:------|:-----|
73+
| Font (VT323) | [Google Fonts - VT323](https://fonts.google.com/specimen/VT323) |
74+
| Background Track | [Retro 8-Bit RPG Music Pack (May Genko)](https://assetstore.unity.com/packages/audio/music/retro-8-bit-rpg-music-pack-by-may-genko-249721) |
75+
| Button Sound Effects | [Free UI Click Sound Pack](https://assetstore.unity.com/packages/audio/sound-fx/free-ui-click-sound-pack-244644) |
76+
| GUI Icons | [2D Simple UI Pack](https://assetstore.unity.com/packages/2d/gui/icons/2d-simple-ui-pack-218050) |
9377

9478
---
9579

96-
## 📄 Submission Requirements
97-
98-
✔️ Source Code (with detailed comments)
99-
✔️ Executable File (.exe from Unity build)
100-
✔️ Documentation File (PDF/Word with screenshots)
101-
✔️ GitHub Repository Link ✅
80+
## 📢 Important Notes
81+
- All third-party assets are credited.
82+
- This project is for **educational use only**.
83+
- If you encounter issues installing APKs, allow installation from "Unknown Sources" in your Android settings.
10284

10385
---
10486

@@ -107,12 +89,6 @@ The documentation includes **screen captures of three sample inputs and outputs*
10789
**Marc Jersey M. Castro**
10890
BSCS / CCS Student
10991
Final Project – Chapter 10: Page Replacement Algorithms
110-
April 11, 2025
11192

11293
---
11394

114-
## 📝 License
115-
116-
This project is for academic purposes only.
117-
118-
---

0 commit comments

Comments
 (0)