Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stwe/mdcii
An unofficial project making from scratch to create an editable Anno 1602 world.
https://github.com/stwe/mdcii
anno-1602 anno1602 game-2d game-development isometric linux mdcii-engine olcpixelgameengine opengl retro
Last synced: 3 months ago
JSON representation
An unofficial project making from scratch to create an editable Anno 1602 world.
- Host: GitHub
- URL: https://github.com/stwe/mdcii
- Owner: stwe
- License: gpl-2.0
- Created: 2022-05-21T09:54:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T15:31:04.000Z (11 months ago)
- Last Synced: 2024-03-09T16:40:33.138Z (11 months ago)
- Topics: anno-1602, anno1602, game-2d, game-development, isometric, linux, mdcii-engine, olcpixelgameengine, opengl, retro
- Language: C++
- Homepage:
- Size: 7.97 MB
- Stars: 6
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MDCII
Another unofficial 1602 AD project. However, the focus here is not on reading the original files, but on creating an editable
isometric game world.
You must have a copy of the original game installed on your computer.
* [Compiling MDCII](#compiling-mdcii)
* [Running MDCII](#running-mdcii)
* [Roadmap](#roadmap-mdcii-v02)
* [Reporting bugs](#reporting-bugs)
* [License](#license)
## Compiling MDCII
### Docker
You need the original Anno files on the container. The best way to do this is to copy the Anno directory into the
project and change the (Linux) path in the config.ini.
***Make sure that under no circumstances does any data end up on public servers such as GitHub or Cloud services.***
Allow connections from the Docker container to the X server:
```bash
xhost +local:docker
```
Run a build:
```bash
docker build . -t stwe/mdcii
```
Starts the container:
```bash
docker run -it \
--device=/dev/dri:/dev/dri \
--group-add video \
--env="DISPLAY" \
--volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" \
stwe/mdcii
```
Stop sharing X server access:
```bash
xhost -local:docker
```
### Using Vcpkg with CMake
You can use any package manager. Currently, I'm using [Vcpkg](https://vcpkg.io/en/).
I can't explain every IDE here, but the short `Vcpkg` story is as follows:
- Clone/install and bootstrap [Vcpkg](https://github.com/Microsoft/vcpkg#getting-started) - Those who use the `CLion`
IDE can now use their Vcpkg plugin.
- Install the [additional packages](#additional-requirements) mentioned below.
- Link the Vcpkg toolchain file.
### Using Vcpkg with CMake and Visual Studio Code
To install `Vcpkg`, you can follow the official instructions on [GitHub](https://github.com/Microsoft/vcpkg#getting-started).
**Step 1: Clone `Vcpkg`**
```bash
git clone https://github.com/Microsoft/vcpkg.git
```
**Step 2: Run the bootstrap script to build `Vcpkg`**
Make sure you are in the `Vcpkg` directory.
```bash
./bootstrap-vcpkg.sh
```
**Step 3: Install libraries**
Make sure you are in the `Vcpkg` directory and install the [Requirements](#additional-requirements):
```bash
./vcpkg install gettext-libintl spdlog imgui protobuf
```
**Step 4: Linking the `Vcpkg` toolchain file**
You will need the full path to your `Vcpkg` repository for linking the `Vcpkg` toolchain file.
Open `settings.json` by selecting `File->Preferences->Settings`.
In the newly opened window, click the editor button to switch to text editing mode. See mouse cursor on the image below.
Now add the following line somewhere within the `settings.json` file
``` json
"cmake.configureSettings": {
"CMAKE_TOOLCHAIN_FILE": "/home/your_name/vcpkg/scripts/buildsystems/vcpkg.cmake"
}
```
It is quite possible that some CMake caches have to be deleted or reloaded at this point.
### Included dependencies
* [olcPixelGameEngine](https://github.com/OneLoneCoder/olcPixelGameEngine)
* [Magic Enum C++](https://github.com/Neargye/magic_enum)
* [FastNoise Lite](https://github.com/Auburn/FastNoiseLite)
* [C++ INI Parser](https://github.com/SSARCandy/ini-cpp)
* [nlohmann::json library](https://github.com/nlohmann/json)
### Additional requirements
* gettext-libintl
* [spdlog](https://github.com/gabime/spdlog)
* [imgui](https://github.com/ocornut/imgui)
* [Protocol Buffers](https://github.com/protocolbuffers/protobuf)
* C++ 20 Compiler (Gcc or MSVC)
### Platforms
The project runs on Windows and Linux.
## Running MDCII
The original game is needed.
For a program start so-called tile atlas graphics are needed, which have to be created first. For this purpose a
`TileAtlasCreator` is located in the `install` directory. See [README](https://github.com/stwe/MDCII/blob/main/install/TileAtlasCreator/README.md).
In the MDCII `config.ini` the paths must be adapted.
**The first start takes longer, because the `haeuser.cod` will be parsed.**
## Roadmap MDCII v0.2
* sound system: play background music and sound effects
* refactoring menus and add missing translations
* it should be possible to build roads
* animations should be possible showing how residents brings goods from A to B; for this the A* algorithm can be implemented
* further down my priority list: the terrain is to be expanded to include rivers and mountains
## Reporting bugs
You can use GitHub [issues](https://github.com/stwe/MDCII/issues) for reporting bugs.
## License
MDCII is licensed under the GPL-2.0 License, see [LICENSE](https://github.com/stwe/MDCII/blob/main/LICENSE) for more information.