JakBaranowski / ground-branch-game-modes

Game modes for Ground Branch.
MIT License
13 stars 7 forks source link
game-modes ground-branch mods

Ground Branch game modes

Development of Ground Branch Game Modes have been moved to the forked project, please go there for the latest release of Ground Branch Game Modes.

Description

This repo contains game modes and missions for Ground Branch, as well as other files neccessary for them to work.

Please keep in mind the game is in early access, and this repo is a work in progress, and therefore everything is subject to change.

Table of contents:

  1. Installation
  2. Updating
  3. How to play
  4. Contributing
  5. Unofficial Ground Branch modding guide
  6. Kudos
  7. License

Installation

To install any game mode follow these instructions:

  1. Go to releases page.
  2. Download the game modes that you want to play.
  3. Unpack the contents of the downloaded zip file to Ground Branch root directory (by default: C:\Program Files (x86)\Steam\steamapps\common\Ground Branch)
  4. If this is not the first game mode you are installing you might need to overwrite some existing files. Don't worry no original game files will be overwritten.
  5. You're ready to play the new game modes. GLHF! :-)

For more detailed instructions visit the Installation and updating wiki page

Updating

Follow the same steps as in the installation guide and overwrite all existing files.

For more detailed instructions visit the Installation and updating wiki page

How to play

You can find a more detailed info on how to play these game modes on the Game modes wiki page.

Contributing

You're more than welcome to clone, fork and send pull requests for this repository. Below is more info how to work with this repo.

If you're interested in collaborating on this project you may find Unofficial Ground Branch modding guide useful.

Cloning

Git does not allow for cloning repositories to not empty directories, that's why you'll need to clone to any empty directory and then copy contents of that directory to Ground Branch root directory.

  1. Open your prefered Git terminal (I recommend Git for Windows)
  2. Clone the repository:
    • HTTPS: git clone https://github.com/JakBaranowski/ground-branch-game-modes.git
    • SSH: git clone git@github.com:JakBaranowski/ground-branch-game-modes.git
  3. Copy files over from the cloned repository to Ground Branch root directory (by default: C:\Program Files (x86)\Steam\steamapps\common\Ground Branch).

Packaging

This project uses gb-tools, and game modes manifests (the *.gbm files), for packaging game modes into zip archives. More details about the gb-tools and manifests can be found on the gb-tools github page.

Unofficial Ground Branch modding guide

If you are interested in creating your own game modes, or you want to collaborate on this project you might find this Ground Branch unofficial modding wiki useful.

Kudos

License

This project uses an MIT license.