help.Installation - tooll3/t3 GitHub Wiki

Setup and Installation

Installation

Click the download button for your operating system:

Linux is not officially supported (yet), but some users have had success with it

System Requirements

  • Windows 10 or 11
  • DirectX 11.3 compatible graphics card (we recommend a GTX970 or later)

Installation

  • Download and install:

  • You will also need the Windows Graphics tools:

    • Open Window Settings > System > Optional features.
    • If Graphics Tools is already listed under Installed features, then you're done.
    • Otherwise, click Add an optional feature.
    • Search and select Graphics Tools, and click Install.
  • Download and unzip the latest release

  • Start StartT3.exe

  • If you are using a laptop, make sure that Tooll is running on the dedicated GPU (Nvidia or AMD), otherwise you may see slow performance or crashes.

    • In Windows 11 this is in Settings -> System -> Display -> Graphics.
    • Go to "Add an app" -> "Browse" navigate to your Tooll3 installation folder and select "T3Editor.exe".
    • In the "Options" for the entry select "High performance".
    • In earlier versions of Windows you can set it in the driver utility for your GPU.

Installing with development environment

For developing and debugging C# Operators we recommend setting up the development environment and running it from an IDE like Visual Studio:

Dependencies

If you don't have a .NET IDE installed already, download and install Microsoft Visual Studio Community Edition

  • In the installer, make sure to select the features:
    • .NET Desktop Application development
    • .NET 4.7.1 (on the right side)
  • Download and install .NET 6.0 SDK
  • You might also want to download and install a git client, like git-fork. Alternatively, you can install the bare bone git scm.
  • You also need to install Windows Graphics tools

Cloning the repository

If you don't have a GitHub account

Ideally, it would be better to sign-up. It's free and only takes a minute or so. This allows you to share your changes with the community. If not, do the following:

  • Make sure that you have git scm installed (see above)
  • In file explorer, right-click on the folder where you want to install T3 and select Open git bash here
  • Clone the repository:
git clone [email protected]:tooll3/t3.git

If you have a GitHub account

  • We recommend using ssh
  • Make sure you have an ssh-key installed correctly. GitHub has excellent documentation on this topic
  • With Fork you just clone the repository
  • If you're using the command-line:
git clone  [email protected]:tooll3/t3.git

Github desktop

If you use a Github account, but are uncomfortable with terminals, Github provides a pretty good desktop application for that matter.

Resolve build dependencies

Initialize dependencies and the default view layouts. If you cleaned your solution with Visual Studio, you might need to run the install.bat script gain.

Go to the Install folder and run install.bat it will prompt you with a question, file or folder, choose folder.

Building and starting

  1. Open t3.sln
  2. In the Solution Explorer right click on Player and select Publish
  3. Click on the Publish button
  4. Build the solution
  5. Start the project in Debug or Release mode

Here is a Video showing the entire Visual Studio Install and Build process.

https://github.com/tooll3/t3/assets/3755089/670fe461-e5bc-4974-a59c-40c2946814cd

Setting the startup directory in Rider:

image image

Pitfalls

Bass.DLL not found...

image

Solution: Make sure you ran Install.bat, as described here.

Can't create fonts texture

image

Solution: Make sure to properly adjust the working directory.