Skip to content

Commit 03c3562

Browse files
Add files via upload
1 parent b9d2dd3 commit 03c3562

File tree

1 file changed

+141
-0
lines changed

1 file changed

+141
-0
lines changed

README.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
# 🌍 World Geography Challenge Application
2+
3+
Welcome to the **World Geography Challenge** — an interactive and educational desktop app built with **Python** and **PyQt5**. Designed for users of all ages, this game makes learning world geography fun and accessible!
4+
5+
---
6+
7+
## 🎯 Purpose & Goals
8+
9+
- 📚 **Educational**: Make geography accessible and engaging for all.
10+
- 🤝 **Open Source**: Encourage contribution, learning, and community development.
11+
- 🔧 **Extensible**: Easily add your own questions or difficulty levels.
12+
- 🌐 **Accessible**: All code, comments, and UI text are in English for global reach.
13+
14+
---
15+
16+
## 🚀 Features
17+
18+
- 🧩 **Three Difficulty Levels**: Easy, Normal, and Hard – 10 randomized questions per level.
19+
-**Instant Feedback**: Know right away whether your answer was correct.
20+
- 📈 **Score Tracking**: Real-time updates to your score.
21+
- 🏆 **Leaderboard**: Compete with yourself or friends for high scores!
22+
- 🎵 **Background Music**: Choose from built-in tracks or add your own.
23+
- ⚙️ **Settings Menu**: Customize your experience.
24+
- 🧱 **Modular Code**: Clean file structure for easy maintenance and contributions.
25+
26+
---
27+
28+
## 🗂️ Project Structure
29+
30+
```
31+
📁 GeographyQuizApp/
32+
├── geograph_with_buttons_3.py # Main launcher
33+
├── easy.py, easy2.py ... easy10.py # Easy questions
34+
├── normal.py, ... normal10.py # Normal questions
35+
├── hard.py, ... hard10.py # Hard questions
36+
├── marks.py # Results screen & leaderboard
37+
├── settings.txt # Settings save
38+
├── data.json # Leaderboard data
39+
├── Project Overview.pdf # Full project documentation
40+
```
41+
42+
---
43+
44+
## 📥 Download & Quick Start
45+
46+
### 🟢 **Download the Ready-to-Use App**
47+
48+
You can always download the latest version of the application without needing to install Python or any libraries!
49+
50+
👉 **Go to [Releases](https://github.com/programmer632/World-Geography-Challenge/releases) and download the latest ZIP from the assets.**
51+
52+
1. Download the `.zip` file from the latest release.
53+
2. Unzip it to a folder of your choice.
54+
3. Run `World Geography Challenge.exe` — and start playing, no installation required!
55+
56+
> All necessary files for the application to work are included in the ZIP.
57+
58+
---
59+
60+
### 🛠️ **Run from Source (Developers/Contributors)**
61+
62+
#### Requirements
63+
64+
- [Python 3.x](https://www.python.org/)
65+
- [PyQt5](https://pypi.org/project/PyQt5/)`pip install PyQt5`
66+
- (Optional) [python-vlc](https://pypi.org/project/python-vlc/) for background music → `pip install python-vlc`
67+
68+
#### Run the Application
69+
70+
1. Clone or download this repository.
71+
2. Run the launcher:
72+
73+
```bash
74+
python World_Geography_Challenge.py
75+
```
76+
77+
3. Choose your difficulty and enjoy the quiz!
78+
79+
---
80+
81+
## 🧪 Example Flow
82+
83+
- Choose your difficulty (Easy / Normal / Hard)
84+
- Answer the 10 multiple-choice questions
85+
- See your score, correct/wrong answers
86+
- Check your position on the leaderboard
87+
- Play again or switch levels 🎮
88+
89+
---
90+
91+
## 💡 Contribution Guide
92+
93+
Contributions are welcome — and beginners are encouraged!
94+
95+
### 🛠️ What You Can Do
96+
97+
- Add new quiz questions or difficulty levels
98+
- Improve UI/UX (themes, animations, layout)
99+
- Translate to other languages
100+
- Implement new game modes (e.g., timed mode, multiplayer)
101+
- Add accessibility features (keyboard support, colorblind mode)
102+
- Write unit tests for core logic
103+
104+
### ✅ How to Contribute
105+
106+
1. Fork the repository
107+
2. Make your changes
108+
3. Open a Pull Request with a clear description
109+
110+
> 📄 **Tip:** Read `Project Overview.pdf` before diving into the code for a full breakdown of how it all works.
111+
112+
---
113+
114+
## 🧰 Files That Store Data
115+
116+
- `settings.txt`: Stores user preferences like music settings.
117+
- `skore.txt`: Keeps your most recent game score.
118+
- `data.json`: Tracks and stores leaderboard information.
119+
120+
---
121+
122+
## 📎 Additional Resources
123+
124+
- 📘 **Documentation**: See `Project Overview.pdf` for a full technical guide.
125+
- 🛠️ Need help? Open an [issue](https://github.com/programmer632/World-Geography-Challenge/issues) or start a discussion.
126+
127+
---
128+
129+
## 📝 License
130+
131+
This project is **open source** and released under a permissive license. Feel free to use, modify, and share it!
132+
133+
---
134+
135+
## 🙌 Final Notes
136+
137+
- No coding experience? No problem — jump in!
138+
- Want to add a fun twist? Suggest or implement it!
139+
- Help us make geography fun and accessible for everyone.
140+
141+
> Let’s build something amazing — one question at a time! 🌍✨

0 commit comments

Comments
 (0)