33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
# Wherigo Simulator
|
|
|
|
This project is a desktop application for simulating and running Wherigo geocaches. It allows you to play Wherigo cartridges directly on your computer, making it possible to experience geocaching adventures without a GPS device or mobile app.
|
|
|
|
## Features
|
|
- Load and execute Wherigo cartridges (.gwc files)
|
|
- Simulate geocaching locations and actions
|
|
- Desktop interface for easy navigation and interaction
|
|
- Support for media and cartridge data
|
|
|
|
## Requirements
|
|
- C++23 or newer
|
|
- wxWidgets (for GUI)
|
|
- Lua 5.1.4 (for cartridge execution)
|
|
|
|
## Getting Started
|
|
1. Clone this repository.
|
|
2. Build the project using CMake and your preferred compiler.
|
|
3. Download a Wherigo cartridge (PocketPC format) from [wherigo.com](https://wherigo.com)
|
|
4. Open it in the application.
|
|
|
|
## Project Structure
|
|
- `main/` - Application entry point and UI
|
|
- `libs/cartridge/` - Cartridge parsing and media handling
|
|
- `libs/storage/` - Storage management
|
|
- `libs/lua-5.1.4/` - Lua interpreter
|
|
|
|
## License
|
|
This project is licensed under the MIT License. See `License.md` for details.
|
|
|
|
## Author
|
|
Peter Siegmund (mars3142)
|