gurrenm3 / nomanssky.modtemplate

A Mod Template for No Man's Sky mods!

NoMansSky.ModTemplate

A Mod Template for No Man's Sky mods using Reloaded 2 and the No Man's Sky API!

For more info on modding No Mans Sky, check out the modding wiki here: https://github.com/gurrenm3/NoMansSky.Api/wiki

How to use this:

Using this mod template is really easy. Follow the steps below and you'll be making your mod in no time!

1. Make sure you followed all of the steps to install Reloaded II and NoMansSky.Api, found Here
2. Make sure Visual Studio is installed on your computer. This is what we'll be coding our mods in. You can get it Here. Just get the latest version of Visual Studio Community (it's free).
3. Either create a github account or sign into your existing one.
4. Clone this template by clicking the green button that says "Use This Template".
5. You'll be taken to a new page that asks you to put in details like repository name and description. You can put whatever you want but it's usually good practice to put your actual mod's name/description for the repository info. Lastly, set whether or not you want your project to be public or private. I recommend making it public so you can share your mod with others but thats optional. You can always change this stuff later as well.
6. When you're done click "Create repository from template". You will be taken to a new page. This page is for your mod and has contains all the code for it.
7. You're now ready to download your mod and start coding it. There are 2 ways to download it:
   • Using Github Desktop: It's a program made by Github and it makes it very easy to download/manage your code on github. If you don't have it, you can download it here. After it's installed you need to go to the page that was created in step 4 (the one for your mod) and click the green button that says "Code". From there click "Open with Github Desktop". It will open Github Desktop and ask you some questions like where you want to save it. When your done it will be downloaded to your PC. Open up the folder it was downloaded to and you're ready for step 6.
   • If you're not using Github desktop and want to do it by hand instead, go to the page that was created in step 4 (the one for your mod) and click the green button that says "Code". Next click "Download Zip". Save this zip file to a folder that will not be used for anything but your mod. A good place is a new folder on your desktop. Do not save it to your Reloaded II mods folder. Once it's downloaded, extract the zip file and you're ready for step 6.
8. Now that your mod has been downloaded to your computer, you can start working on your mod. Open up the folder you downloaded the code to, then open the file called "NoMansSky.ModTemplate.sln". This is the project that holds all of your code. At this point you have done everything you need to do to start modding No Mans Sky. Enjoy!

Note:

All of your code will go in the Mod.cs file