Repository for the Open Tournament Project
Important: If you cloned this repository prior to 2-Aug-20, please make sure you have git lfs installed and re-clone to a new location
Important: If you are cloning this repository to contribute, please ensure to utilize the
unstable
branch as the base as this is the most currently up-to-date branch
The Open Tournament Project is a community-led effort to develop a new game that will recreate and expand upon the formula of Unreal Tournament, Quake, and other classic FPS games.
The Open Tournament Project is an experiment in open game development. The project is run by volunteer efforts from veteran and amateur developers. Our process is itself a work in progress, so bear with us as we find out how to best onboard and collaborate effectively.
If you're reading this there's a good chance you already have a GitHub account, but if you don't then create an account on GitHub!
The Open Tournament project is built using Unreal Engine 5.1. Please ensure that you have the correct engine version installed.
OpenTournament.uproject
from within a text editor. Find the line which says "EngineAssociation" and note the numerical value associated with it.Git is a version control system utilized by GitHub & the Open Tournament project. The Git tool can be interfaced through using the command line, or using graphical frontends such as GitKraken, Git Fork or Sourcetree. Make sure you install Git with LFS support. Please refer to Git, GitHub, or your GUI client's tutorials on how to clone the Open Tournament repository.
NOTE: If you are not a C++ developer, you should not need Visual Studio or any other C++ IDE. Double-click OpenTournament.uproject, and report back to us any issue in Discord.
Development Editor
and platform to Win64
The first step to getting started developing for Open Tournament is to create a fork of the Open Tournament repository on GitHub. This will create a copy of the repository to your GitHub account.
The second step, after you have created a fork, is to clone the fork. Cloning will create a copy of the repository on your computer. Once you have completed this step, you should be able to navigate to the location on your computer where the repository resides and see the Open Tournament project.
Navigate to the location where you cloned the Open Tournament repository and find OpenTournament.uproject. You can run the Open Tournament editor by double clicking the OpenTournament.uproject file.
In the Git commandline, execute the following command:
git remote add upstream https://github.com/OpenTournament/OpenTournament.git
You will occasionally want to ensure that you have the latest updates from the official Open Tournament repository.
In the Git commandline, execute the following command:
git rebase upstream/master
Contributing to Open Tournament is done through GitHub, using the Pull Request (PR) system.
Here is a simple Guide to Submitting Pull Request
In the future, we will have a more defined process & workflow for certain types of content. However, for now here are some basic guidelines for pull requests:
Unfortunately while there is extra effort on the developer side, this is needed in order to keep the PR and review process manageable!
Code and Asset style, formatting, and organization is an important task and is the responsibility of everyone contributing to the project. In order to ensure that your contributions are considered, please follow the following guidelines. If questions arise, defer to the conventions used in the OpenTournament project currently or decide upon & document new conventions.