Skip to content
Snippets Groups Projects

Lynchburg Client

Project Lynchburg
https://git.noc.ruhr-uni-bochum.de/lynchburg/lynchburg-client

Introduction

This is the Lynchburg Client. It is the official "game" part of the Project Lynchburg. It provides the game logic, assets and a graphical menu to access all of its content. The official Lynchburg Client is a Unity project interfacing the Lynchburg Server API, but in theory different clients could be created in different engines or programming languages as long as they respect the API protocol.

License

The Unity project and the source code is licensed under the GPLv3. For more information check the LICENSE file.
For information about contributors goto the Project Lynchburg landing page

However the client contains assets that are differently licensed. All assets that get included in the client must be public domain or own work. All assets contained in the client are therefore equally put into the public domain with the following exceptions:

  • Some music is created by Kevin MacLeod from https://incompetech.com/ Licensed under Creative Commons: By Attribution 3.0 - For a list of used songs see the in-game credits
  • The text-to-speech samples are all created using https://15.ai/
  • Included fonts are created and/or published by Google (https://fonts.google.com/) and licensed under the Open Font License

Installation

  1. Download and extract the latest binary for your operating system
  2. Enter a valid Lynchburg Server URL in the game options (Note: the Project Lynchburg maintainers DO NOT provide an official public server)

Contributing

The current Lynchburg Client uses Unity Version 2021.3.0f1 (LTS). Please use this version exclusively when developing changes and additions.

To contribute, fork this repo to your GitLab account. Then create a new branch in your fork and checkout into it. If you are done committing changes, you can push the branch to your fork and create a merge-request in this project. Your submission will be checked and you will receive feedback. Sometimes a few rounds of feedback are needed to dial in some necessary changes. You can keep commiting and pushing to your branch, the merge-request will be automatically updated.

Please always commit ONLY strictly necessary changes. You may need to clean your merge-request, if you clutter it.