fkoppe / graveborn

GNU Affero General Public License v3.0
2 stars 0 forks source link

banner

Graveborn

Build status

Overview

Graveborn is a multiplayer game written in Java currently under early development.

Graveborn is licensed under the GNU Affero General Public License v3.0.

Getting Started

To get started with Graveborn, follow these steps:

Prerequisites

Installation

  1. Clone the repository:
    git clone https://github.com/fkoppe/graveborn.git
    cd graveborn
  2. Build the project:
    ./gradlew build
  3. Run the game:
    ./gradlew run

Contributing

We appreciate your contributions to Graveborn! If you would like to contribute, please follow these steps:

Recommended IDEs

Contribution Steps

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-branch
  3. Make your changes and commit them:
    git commit -m 'Add new feature'
  4. Push to your branch:
    git push origin feature-branch
  5. Create a pull request: Go to the original repository on GitHub, navigate to the "Pull requests" tab, and click "New pull request". Select your branch to compare and create the pull request.

Coding Standards

Ensure that your code follows the coding standards outlined in the styleguide file.

Structure

To better understand the gamestructure see the structure file.