Skip to content
ylmrx edited this page Mar 15, 2024 · 12 revisions

Setup and Installation

System Requirements

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

Installation

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 git@github.com: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  git@github.com: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.

This script should be run from its parent folder like so:

cd .\Install
.\install.bat

Building and starting

  1. Open t3.sln
  2. In the Solution Explorer, right click on T3 to open the Properties panel
  3. Under the section Debug, change the Working directory for all build modes to ..
  • This is important, because the Resources folder needs to be on the same logical level as the starting directory
  • If this doesn't match, you will experience errors such as "t3.ico not found"
  1. Start the project in Debug or Release mode

Setting the startup directory in Visual Studio:

image

Here is a Video showing the entire Visual Studio Install and Build process.. once you have successfully created a Tooll3 repo from Github

Tooll3.IDE.install.and.Build.Procedure.mp4

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.

Clone this wiki locally