Difference between revisions of "Getting Started with the LevelKit"

From Off Grid Wiki
Jump to: navigation, search
m (Rich moved page Using the LevelKit to Getting Started with the LevelKit without leaving a redirect: renamed in clearer terms)
(Update LevelKit page)
Line 1: Line 1:
 
== Getting Started ==
 
== Getting Started ==
  
* Download Unity
+
# Download [https://unity3d.com/get-unity Unity]
* Download LevelKit
+
# Download LevelKit
 +
# Open up the LevelKit project in Unity
  
Open up the LevelKit project in Unity
+
Now go to the menu Item for Off Grid and select 'LevelKit Tool'
  
This should give you a fresh and unsaved 'new scene' called 'Untitled'
+
[[File:LevelKitTools-window 01.png|thumb|400px|none|Where to find the LevelKit Tools window]]
  
If you have already been playing with the level kit or already made an Off Grid level and want to make another, then hit Ctrl+N for create a new unsaved scene
+
== Creating a new level ==
(dont use 'create scene' this will create a named saved scene which will conflict with the levelkit tool)
 
  
In your new scene...
+
Once you're in the level Kit project and have opened the LevelKit tool you should be presented with this UI
  
=== Creating a new level ===
+
Enter your missions name and description and hit the "Create new level button"
  
Go to the menu Item for Off Grid and select 'LevelKit Tool'
+
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
 
 
[[File:LevelKitTools-window 01.png|thumb|400px|none|Where to find the LevelKit Tools window]]
 
  
Enter the levels name and a brief description to give contect in the level selection screen.
+
== Your mission folder ==
  
[[File:CreateNewLevel.png|thumb|400px|none|Creat a new level - Don't use the standard Unity workflow of Create>Scene]]
+
Your mission folder contains all the files that the game will read when loading your mission, here's an overview:
  
Hit create and the LevelKit tools will generate all the files and folders you require for organising your mission and building it, along with a player spawn and a gneric room for you to start creating from. At this point you can hit build and you can play already - although your level will be a grey walking simulator to start with ;).
+
{| class="wikitable"
 +
|-
 +
! Folder !! Description
 +
|-
 +
| Bundles/ || This folder shouldn't be edited by users, it contains [https://docs.unity3d.com/Manual/AssetBundlesIntro.html Unity asset bundles]
 +
|-
 +
| level.lua || This contains metadata about the mission that's read in by the game, see [[Level.lua | 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 [[Conversations | conversation scripts]] should be placed here
 +
|-
 +
| Scripts/Devices/ || Your [[Device Scripting | device scripts]] should be placed here
 +
|}
  
[[File:Level-GeneratedFiles.png|400px|thumb|none|The editor tool will generate the files and folders needed]]
+
== The LevelKit GUI ==
 +
'''To do'''

Revision as of 15:05, 6 August 2017

Getting Started

  1. Download Unity
  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

Creating a new level

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

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

The LevelKit GUI

To do