View source for Biotama/Getting Started

[[Category:Biotama]]
This page has instructions for getting set up on Project ''[[Biotama]]''.

== As a player ==
To try out ''Biotama'', you can just download and run the latest stable build [[Biotama/Latest|here]]. Currently, packaged builds only support Windows. We would like to add support for Linux and macOS in the future.

== As a developer ==
If you would like to contribute to ''Biotama'' as a developer, you will need access to our [https://github.com/ShrimpSquadStudios/Biotama GitHub repository]. You can contact one of our existing developers to request access via the [https://discord.gg/RVhc27mbAc Shrimp Squad Discord server].

=== Prerequisites ===
* A computer with Windows 10 or 11 that meets the [https://dev.epicgames.com/documentation/en-us/unreal-engine/hardware-and-software-specifications-for-unreal-engine minimum specifications for Unreal Engine 5]
* A GitHub account with access to the ''Biotama'' repository
* An Epic Games account

=== Environment Setup ===
Once you have access, you can clone the repository locally and compile the project with the steps below. If you run into any issues, contact '''@ecliptica''' on Discord.

# Download and install the [https://store.epicgames.com/en-US/download Epic Games Launcher].
# Download and install the latest version of Unreal Engine 5 through the launcher.
# Download and install [https://www.jetbrains.com/rider/download/ Rider]. 
# Download and install [https://git-scm.com/install/windows Git]. Unless you're comfortable with Git command-line, we also recommend installing a frontend like [https://gitextensions.github.io/ Git Extensions] or [https://desktop.github.com/download/ GitHub Desktop]. 
# Sync the project from GitHub (https://github.com/ShrimpSquadStudios/Biotama.git).
# In the downloaded project files, right-click `Biotama.uproject` and choose '''Generate Visual Studio Project Files'''.
# Open the .uproject in Rider, and click the green triangle to build and run the project.