{"id":13441751,"url":"https://github.com/REGoth-project/REGoth","last_synced_at":"2025-03-20T12:32:40.810Z","repository":{"id":47120065,"uuid":"60484367","full_name":"REGoth-project/REGoth","owner":"REGoth-project","description":"OpenSource-Reimplementation of the zEngine, used by the game \"Gothic\"","archived":false,"fork":false,"pushed_at":"2019-04-18T16:49:48.000Z","size":6518,"stargazers_count":630,"open_issues_count":89,"forks_count":62,"subscribers_count":96,"default_branch":"master","last_synced_at":"2024-10-28T04:19:24.592Z","etag":null,"topics":["cpp","engine","gothic","gothic2","reimplementation"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/REGoth-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-05T22:35:35.000Z","updated_at":"2024-10-19T20:40:58.000Z","dependencies_parsed_at":"2022-09-16T17:40:57.144Z","dependency_job_id":null,"html_url":"https://github.com/REGoth-project/REGoth","commit_stats":null,"previous_names":[],"tags_count":675,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/REGoth-project%2FREGoth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/REGoth-project%2FREGoth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/REGoth-project%2FREGoth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/REGoth-project%2FREGoth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/REGoth-project","download_url":"https://codeload.github.com/REGoth-project/REGoth/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244611408,"owners_count":20481185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpp","engine","gothic","gothic2","reimplementation"],"created_at":"2024-07-31T03:01:37.661Z","updated_at":"2025-03-20T12:32:40.804Z","avatar_url":"https://github.com/REGoth-project.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"# REGoth [![Build status](https://ci.appveyor.com/api/projects/status/50yputp2qe764sg2/branch/master?svg=true)](https://ci.appveyor.com/project/degenerated1123/regoth) [![Build Status](https://travis-ci.org/REGoth-project/REGoth.svg?branch=master)](https://travis-ci.org/REGoth-project/REGoth) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/REGoth/Lobby)\nOpenSource-Reimplementation of the zEngine, used by the game \"Gothic\" and \"Gothic II\".\n\n# Attention!\n**The project has been restarted. Here is the new repository: https://github.com/REGoth-project/REGoth-bs**\n\nDon't forget to check out the [REGoth-Wiki](../../wiki) for more information about the project!\n\nA list showing the current state of the engine, can be found [here](../../wiki/state).\n\n### Videos showing the current state\n* Release-Commentary to V0.4:\n   * https://www.youtube.com/watch?v=DX92f8CrjrE\n* Release-Commentary to V0.3:\n   * https://www.youtube.com/watch?v=EjEpN3I8Ovc\n* Release-Commentary to V0.2:\n   * https://www.youtube.com/watch?v=jB3pzxd6vIk\n* Release-Commentary to V0.1.1:\n   * https://www.youtube.com/watch?v=heg49o78Ii4\n* Dialogs, Audio, NPC script-states:\n   * https://www.youtube.com/watch?v=R3F4WY6A060\n* Day/Night-Cycle and Fighting-animations: \n   * https://www.youtube.com/watch?v=Z1mlI9qxkzc\n* First showcase: \n   * https://www.youtube.com/watch?v=8bLAGttYYpY\n\n# Download (Latest stable version)\n\n**Version 0.4 (Windows)**: https://github.com/REGoth-project/REGoth/releases/tag/0.4\n\n**Version 0.4 (Android)**: https://github.com/REGoth-project/REGoth/releases/tag/0.4-android\n\nAutomated nightly builds: https://github.com/degenerated1123/REGoth/releases\n\n# Source\nMake sure to clone this repository with the `--recursive` flag:\n\n##### ssh:\n```sh\ngit clone --recursive git@github.com:degenerated1123/REGoth.git\n```\n\n##### https:\n```sh\ngit clone --recursive https://github.com/degenerated1123/REGoth.git\n```\n\nTo update the repo, you need to make sure to update the submodules as well. Instead of simply pulling the repository, you can do:\n```sh\ngit pull --recurse-submodules\n```\n\n# Building\n\n\u003e Note: If you are missing packages or are having trouble building on your platform, you can check out this [wiki-page](../../wiki/how-to-build), which may contain more detailed instructions.\n\u003e If you don't find your platform there, I'd kindly ask you to add some instructions for other people to that wiki-page!\n\nYou will need CMake (3.1 or newer) and a C++14-capable compiler.\nCurrently supported/tested are:\n - GCC (6.x)\n - MinGW\n - Visual Studio 2015, 2017\n\nYou will also need a copy of `libsndfile` installed on your computer.\n\n## Obtaining `libsndfile` and `libxinerama`\n\n### *nix systems (Linux, BSD, macOS)\nOn most *nix systems, this can be obtained using a package manager, for example on Debian/Ubuntu:\n\n```sh\n$ sudo apt install libsndfile1-dev libasound2-dev\n$ sudo apt install libxinerama-dev\n```\n\nOr on macOS\n\n```sh\n$ brew install libsndfile # Needs Homebrew\n```\n\n### Windows\n`libsndfile` will need to be compiled separately. Create a directory somewhere on your system to store the compiled files, then run\n\n    mkdir build-libsndfile\n    cd build-libsndfile\n    cmake -D CMAKE_INSTALL_PREFIX=compiled/files/folder path/to/REGoth/lib/libdmusic/utils/dls2sf/lib/libsndfile\n    cmake --build . --target install --config Release\n\n## Compiling REGoth\n\nThen:\n```sh\ncd path/to/REGoth\nmkdir build\ncd build\ncmake -DCMAKE_BUILD_TYPE=Release .. # On *nix systems this is sufficient\ncmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH=compiled/files/folder .. # On Windows\n```\n\u003e If CMake complains about some folders missing a CMakeLists.txt, you most likely forgot to clone with the `--recursive`-flag!\n\u003e Simple do `git submodule update --init --recursive` and it should work.\n\n\nThen, choose depending on your OS:\n\n### Linux, MacOS and other *nix\n```sh\nmake -j4\n```\n\n### Windows\nStarting Visual Studio 2017 you can use the integrated cmake functionality to open the cloned folder.  \nCheck out the [how to build wiki page](../../wiki/how-to-build) for details on this.\n\nFor previous versions of Visual Studio, open the generated `REGoth.sln` and build as usual.  \nAlternatively, you may run this command inside of the build folder:\n```sh\ncmake --build . --config release\n```\n\n\n\n# Running\nThe compiled files are inside the `build/bin` directory.\n\nMake sure to copy the `content/shaders` folder to the working directory of the compiled `REGoth`-Executable.\nThen, run the program with the following flags:\n```sh\nREGoth -g \"path/to/gothic1or2\" -w startworld.zen\n```\n\nWhere `path/to/gothic1or2` points to the root of a Gothic I or II installation and `startworld.zen` is one of the Zen-Files found in a `.vdf`-files in the games `data/`-directory. For example: `newworld.zen` or `addonworld.zen` for Gothic II.\n\n\u003e It is recommended to run this from the commandline, to see the debug-output of the program.\n\nAdditionally, for a list of possible commands, run `REGoth --help`.\n\n# Controls\n\n * Movement: WASD/QE or arrow-keys (Space or Shift to run faster)\n * Actions: Left CTRL for everything\n * Menus: B for status-screen\n * Console: F10\n   * Available commands (square brackets mean optional argument):\n      * `tp [\u003cteleporter:default=player\u003e] \u003ctarget\u003e`: Teleport NPC `teleporter` (= player if none is given) to NPC `target`\n      * `goto waypoint \u003cwaypoint\u003e`: Teleport player to `waypoint`\n      * `kill [\u003cnpc\u003e]`: Kill `npc` or a nearby NPC if none is given\n      * `knockout [\u003cnpc\u003e]`: Knockout `npc` or a nearby NPC if none is given\n      * `save \u003cslotindex\u003e`: Save the game to the given slot\n      * `load \u003cslotindex\u003e`: Load the game from the given slot\n      * `switchlevel \u003czenfile\u003e`: Switch to an other level in current session\n      * `usemana \u003camount\u003e`: Use mana\n      * `hurtself \u003camount\u003e`: Hurt yourself\n      * `set clock \u003chour\u003e [\u003cmin:default=0\u003e]`: Set time of day to `hour`:`min`\n      * `control \u003cnpc\u003e`: Take control over `npc`\n      \n# Development\n\nIf you want to help out and don't know where to start, I suggest reading the [wiki-page](../../wiki), which contains information about the engine-layout and lists of which features are missing (Not yet, though!). \n\n### Examples\n**Gothic 1 - Overworld:** `REGoth -g \"path/to/gothic1\" -w world.zen`\n\n**Gothic 1 - Oldmine:** `REGoth -g \"path/to/gothic1\" -w oldmine.zen`\n\n**Gothic 1 - Freemine:** `REGoth -g \"path/to/gothic1\" -w freemine.zen`\n\n**Gothic 1 - Orc graveyard:** `REGoth -g \"path/to/gothic1\" -w orcgraveyard.zen`\n\n**Gothic 1 - Sleeper temple:** `REGoth -g \"path/to/gothic1\" -w orctempel.zen`\n\n**Gothic 2 - Overworld:** `REGoth -g \"path/to/gothic2\" -w newworld.zen`\n\n**Gothic 2 - Valley of mines:** `REGoth -g \"path/to/gothic2\" -w oldworld.zen`\n\n**Gothic 2 - Addonworld:** `REGoth -g \"path/to/gothic2\" -w addonworld.zen`\n\n**Gothic 2 - Dragonisland:** `REGoth -g \"path/to/gothic2\" -w dragonisland.zen`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FREGoth-project%2FREGoth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FREGoth-project%2FREGoth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FREGoth-project%2FREGoth/lists"}