Difference between revisions of "Getting Started with the LevelKit"

From Off Grid Wiki
Jump to: navigation, search
(Added link + brief description)
(order change)
Line 10: Line 10:
 
[[File:LevelKitTools-window 01.png|thumb|400px|none|Where to find the LevelKit Tools window]]
 
[[File:LevelKitTools-window 01.png|thumb|400px|none|Where to find the LevelKit Tools window]]
  
== Creating a new level ==
+
== The LevelKit GUI ==
 +
 
 +
===Create Tab===
 +
[[File:Create tab.png|400px]]
  
 
Once you're in the level Kit project and have opened the LevelKit tool you should be presented with this UI
 
Once you're in the level Kit project and have opened the LevelKit tool you should be presented with this UI
Line 17: Line 20:
  
 
This will create your mission based on a template, it will open up the missions folder in your file browser as well as dropping you into the missions scene in Unity
 
This will create your mission based on a template, it will open up the missions folder in your file browser as well as dropping you into the missions scene in Unity
 +
===Build Tab ===
 +
[[File:Build tab.png|400px]]
 +
===Tweaks Tab ===
 +
[[File:Tweaks tab.png|400px]]
 +
===Validate Tab===
 +
[[File:Validate tab.png|400px]]
 +
===Networking Tab===
 +
[[File:Networking tab.png|400px]]
 +
 +
'''Testing'''
 +
 +
Essentially you need to have a copy of the game running in the background (as in launch it from steam as if you were going to play it)
 +
 +
Then in the Level Kit tools window, click on the settings tab and enable the 'Networking' check box.
 +
 +
 +
From there you can then go back to the build tab on the tools window and hit the 'Search for game' button, then the window should say 'Client:connected'. Then you can hit start and your mod should launch in the version of the game you are running in the background for you to test it!
  
 
== Your mission folder ==
 
== Your mission folder ==
Line 38: Line 58:
 
| Scripts/Devices/ || Your [[Device Scripting | device scripts]] should be placed here  
 
| Scripts/Devices/ || Your [[Device Scripting | device scripts]] should be placed here  
 
|}
 
|}
 
== The LevelKit GUI ==
 
 
Essentially you need to have a copy of the game running in the background (as in launch it from steam as if you were going to play it)
 
 
Then in the Level Kit tools window, click on the settings tab and enable the 'Networking' check box.
 
 
 
From there you can then go back to the build tab on the tools window and hit the 'Search for game' button, then the window should say 'Client:connected'. Then you can hit start and your mod should launch in the version of the game you are running in the background for you to test it!
 
 
== All the  elelments and tabs in the LevelKit GUI described below ==
 
 
Tab ....
 
 
Tab ....
 
  
 
== Building your First Level==
 
== Building your First Level==
  
 
This will take you on a tour around the wiki and the Levelkit [[Building your First Level |click here to get started ]]
 
This will take you on a tour around the wiki and the Levelkit [[Building your First Level |click here to get started ]]

Revision as of 13:52, 24 October 2017

Getting Started

  1. Download Unity. You will need the most up to date version, and to have installed the following components:
    1. ... (Fill in required components here) gardless of whether you are using the Win/Mac/Linux build of the Unity Editor.
  2. Download LevelKit
  3. Open up the LevelKit project in Unity

Now go to the menu Item for Off Grid and select 'LevelKit Tool'

Where to find the LevelKit Tools window

The LevelKit GUI

Create Tab

Create tab.png

Once you're in the level Kit project and have opened the LevelKit tool you should be presented with this UI

Enter your missions name and description and hit the "Create new level button"

This will create your mission based on a template, it will open up the missions folder in your file browser as well as dropping you into the missions scene in Unity

Build Tab

Build tab.png

Tweaks Tab

Tweaks tab.png

Validate Tab

Validate tab.png

Networking Tab

Networking tab.png

Testing

Essentially you need to have a copy of the game running in the background (as in launch it from steam as if you were going to play it)

Then in the Level Kit tools window, click on the settings tab and enable the 'Networking' check box.


From there you can then go back to the build tab on the tools window and hit the 'Search for game' button, then the window should say 'Client:connected'. Then you can hit start and your mod should launch in the version of the game you are running in the background for you to test it!

Your mission folder

Your mission folder contains all the files that the game will read when loading your mission, here's an overview:

Folder Description
Bundles/ This folder shouldn't be edited by users, it contains Unity asset bundles
level.lua This contains metadata about the mission that's read in by the game, see here for more information
Scripts/ The scripts folder should contain all the Lua files that your mission will run
Scripts/Example_mission.lua This is the main mission script, see Mission Scripting for more information
Scripts/Conversations/ Your conversation scripts should be placed here
Scripts/Devices/ Your device scripts should be placed here

Building your First Level

This will take you on a tour around the wiki and the Levelkit click here to get started