Skip to content

Commit

Permalink
Merge pull request #19 from cskartikey/main
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
cheese3660 authored Feb 26, 2023
2 parents 1ad2aa7 + 1620905 commit 3c67879
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -35,4 +35,3 @@ Still in progress
* *.json
* bin/
* config/

0 comments on commit 3c67879

Please sign in to comment.