For who is this guide?

This guide is only for people that don't know how to work with git or GitHub yet. The git steps that are needed for publishing a mod on ParkitectNexus are commonly used. If you can work with git, you don't need this tutorial.

Intro

Most programmers know how to work with git and GitHub but most other workfields have no idea what it does or how to use it. Git is a so-called version control system (vcs), vcs means that you can revert your project to any point in history and have different versions of the same project on different computers (even on the same computer). A coworker can work on one version while you're working on your own version of the project, in the end you can simply merge 2 versions in 1.

GitHub is a website that hosts git repositories, see a repository as 1 project, as long as that repository is open (open source) for everyone, hosting on GitHub is free. This makes it suitable to host the source of mods.

This method is only usable for small mod. If you want to create something medium-large, you should really try to learn real git

Requirements

  • A GitHub account, create one here

How-to

Create repository

We need to create a repository first, this repository has one mod that can be installed through ParkitectNexus.

create repo

Fill in the name of your repository (mod) and add an optional description. Make sure you select that the repo is public and "Initialize this repository with a README", click on "Create repository"

create repo

Uploading files

After creating the repository, click "Upload files".

upload files

Select all files in your mod.

select files

Drag them to GitHub and add a commit message. A commit message represents a short description of what you've changed since last version. Click "Commit changes"

create commit

Creating Release

Now your mod is on GitHub, you do need to create a so called "release" to be able to publish your mod on ParkitectNexus, the ParkitectNexus client will always download your last created release.

Click the releases link.

releases link

Fill in the version of your mod (2 times) and add a short description of what changed since your last release. After that, click "Publish release".

publish release

You're mod is now released and ready to be published on ParkitectNexus. You'll see the following screen.

release created

Publish on ParkitectNexus

Copy the url of your repository, make sure you're not on the release page or something, just the url to the root of your repository.

repo url

Now copy that in the textfield on ParkitectNexus and follow the steps! If you want to publish an update of your mod, repeat the steps of uploading and creating a release. Remember, the client will always download the latest created release.

pn mod