C#
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
docs
src
.editorconfig
.gitattributes
.gitignore
LICENSE.md
README.md

README.md

Hero6 Readme

Twitter

Welcome to the Hero6 project. This readme should be included in your copy of Hero6, it is also available in the source code repository. The Hero6 project started in 1999, the project was shut down and the game files released to public in 2011, until it was rebooted by a new team in 2013.

Links

Sponsors

Advanced Installer

The Windows Installer is made with Advanced Installer on an open source license. Advanced Installer allowed us to create a feature complete installer in a user friendly environment with minimal effort.

Build

Build Status

Official Builds

Debug Release
master - -
Windows 7 - -
DirectX
OpenGL
FAKE
Installer -
OS X Sierra
OpenGL
FAKE
Ubuntu 16.04
OpenGL
FAKE

Build Instructions

Windows

Prerequisites
  • To clone the repo you will need git, you will also need git-lfs as we use this to store assets like graphics and audio.
    • If you do not have git-lfs installed you will still be able to clone the repo, but all assets will be corrupt. You can verify if you have it installed with the command git lfs
    • You can use git however you prefer, by bash, GUI frontends like Git Extensions, or whatever git support may be integrated in your IDE of choice. Just make sure that git lfs is working.
  • To build you will need an IDE with MonoGame v3.5 installed. Typically, this will be Visual Studio, but you could also use MonoDevelop/Xamarin Studio. Refer to the MonoGame web pages on how to set up MonoGame with your IDE.
    • We have setup MonoGame in our repository using donwloadable packages, however it is important that you also install MonoGame standalone as it provides the "MonoGame Pipeline" tool. This tool is required to build assets in a format compatible across platforms.
    • If you are not a dedicated coder or contributor to the Hero6 project and want to check out the bleeding-edge builds, you will most likely prefer MonoDevelop/Xamarin Studio. While the Visual Studio IDE takes hours to install and requires several GBs of your disk, Xamarin Studio installs in a few minutes and requires approximately 100+ MBs.
    • Rider EAP has been tested and works with Hero6. However, we will not maintain this compatibility until Rider receives a public release and its conditions for use are well defined.
    • If you want to run our unit tests and are also using Visual Studio you will need the NUnit3 Test Adapter.
    • If you want to build the Windows installer you will need Advanced Installer with a professional License, they also offer Visual Studio Extensions.
Instructions
  1. Fork the project.
  2. Clone the source git clone https://github.com/YourHero6Repository/Hero6.git.
  3. You will need to obtain packages of 3rd party frameworks.
    1. Navigate into the directory ".paket".
    2. Run the command paket.bootstrapper. This will download the most recent and stable version of Paket to the same directory.
    3. Run the command paket restore. In the root directory of your local repository you should now have a new folder "packages".
  4. Open "Hero6.sln" with the IDE of your choice.
  5. Set the build configuration to the platform you want to work with. We have individual Debug and Release configurations for each platform.
    • The default "Debug" and "Release" refers to the Hero6.DesktopGL project.
    • "WindowsDX Debug" and "WindowsDX Release" refers to the Hero6.WindowsDX project.
    • "Android Debug" and "Android Release" refers to the Hero6.Android project.
  6. Set startup project to the project that corresponds with your configuration, "Hero6.Android", "Hero6.DesktopGL" or "Hero6.WindowsDX".
  7. Build.
  8. Run.

Linux and OS X

More coming.

Supported Platforms

Theoretically the OpenGL Windows build should also work with Linux and OS X, but this goes unsupported and unmaintained for now. We also have a build configuration for Android but we do not maintain it.

Contribution

If you are interested in contributing to Hero6 you should read our Getting Started Document.

If you have any general questions that are non development related about Hero6 you can reach us on our forums, or IM. We're also available on Facebook and Twitter.

Changelog

A changelog listing what is new and happening for each version release is at CHANGELOG.md.

License

Licensing details are available at LICENSE.md.