TerraAngel

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

Installation

Please note that this client is currently only available for Windows and Linux

In order to use it, you will need to have git, powershell7 and the dotnet 8 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 of powershell7

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

3. Run cd TerraAngel and ./scripts/fast.ps1 -Download -Start and wait for it to finish. This may take a few minutes
   

   PS: During this step the console may ask you for your steam username and password if you are on Linux platform
   If you dont want to provide your steam account, or you want to use exist Terraria binaries, you can put the binaries under ./steam/Terraria with Terraria.exe located right under this folder
   Then run ./scripts/fast.ps1 -Download -Start again

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

Updating

To update the client and pull any changes, run ./scripts/fast.ps1 -Update

Then run ./scripts/fast.ps1 -Compile to build the updated client

(Or run ./scripts/fast.ps1 -Update -Compile to pull latest changes and compile at the same time)

Development

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

Run ./scripts/fast.ps1 -Diff to create patches based on your changes

Client features

Features for Terraria developers

• Inspector

  • Inspect player information

  

  • Inspect NPC information

  

  • Inspect projectile information

  

  • Inspect item information

  

• Freecam: allows you to move the camera freely around the game world

• Visual utilities: a range of tools to help visualize various aspects of the game

  • View player hitboxes
  • View player held items
  • View player inventories
  • View NPC hitboxes and visualize NPC lag
  • View projectile hitboxes
  • View tile section borders
  • Disable dust
  • Disable gore
  • Show detailed item tooltips

  

• Interactive C# execution engine (aka REPL)

  • Real time auto-completion

• Net message debugger

  • Logging send and received
  • Stack traces of packets that are sent
  • Send messages with custom values and generate NetMessage.SendData calls

• Disable tile framing

• Supports any CPU (x64 and x86)

• See PLUGINS.md for information about plugins

Other useful features

• Complete re-write of the chat UI
• Complete re-write of the multiplayer server UI
• Anti-Hurt/Godmode
• Fullbright
• Noclip
• Item browser
• Revealing the map
• Infinite reach, mana, and minions
• Access to journey UI
• Butchering NPCs
• Projectile prediction
• Customizable UI
• World edit
  • Tile brush
    • Basic tile manipulation
    • Basic liquid manipluation
  • Copy-pasting parts of the world
• Re-write of how the game stores tiles (game uses 500mb less memory)
• Viewing other players inventories
• Direct screenshots of the map
• Many bugfixes
• Some minor optimizations and performance improvements
• Ability to change FPS cap

Planned features

• Some epic optimizations
• UHHHHHHHH

System Requirements

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

• Windows 7+
• OpenGL 3.0+ or D3D11

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