Getting Started
Hello, and thank you for your interest in The Frozen North! If you would like to contribute, any and all contributions are greatly welcome, and with your help we can shape a truly awesome world for us to play in. If you have any questions, please do not hesitate to ask on Discord.
If you're not interested in contributing (boo!!) and you just want to build the module, just clone the repo and head to the build section!
The following is a guide without using any sort of CLI on a Windows 10 environment. If you already know how to use git from command line and wish to do it that way then this guide may not be for you.
Before we get started, we need a place (GitHub) for us to collaborate in as well as a few tools for module development. The following is needed for that to happen:
- A GitHub account
- GitHub Desktop (optional if you use CLI)
We'll need to fork the repository, which will allow you to play with a copy of a repository. It's found on the top right hand of the page. If you don't see it, then you probably aren't logged in to GitHub.
Next thing we will need to do is clone a local copy of the forked repository using GitHub Desktop. It may prompt you to login, in which case use your GitHub credentials. Now to actually clone the repository, Choose File > Clone repository... or press Control + Shift + O (Command + Shift + O on a Mac)
Next, we'll select your forked repository, which has a "fork" icon with dots and has your GitHub username in it. Make sure you aren't selecting the one with b5635, because that's me!
Press the blue "Clone" button to start downloading a local copy of your repository.
Next, we'll start building the module.