chairclr / TerraAngel

A Terraria utility client
MIT License
39 stars 7 forks source link

TerraAngel

TerraAngel is a modern and feature-rich utility client for Terraria.


Installation

Please note that this client is currently only available for Windows

In order to use it, you will need to have git and the dotnet 7 SDK installed on your machine

Be sure to restart your computer after you install these

To install the client, follow these steps:

  1. Open a terminal or command prompt

  2. Clone the repository by running the following command: git clone https://github.com/CEO-Chair/TerraAngel.git --recursive

    image

  3. Run the fast_start.bat and wait for it to finish. This may take a few minutes

    image

  4. If the process finishes successfully, the client will be built in the src/TerraAngel/Terraria/bin/Release/net7.0/ folder

    image

    image

Updating

To update the client and pull any changes, run fast_update.bat

Then run fast_compile.bat to build the updated client

Development

After installing the client, you can edit the source code of the client in src/TerraAngel/Terraria

Run fast_diff.bat to create patches based on your changes

Client features

Features for Terraria developers

Other useful features

Planned features

System Requirements

Because TerraAngel uses FNA instead of XNA, not all devices are compatible

How to Contribute

  1. Fork the repository to your own GitHub account.
  2. Make the desired changes in your forked repository.
  3. Open a pull request from your forked repository to the original repository.
  4. The project maintainer will review your pull request and may suggest changes or accept it if it is suitable.

We welcome contributions of all kinds, including code improvements, bug fixes, and new features.

Questions?

Open an issue