Skip to main content

Overview

Embersteel (Relic Run) is an immersive Real-Time Turn-Based Survival Exploration RPG game set in a vast steampunk and sci-fi world. The game is currently at version 0.5.0, with a target of reaching a fully playable vertical slice (version 0.6.0).

Installation

Requirements

  • A Computer Capable of Running Unity
  • Unity Version: 2021.3.22f1
  • Git LFS installed

Setup

  1. Create a new Unity Project

    • You will be syncing the entire contents of your assets folder with the main branch of the repository from step 2.
  2. Clone the repository:

    • This repository should be synced to the contents of your assets folder in your Unity project. git clone https://github.com/JoshuaJDevine/RelicRun
  3. Install Git LFS for the repo:

    • Download and install gitLFS https://git-lfs.com/
    • Also don't forget to run git lfs install in your project directory (that will be your Unity project /assets)
  4. Open the project in Unity.

Contribution

  1. Create your feature branch (git checkout -b feature/YourFeatureOrGeneralDescriptionOfYourWork).
  2. Commit your changes (git commit -m 'Add some feature').
  3. Push to the branch (git push origin feature/YourFeatureOrGeneralDescriptionOfYourWork).
  4. Open a pull request. Assign Josh.

Usage

Details on how to use the project, run tests, and build the game coming soon.

Credits

  • Developer: Joshua Devine
  • Sound Design: Joshua Devine
  • Graphics: Adyn Glowniak
  • Story: Adyn Glowniak