Skip to content
/ zzio Public

Zanzarah - WIP modding tools and engine remake

License

Notifications You must be signed in to change notification settings

Helco/zzio

Repository files navigation

ZanZarah Engine Reimplementation

This is a project to reimplement the engine of ZanZarah: The Hidden Portal by Funatics. It does not contain any game assets, to be able to use this project one has to buy the original game (e.g. on Steam or an old CD).

Apart from replacing the original engine (at some point), this project contains various tools to inspect and/or modify the game assets.

Currently the game is not yet playable.

Build instructions

For developers who would like to contribute to this project:

  • Install a recent .NET 8 SDK
  • Run ./get-dependencies.sh in the root repository folder
  • Now you should be able to build zzio.sln using the dotnet CLI or your favorite IDE
  • Running zzre.exe --help (or currently better zzre.exe indev --help) gives a list of options you might want to set

Keep in mind, that only Windows is tested regularly at the moment and several changes might be required to run this on Linux or MacOS.

Brief directory summary

Directory Type Contents
zzio Library Read and write functionality for non-standard file formats (e.g. scn, fbs, bsp)
zzre Program Recreation of the engine and associated tools (only viewers at the moment)
zzre.core Library Isolated base and utility functionality used in zzre
zzsc Program Small tool to replace script commands from short to long names
zzio_cli Program Deprecated tool to dump the non-standard file formats into JSON or CSV files
zzio_dbsqlite Program Tool to convert the internal FBS database into a SQLite database
zzio.tests Tests
zzre.core.tests Tests
extern Submodules Git submodules to (forked) dependencies

The previous zzmaps was removed as it was no longer used and caused problems with evolving the rendering code in zzre.

License

This project is licensed using MIT. All dependencies shall be licensed under similar permissive terms.