At Teverse, we’re always looking to find ways to engage our community with our products. Whether it be on the forum, the discord or through fun coding tasks, our goal is to get you involved.
In the spirit of doing so, we’ve decided to release a full guide that’s geared towards contributing, bug reports, feature requests, code of conduct and setting up a local development workspace. Documentation of our codebase will come in phases as it’s a bit extensive and takes time to properly document. Documentation will be updated/added on our Docs Site and within the codebase itself so, keep a lookout for that.
This guide assumes that you (as the developer) has a working knowledge of the following:
Please read the following before attempting to contribute:
Teverse is comprised of components that work together to help the developer develop and learn about game development. The catalyst that’s used is known as Workshop. Workshop is an interface that allows developers to interact with the Teverse API in a(n) 3D environment.
Note: Make sure you have Teverse installed on your machine before you attempt to do this. It’s not possible to do otherwise. If you don’t have it downloaded, download it here .
Note: Windows 10 is the only platform available for install. While we do support other platforms such as Linux and macOS, we do not have a download option for these platforms at the moment. When it does become available, this guide will be updated.
In order to get started, you must clone the base repository to your local machine. You can use a variety of text editors or shells but, today we’re going to be using Visual Studio Code.
Using Visual Studio Code, we’re going to open up a terminal instance. Navigate to the
Terminal tab and click
New Terminal in the dropdown menu.
Head over to Teverse’s Housing Repository and fork it. This ensures that all changes are pushed to your fork and not to the main repository by mistake.
Navigate to your the fork you’ve just made. The link should look like this https://github.com/YOURUSERNAME/teverse where
YOURUSERNAME is a placeholder for your username on Github.
Obtain the download URL from your fork.
Note: For me, the download URL is https://github.com/Sanjay-B/teverse.git .
Navigate back to Visual Studio Code & clone your fork to your local machine. The directory doesn’t matter but, most sane people clone directly into
Desktop or a folder located in
To clone, we run the following command:
git clone <download url>
Note: For me, I’d run the following:
git clone https://github.com/Sanjay-B/teverse.git
You’ll notice that a folder is now viewable in your Visual Studio Code window. If you click the drop-down, it’ll display all of the files that you cloned from your fork.
Note: Alternatively, pressing Ctrl + R and typing
%localappdata%/teverse/create.luaworks as shorthand.
Now that our fork is installed correctly on our local machine, we have to get Teverse to recognize our fork and not the default repository. We can do this by going to the path
C:\Users\YOURUSERNAME\AppData\Local\Teverse. In this path, you’ll see a file named
Open that file. While the contents provide ample documentation on what to do, I’ve provided a video for those that learn better by visual means.
Note: If you provide the wrong path to your
teversefolder(the folder you cloned previously), Teverse will error and fail to start.
If you’ve successfully followed these steps, you’ll notice the phrase
Beta x.x.x WITH LOCAL TEVGIT .
Note: If you don’t see this by your name and only see a
Beta x.x.x, any local changes to your
teversefolder that you make will not be saved or viewable in
You’ll also notice the
Development tab at the top bar next to
Main. This is only active when a
LOCAL TEVGIT is present. This tab is specifically designed to test workshops and reload certain aspects to see saved changes.
Note: The same items can be seen in
Note: In order to see changes, you must press the
When you’ve made an impressive feature or bug fix, push it to your fork and then open a pull request to the Teverse’s Housing Repository . After, all procedures follow the Teverse’s Contributors Guide .
We hope that this creates a better understanding/foundation for developers to use when learning how to set up Teverse. Feel free to leave a comment about this guide or if you come across any issues.
Can’t wait to see what y’all create!