/Client

Hellion client project for the Unity game engine.

Primary LanguageC#GNU General Public License v3.0GPL-3.0

OpenHELLION

Image of the Hellion Project open in the Unity game engine.

This is the client for the Hellion game. It is the main part of the game, with the server always accompanying the client in every release. In the base game, the server is located in the HELLION_SP folder, and contains data such as world saves. A separate repository for the development of the game server also exists.

About Hellion

Hellion Revived is a multiplayer game set in space. You're a part of a mission-gone-wrong to colonise the nearest star. The goal is to survive in space, and to do such you need to follow some quests. The game is an open-world sandbox game, and have features that allow you to build and manage your own space stations and ships.

Info

The game is developed with Unity 2021.3 LTS and Wwise 2021.1 LTS. The game should be cross-platform, but it has only been tested on Windows.

Any improvements you may have are gladly accepted in the form of a pull request. I probably won't bother reviewing pull requests with thousands of lines of code, so please keep them small. If enough people want to become part of the project, I might create a whole team around the development of this game.

How to open

To open this project in the editor, you need to download and install the Wwise Launcher. Adding the program to the Wwise Launcher is as simple as downloading this project and adding it to Unity Hub, but be careful not to open it. Once you have added the project to Unity Hub, it should be visible under the Unity tab.

Before you modify the project, you should download the Wwise SDK, of which I strongly recommend version 2021.1 with default settings, and maybe add some compiler targets for Linux or Mac if you want.

After this, you may modify the project. Choose the SDK you downloaded, and locate your Unity installation. You can apply the changes directly, since you can just revert with Git if it goes wrong.

Open the project in Wwise, set your platform in the dropdown in the upper-left corner. Afterwards, navigate to SoundBanks in the Project Explorer window, right click SoundBanks, and click on Generate Soundbanks for current platform.

Finally, open the editor and let it import. This will initialise all of the mandatory files, and will also increase the size of you project dramatically. You will now have the whole project at your hands.

Minimum requirements

  • 30 GB of disk space
  • 6 GB of RAM
  • 16 GB of RAM to build

Processor and graphics card shouldn't matter much, but it has to at least run Unity; Settings can be modified to increase performance.

Coding style and conventions

It is recommended to read the Unity style guide before writing code for the project, as well as learning about programming patterns.

A rule of thumb when working with this project is to look at other code in the OpenHellion folder when in doubt.

License

All code written by members of the OpenHellion project and affiliates is licenced under GPL-3.0.

All media and assets by members of the OpenHellion project and affiliates, excluding code, is licensed under CC BY-SA 4.0.

Content not produced by members of the OpenHellion project and affiliates belong to their respective authors. No copyright infringement intended.

Resources in the Assets/Plugins and Assets/Wwise folders are licensed under their own terms.