From 1620905b9f986e359a9d7376b912c78c1ae3b815 Mon Sep 17 00:00:00 2001 From: Kartikey <64925909+cskartikey@users.noreply.github.com> Date: Sun, 26 Feb 2023 10:09:19 +0530 Subject: [PATCH] Update README.md --- README.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a41e0542..12fc23ec 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ ![Cool Banner](Cool_Banner.png) # Space Warp -Space Warp is a mod loader for kerbal space program 2 -Note: Use at your own risk, this is an early version which is expected to have a lot of changes -# Compiling -In order to compile this project you need the code from kerbal space program 2, so before you can build anything, copy everything in ``Kerbal Space Program 2\KSP2_x64_Data\Managed`` into ``external_dlls/`` +Space Warp is a mod loader for Kerbal Space Program 2. +Note: Use at your own risk, as this is an early version that is expected to undergo many changes. -Then run one of the build scripts and copy the contents from build to KSP2 root directory +## Compiling -Then run KSP2, and wait until the title screen, there should then be a mods folder under the `KSP2_X64_data` folder +To compile this project, you will need to follow these steps: -Then drag any mods into that folder that follow the structure below +1. Copy everything in the ``Kerbal Space Program 2\KSP2_x64_Data\Managed`` folder into the ``external_dlls/`` folder. +2. Run one of the build scripts and copy the contents from the build to the KSP2 root directory. +3. Launch KSP2 and wait until the title screen appears. You should see a mods folder under the `KSP2_X64_data` folder. +4. Drag any mods that follow the structure below into that mods folder. -Mods are just monobehaviours for now, with 2 fields, Logger for Logging, and Manager that points to Spacewarp +Mods are currently implemented as monobehaviours with two fields: a `Logger` for logging and a `Manager` that points to Spacewarp. A mod template generator exists as a Python script. -A mod template generator exists as a python script +## Mod Structure +The mod structure is still a work in progress. However, the current structure is as follows: -## Mods structure -Still in progress * KSP2_directory/KSP2_x64_Data/Mods * example_mod * modinfo.json @@ -35,4 +35,3 @@ Still in progress * *.json * bin/ * config/ -