Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 2.89 KB

Contributing.md

File metadata and controls

34 lines (20 loc) · 2.89 KB

Hi

(This is a work in progress. I imagine these instructions are not amazing. Any feedback or questions are welcome as "issues" on the github.)

We welcome people of all skill levels to participate in the project. However please talk to us first if you want to make a contribution. Either make make an issue here on github, or talk about it in this thread.

We are developing this on linux and windows. Here is some information about getting started:

Make a fork of our repository, RedOnion, on github. Then clone it to your development machine.

Make a new branch with your username in it, and use that to contribute and make pull requests on github.

Linux:

For Linux you have to use the repositories Here to get the best version of the mono tools, including monodevelop (which is a very good ide on linux for c# development). The default version of mono tools on your linux distribution may not work at all with this project.

Note that due to KSP using a version of Unity that was not released for Linux, debugging plugin mods does not seem to work. However, the nature of this project means that we may be able to provide better debugging tools inside for our scripting languages, or even the regular C# development part.

Windows:

On Windows, Visual Studio 2017 Community is the easiest way to contribute.

Common

In order to work with the KSP library dll's, we have a symbolic link called "ksp" we place in the repository directory. The link should link to your KSP game install.

On Windows, you can make symbolic links using mklink. Use the version that has the "/D" option.

Once you have that set up, you can build the project. The output will go into GameData/RedOnion/Plugins. In order for your KSP install to see these resulting dll's, you can create a link in the GameData folder of your ksp install called "RedOnion" that links to GameData/RedOnion in your project folder.

Firda has created a cmd script (create-links.cmd) for windows that will create these links assuming that you have set your ksp install directory in the environment variable "ksp". If you have not, it assumes ksp is installed in the default location it would be installed under steam. ("C:\Program Files (x86)\Steam\steamapps\common\Kerbal Space Program")

Once again, any questions, feedback, concerns for now can be placed into "issues" on the project github page.

If you would like to interact more with us about development, we can give you an invite to our discord.