https://wiki.wolfire.com/api.php?action=feedcontributions&feedformat=atom&user=AutiousWolfire Games Wiki - User contributions [en]2026-05-04T18:18:32ZUser contributionsMediaWiki 1.43.6https://wiki.wolfire.com/index.php?title=Portal:Overgrowth&diff=6093Portal:Overgrowth2022-01-12T08:51:03Z<p>Autious: </p>
<hr />
<div><noinclude>[[Category:Portals|{{PAGENAME}}]] [[Category:Overgrowth|{{PAGENAME}}]] </noinclude><br />
{{Overgrowth Portal Header}}<br />
<br />
-----<br />
<br />
<br />
[http://www.wolfire.com/overgrowth Overgrowth] is a cross-platform game developed by Wolfire Games, an independent game development company. Overgrowth is the spiritual successor to [[Lugaru]], an earlier game also developed by Wolfire. Development of Overgrowth was officially announced on September 17th, 2008, and version 1.0 was officially released on October 16th, 2017. The game is currently purchasable via [http://www.wolfire.com/overgrowth/preorder direct order], through [https://www.humblebundle.com/store/overgrowth Humble Bundle], and [http://store.steampowered.com/app/25000/Overgrowth/ Steam].<br />
<br />
Overgrowth's Gameplay emphasizes fluid, fast-paced, 3rd-person perspective armed and unarmed melee combat, 3D-platforming, and stealthy infiltration. Overgrowth uses a custom game engine codenamed "[[Phoenix Engine|Phoenix]]", and a lot of work has been put into making it accessible to [[Editor_Interface|modding]].<br />
<br />
The game currently consists of two campaigns - a remastering of Lugaru in the Phoenix engine, and its successor, the new Overgrowth campaign, as well as a collection of maps (many of which are populated by enemies) which the player is able to explore, fight through, and even modify if they are so inclined. There are three additional gameplay modules, one called "Arena", in which the player is pitted against procedurally generated NPC enemies in gladiatorial matches, and "Versus," a two-player local competitive mode in which you can fight your friends, or enemies! There are also numerous player-made characters, weapons, maps, campaigns, and gameplay modifications available through the [https://steamcommunity.com/app/25000/workshop/ Steam Workshop], and a community-made tool called the [http://forums.wolfire.com/viewtopic.php?f=13&t=14201 SUMlauncher].<br />
<br />
The story of Overgrowth features a continuation of [[Turner]]'s journey, 1 year after the events of [[Lugaru]]. In addition to anthropomorphic rabbits and wolves, the Overgrowth Universe now includes cats, dogs, and rats (see article: [[Races]]), all of whom appear in the main campaign.<br />
<br />
== Playing and Configuring Overgrowth ==<br />
* [[Getting Started]]<br />
* [[Control Reference]]<br />
* [[Configuring Overgrowth]]<br />
* [[Overgrowth FAQ]]<br />
<br />
== The Overgrowth Universe ==<br />
* [[Races]]<br />
* [[Locations]]<br />
* [[Characters (lore)]]<br />
* [[Equipment and Weapons]]<br />
* [[Lore]]<br />
<br />
== Phoenix Engine Documentation ==<br />
<br />
Here we aim to provide comprehensive documentation about all features relevant to modding and level editing.<br />
To get started with the editor, level making and modding, Constance has a really well made video tutorial on youtube https://www.youtube.com/watch?v=eS3RujmDQ2M&list=PLuNY3k_ozhofaucF0mq043_QAj8eEgXzV&index=1<br />
<br />
=== General ===<br />
* [[Creating a new Mod]]<br />
<br />
=== Level Editing ===<br />
* [[Editor Interface]]<br />
* [[Overgrowth Levels | Setting Up a Level - XML Files]]<br />
* [[Prefabs]]<br />
* [[Custom Terrain | Choosing or Creating Terrain]]<br />
* [[Lighting]]<br />
* [[Script Parameters]]<br />
* [[Characters]]<br />
* [[Weapons]]<br />
* [[NPC Navigation]]<br />
* [[Hotspots]]<br />
* [[Dialogue Editor]]<br />
* [[Checkpoints]]<br />
* [[Shader And Weather Effects]]<br />
** [[Rain Weather Effects]]<br />
* [[LevelScripts]]<br />
<br />
=== Asset Creation ===<br />
* [[3D Objects]]<br />
* [[Custom Terrain]]<br />
* [[Custom Weapons & Items |Custom Weapons and Equippable Items]]<br />
* [[Character Models]]<br />
* [[Custom Animations]]<br />
* [[Custom Attacks]]<br />
* [[Particle Effects]]<br />
* [[Custom Decals]]<br />
* [[Binary File Formats]]<br />
* [[Shader Creation]]<br />
<br />
=== Tutorials ===<br />
* [[Making a Pitch Black Level]]<br />
* [[Making New Models & Textures]]<br />
* [[Dialogue]]<br />
<br />
=== Scripting ===<br />
* [[Scripting]]<br />
* [[Common Script External Code]]<br />
* [[Hotspot Scripting]]<br />
** [[Level Script External Code|Hotspot Script External Code]]<br />
* [[LevelScripts]]<br />
** [[Level Script External Code]]<br />
* [[Character Scripting]]<br />
** [[Character Script External Code]]<br />
* [[Editor Camera]]<br />
** [[Editor Camera Script External Code]]<br />
<br />
== Misc ==<br />
* [[Useful Links]]<br />
* [[Supported Video Cards]]<br />
* [[Overgrowth_Linux|Linux]]<br />
* [[Alpha List]]<br />
* [[Overgrowth tests]] {{stub}}<br />
* [[Post Processing Effects]]</div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5929File:Test image 2.png2018-03-22T08:58:32Z<p>Autious: Autious uploaded a new version of File:Test image 2.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5928File:Test image 2.png2018-03-22T08:49:27Z<p>Autious: Autious uploaded a new version of File:Test image 2.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5927File:Test image 2.png2018-03-22T08:48:58Z<p>Autious: Autious uploaded a new version of File:Test image 2.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5926File:Test image 2.png2018-03-22T08:41:18Z<p>Autious: Autious uploaded a new version of File:Test image 2.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5925File:Test image 2.png2018-03-22T08:40:52Z<p>Autious: Autious uploaded a new version of File:Test image 2.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5923File:Test image 2.png2018-03-22T08:16:53Z<p>Autious: Autious uploaded a new version of File:Test image 2.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Test_image_2.png&diff=5922File:Test image 2.png2018-03-22T08:16:19Z<p>Autious: </p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Standardsmall.png&diff=5920File:Standardsmall.png2018-03-22T08:14:24Z<p>Autious: Autious uploaded a new version of File:Standardsmall.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Standardsmall.png&diff=5919File:Standardsmall.png2018-03-22T08:04:07Z<p>Autious: Autious uploaded a new version of File:Standardsmall.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Standardsmall.png&diff=5918File:Standardsmall.png2018-03-22T07:30:22Z<p>Autious: Autious uploaded a new version of File:Standardsmall.png</p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=File:Standardsmall.png&diff=5917File:Standardsmall.png2018-03-22T07:28:59Z<p>Autious: </p>
<hr />
<div></div>Autioushttps://wiki.wolfire.com/index.php?title=Category:Wiki_Contributors&diff=5848Category:Wiki Contributors2018-03-14T09:37:00Z<p>Autious: </p>
<hr />
<div>If you plan to edit the wiki add yourself to this page so we can know who is interested in contributing. Also, if you are contributing to a specific part of the wiki, post it in your talk, or edit this page saying so. This will help future contributors. The wiki will keep track of your work so you can revert to a previous revision if you mess up, don't be afraid to try.<br />
<br />
'''To get access to editing you first have to create an account on the [https://forums.wolfire.com forums] and be a member of the Secret Preorder Forums'''<br />
<br />
Whaleman thanks you!<br />
<br />
==Please Read==<br />
<br />
<br />
* When in doubt reuse a category, don't create your own.<br />
<br />
* When in doubt add to a page, don't create a new one.<br />
<br />
----<br />
<br />
* When uploading photos to the wiki make sure that the file name is unique and explains the photo a little bit. Please be sure and include a description but don't over use categories. Here are the categories you should use for art: {{art image categories}}<br />
<br />
----<br />
<br />
<blockquote>ps If you don't know how to help, look at the wiki editing standards, mess around for a few hours, but be mindful of the category system. also If you think the category system stinks say so, but post what should change before changing everything, I put some effort into how the categories should tunnel down - conner36</blockquote><br />
<br />
[[Category:Categories]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Sandbox&diff=5847Sandbox2018-03-13T19:58:03Z<p>Autious: Created page with "test"</p>
<hr />
<div>test</div>Autioushttps://wiki.wolfire.com/index.php?title=Test&diff=5298Test2017-11-28T09:07:32Z<p>Autious: Created page with "File:Example.jpg"</p>
<hr />
<div>[[File:Example.jpg]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Setting_Writedir&diff=4908Overgrowth Setting Writedir2017-10-27T09:15:33Z<p>Autious: Created page with "== Setting the write dir on Windows Steam == To change your write dir on Windows and Steam to be something else than the default in '''C:\User\<name>\My Documents\Wolfire\Overgr..."</p>
<hr />
<div>== Setting the write dir on Windows Steam ==<br />
<br />
To change your write dir on Windows and Steam to be something else than the default in '''C:\User\<name>\My Documents\Wolfire\Overgrowth''' perform the following steps.<br />
<br />
1. Start Steam<br />
2. Right click Overgrowth, select Properties<br />
3. Click "Set Launch Options"<br />
4. Enter the following: --write-dir C:\OvergrowthData<br />
<br />
''The path can be changed to pretty much anything, but should be limited to shorter paths to not overextend windows older 512 character path limit.''</div>Autioushttps://wiki.wolfire.com/index.php?title=Creating_a_new_Mod&diff=4688Creating a new Mod2017-08-14T11:39:06Z<p>Autious: /* MenuItem */</p>
<hr />
<div>== Folder structure ==<br />
<br />
Overgrowth has a powerful and simple to use mod system that allow modders to create mods by both "overshadowing" existing files, and creating new files.<br />
<br />
Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There each mod folder has a readable name.<br />
<br />
The folder for a mod contains at least a mod.xml file. But usually other data as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mods folder, resulting in the following structure<br />
<br />
Overgrowth/Data/Mods/<br />
└── my_mod/<br />
├── mod.xml<br />
└── Data/<br />
├── Scripts/<br />
├── Shaders/<br />
├── Models/<br />
├── Textures/<br />
└── Levels/<br />
<br />
The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].<br />
<br />
== The mod.xml file ==<br />
<br />
The mod.xml file contains the mods meta data. The game uses this file to understand how to use the mod with the game. Here is a complete example:<br />
<br />
<? xml version="1.0" ?><br />
<Mod><br />
<!-- The ID is necessary and should never change between versions of the same mod --><br />
<Id>unique-name</Id> <br />
<!-- The human readable name is presented in UI's --><br />
<Name>Human Readable Name</Name> <br />
<!-- Version number, can have any formatting you wish. --><br />
<Version>1.2.5</Version><br />
<SupportedVersion>b4</SupportedVersion><br />
<ModDependency><br />
<Id>other-mod2</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
</Mod><br />
<br />
You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.<br />
<br />
== Advanced mod menu ==<br />
<br />
[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]<br />
<br />
To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.<br />
<br />
This shows all the available information for the selected mod.<br />
<br />
== Steam Workshop ==<br />
<br />
[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]<br />
<br />
To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.<br />
<br />
If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.<br />
<br />
Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.<br />
<br />
If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".<br />
<br />
=== Updating a Mod on Steam Workshop ===<br />
<br />
TODO: What is the process for updating an already uploaded mod on Steam Workshop?<br />
<br />
== mod.xml tags ==<br />
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.<br />
<br />
=== Id ===<br />
<br />
The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency.<br />
<br />
Example:<br />
<code><Id>my-mod</Id></code><br />
<br />
=== Name ===<br />
<br />
The name of the mod, shown in the mod menu.<br />
<br />
Example:<br />
<code><Name>My Mod</Name></code><br />
<br />
=== Category ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><Category>Campaign</Category></code><br />
<br />
=== Author ===<br />
<br />
Is shown in the user interface to tell the user who made the mod.<br />
<br />
Example:<br />
<code><Author>John Doe</Author></code><br />
<br />
=== Description ===<br />
<br />
Is shown in the user interface to tell the user what this mod does.<br />
<br />
Example:<br />
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code><br />
<br />
=== Version ===<br />
<br />
The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.<br />
<br />
Example:<br />
<code><Version>1.0.0</Version></code><br />
<br />
=== Thumbnail ===<br />
<br />
The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.<br />
<br />
Example:<br />
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code><br />
<br />
=== PreviewImage ===<br />
<br />
This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.<br />
<br />
Example:<br />
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code><br />
<br />
=== Tag ===<br />
<br />
Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.<br />
<br />
Example:<br />
<Tag>Campaign</Tag><br />
<Tag>Parkour</Tag><br />
<br />
=== SupportedVersion ===<br />
<br />
Which update of the game this mod can be used in. Can be something like <code>b4</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.<br />
<br />
Example:<br />
<code><SupportedVersion>b4</SupportedVersion></code><br />
<br />
=== LevelHookFile ===<br />
<br />
Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.<br />
<br />
Example:<br />
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code><br />
<br />
=== MenuItem ===<br />
Adds a campaign button to the Play menu which runs a script. The script type is a [[Scriptable Menu]]. Read [[Custom Menu Bar Items|the tutorial]] for more information.<br />
<br />
Example:<br />
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code><br />
<br />
=== Campaign ===<br />
<br />
Describes a set of levels that belong together.<br />
<br />
Has a few attributes that describe the campaign:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the campaign, shown in the menu.<br />
|-<br />
! type<br />
| TODO: Write description<br />
TODO: What can this be set to? A limited set? Whatever you want?<br />
|-<br />
! is_linear<br />
| Sets if you need to finish the first level to unlock access to the second and so on.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the campaign in the play menu.<br />
|}<br />
<br />
Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.<br />
<br />
Example:<br />
<Campaign title="My Campaign"<br />
type="general"<br />
is_linear="true"><br />
<Level title="Intro" <br />
thumbnail="Images/MyMod/intro_thumb.jpg"><br />
MyMod/intro.xml<br />
</Level><br />
<Level title="Big Challenge" <br />
thumbnail="Images/MyMod/challenge_thumb.jpg"><br />
MyMod/challenge.xml<br />
</Level><br />
<Level title="Ending" <br />
thumbnail="Images/MyMod/end_cutscene_thumb.jpg"><br />
MyMod/end_cutscene.xml<br />
</Level><br />
</Campaign><br />
<br />
=== Level ===<br />
<br />
Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.<br />
<br />
Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.<br />
<br />
Attributes:<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the level, shown in the menu.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the level in the play menu. This attribute is not required.<br />
|}<br />
<br />
Example:<br />
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code><br />
<br />
=== NeedsRestart ===<br />
<br />
This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.<br />
<br />
Can be <code>true</code> or <code>false</code>.<br />
<br />
TODO: For what types of mods is this useful?<br />
<br />
Example:<br />
<code><NeedsRestart>false</NeedsRestart></code><br />
<br />
=== ModDependency ===<br />
<br />
Here is a list of other mods that this mod depends on to work. Has two tags for each mod:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Tag !! Purpose<br />
|-<br />
! Id<br />
| The unique ID for the other mod.<br />
|-<br />
! Version<br />
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.<br />
|}<br />
<br />
Example:<br />
<ModDependency><br />
<Id>other-mod</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
<br />
=== OverloadFile ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><OverloadFile>TODO: Write example</OverloadFile></code><br />
<br />
=== Item ===<br />
<br />
Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.<br />
<br />
Has a few attributes for each entry:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! category<br />
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.<br />
|-<br />
! title<br />
| Name of the item to display in the list.<br />
|-<br />
! path<br />
| Path to the object file for this item.<br />
|-<br />
! thumbnail<br />
| Path to image to use as a preview image for this item.<br />
|}<br />
<br />
Example:<br />
<Item category="My Mod"<br />
title="My item"<br />
path="Data/Items/MyItem.xml"<br />
thumbnail="Data/UI/spawner/MyItem.png" /></div>Autioushttps://wiki.wolfire.com/index.php?title=Creating_a_new_Mod&diff=4687Creating a new Mod2017-08-14T11:38:47Z<p>Autious: /* MenuItem */</p>
<hr />
<div>== Folder structure ==<br />
<br />
Overgrowth has a powerful and simple to use mod system that allow modders to create mods by both "overshadowing" existing files, and creating new files.<br />
<br />
Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There each mod folder has a readable name.<br />
<br />
The folder for a mod contains at least a mod.xml file. But usually other data as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mods folder, resulting in the following structure<br />
<br />
Overgrowth/Data/Mods/<br />
└── my_mod/<br />
├── mod.xml<br />
└── Data/<br />
├── Scripts/<br />
├── Shaders/<br />
├── Models/<br />
├── Textures/<br />
└── Levels/<br />
<br />
The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].<br />
<br />
== The mod.xml file ==<br />
<br />
The mod.xml file contains the mods meta data. The game uses this file to understand how to use the mod with the game. Here is a complete example:<br />
<br />
<? xml version="1.0" ?><br />
<Mod><br />
<!-- The ID is necessary and should never change between versions of the same mod --><br />
<Id>unique-name</Id> <br />
<!-- The human readable name is presented in UI's --><br />
<Name>Human Readable Name</Name> <br />
<!-- Version number, can have any formatting you wish. --><br />
<Version>1.2.5</Version><br />
<SupportedVersion>b4</SupportedVersion><br />
<ModDependency><br />
<Id>other-mod2</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
</Mod><br />
<br />
You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.<br />
<br />
== Advanced mod menu ==<br />
<br />
[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]<br />
<br />
To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.<br />
<br />
This shows all the available information for the selected mod.<br />
<br />
== Steam Workshop ==<br />
<br />
[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]<br />
<br />
To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.<br />
<br />
If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.<br />
<br />
Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.<br />
<br />
If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".<br />
<br />
=== Updating a Mod on Steam Workshop ===<br />
<br />
TODO: What is the process for updating an already uploaded mod on Steam Workshop?<br />
<br />
== mod.xml tags ==<br />
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.<br />
<br />
=== Id ===<br />
<br />
The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency.<br />
<br />
Example:<br />
<code><Id>my-mod</Id></code><br />
<br />
=== Name ===<br />
<br />
The name of the mod, shown in the mod menu.<br />
<br />
Example:<br />
<code><Name>My Mod</Name></code><br />
<br />
=== Category ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><Category>Campaign</Category></code><br />
<br />
=== Author ===<br />
<br />
Is shown in the user interface to tell the user who made the mod.<br />
<br />
Example:<br />
<code><Author>John Doe</Author></code><br />
<br />
=== Description ===<br />
<br />
Is shown in the user interface to tell the user what this mod does.<br />
<br />
Example:<br />
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code><br />
<br />
=== Version ===<br />
<br />
The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.<br />
<br />
Example:<br />
<code><Version>1.0.0</Version></code><br />
<br />
=== Thumbnail ===<br />
<br />
The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.<br />
<br />
Example:<br />
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code><br />
<br />
=== PreviewImage ===<br />
<br />
This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.<br />
<br />
Example:<br />
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code><br />
<br />
=== Tag ===<br />
<br />
Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.<br />
<br />
Example:<br />
<Tag>Campaign</Tag><br />
<Tag>Parkour</Tag><br />
<br />
=== SupportedVersion ===<br />
<br />
Which update of the game this mod can be used in. Can be something like <code>b4</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.<br />
<br />
Example:<br />
<code><SupportedVersion>b4</SupportedVersion></code><br />
<br />
=== LevelHookFile ===<br />
<br />
Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.<br />
<br />
Example:<br />
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code><br />
<br />
=== MenuItem ===<br />
Adds a campaign button to the Play menu running a script. The script type is a [[Scriptable Menu]]. Read [[Custom Menu Bar Items|the tutorial]] for more information.<br />
<br />
Example:<br />
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code><br />
<br />
=== Campaign ===<br />
<br />
Describes a set of levels that belong together.<br />
<br />
Has a few attributes that describe the campaign:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the campaign, shown in the menu.<br />
|-<br />
! type<br />
| TODO: Write description<br />
TODO: What can this be set to? A limited set? Whatever you want?<br />
|-<br />
! is_linear<br />
| Sets if you need to finish the first level to unlock access to the second and so on.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the campaign in the play menu.<br />
|}<br />
<br />
Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.<br />
<br />
Example:<br />
<Campaign title="My Campaign"<br />
type="general"<br />
is_linear="true"><br />
<Level title="Intro" <br />
thumbnail="Images/MyMod/intro_thumb.jpg"><br />
MyMod/intro.xml<br />
</Level><br />
<Level title="Big Challenge" <br />
thumbnail="Images/MyMod/challenge_thumb.jpg"><br />
MyMod/challenge.xml<br />
</Level><br />
<Level title="Ending" <br />
thumbnail="Images/MyMod/end_cutscene_thumb.jpg"><br />
MyMod/end_cutscene.xml<br />
</Level><br />
</Campaign><br />
<br />
=== Level ===<br />
<br />
Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.<br />
<br />
Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.<br />
<br />
Attributes:<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the level, shown in the menu.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the level in the play menu. This attribute is not required.<br />
|}<br />
<br />
Example:<br />
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code><br />
<br />
=== NeedsRestart ===<br />
<br />
This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.<br />
<br />
Can be <code>true</code> or <code>false</code>.<br />
<br />
TODO: For what types of mods is this useful?<br />
<br />
Example:<br />
<code><NeedsRestart>false</NeedsRestart></code><br />
<br />
=== ModDependency ===<br />
<br />
Here is a list of other mods that this mod depends on to work. Has two tags for each mod:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Tag !! Purpose<br />
|-<br />
! Id<br />
| The unique ID for the other mod.<br />
|-<br />
! Version<br />
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.<br />
|}<br />
<br />
Example:<br />
<ModDependency><br />
<Id>other-mod</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
<br />
=== OverloadFile ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><OverloadFile>TODO: Write example</OverloadFile></code><br />
<br />
=== Item ===<br />
<br />
Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.<br />
<br />
Has a few attributes for each entry:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! category<br />
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.<br />
|-<br />
! title<br />
| Name of the item to display in the list.<br />
|-<br />
! path<br />
| Path to the object file for this item.<br />
|-<br />
! thumbnail<br />
| Path to image to use as a preview image for this item.<br />
|}<br />
<br />
Example:<br />
<Item category="My Mod"<br />
title="My item"<br />
path="Data/Items/MyItem.xml"<br />
thumbnail="Data/UI/spawner/MyItem.png" /></div>Autioushttps://wiki.wolfire.com/index.php?title=Creating_a_new_Mod&diff=4686Creating a new Mod2017-08-14T11:38:26Z<p>Autious: /* MenuItem */</p>
<hr />
<div>== Folder structure ==<br />
<br />
Overgrowth has a powerful and simple to use mod system that allow modders to create mods by both "overshadowing" existing files, and creating new files.<br />
<br />
Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There each mod folder has a readable name.<br />
<br />
The folder for a mod contains at least a mod.xml file. But usually other data as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mods folder, resulting in the following structure<br />
<br />
Overgrowth/Data/Mods/<br />
└── my_mod/<br />
├── mod.xml<br />
└── Data/<br />
├── Scripts/<br />
├── Shaders/<br />
├── Models/<br />
├── Textures/<br />
└── Levels/<br />
<br />
The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].<br />
<br />
== The mod.xml file ==<br />
<br />
The mod.xml file contains the mods meta data. The game uses this file to understand how to use the mod with the game. Here is a complete example:<br />
<br />
<? xml version="1.0" ?><br />
<Mod><br />
<!-- The ID is necessary and should never change between versions of the same mod --><br />
<Id>unique-name</Id> <br />
<!-- The human readable name is presented in UI's --><br />
<Name>Human Readable Name</Name> <br />
<!-- Version number, can have any formatting you wish. --><br />
<Version>1.2.5</Version><br />
<SupportedVersion>b4</SupportedVersion><br />
<ModDependency><br />
<Id>other-mod2</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
</Mod><br />
<br />
You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.<br />
<br />
== Advanced mod menu ==<br />
<br />
[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]<br />
<br />
To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.<br />
<br />
This shows all the available information for the selected mod.<br />
<br />
== Steam Workshop ==<br />
<br />
[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]<br />
<br />
To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.<br />
<br />
If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.<br />
<br />
Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.<br />
<br />
If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".<br />
<br />
=== Updating a Mod on Steam Workshop ===<br />
<br />
TODO: What is the process for updating an already uploaded mod on Steam Workshop?<br />
<br />
== mod.xml tags ==<br />
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.<br />
<br />
=== Id ===<br />
<br />
The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency.<br />
<br />
Example:<br />
<code><Id>my-mod</Id></code><br />
<br />
=== Name ===<br />
<br />
The name of the mod, shown in the mod menu.<br />
<br />
Example:<br />
<code><Name>My Mod</Name></code><br />
<br />
=== Category ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><Category>Campaign</Category></code><br />
<br />
=== Author ===<br />
<br />
Is shown in the user interface to tell the user who made the mod.<br />
<br />
Example:<br />
<code><Author>John Doe</Author></code><br />
<br />
=== Description ===<br />
<br />
Is shown in the user interface to tell the user what this mod does.<br />
<br />
Example:<br />
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code><br />
<br />
=== Version ===<br />
<br />
The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.<br />
<br />
Example:<br />
<code><Version>1.0.0</Version></code><br />
<br />
=== Thumbnail ===<br />
<br />
The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.<br />
<br />
Example:<br />
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code><br />
<br />
=== PreviewImage ===<br />
<br />
This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.<br />
<br />
Example:<br />
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code><br />
<br />
=== Tag ===<br />
<br />
Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.<br />
<br />
Example:<br />
<Tag>Campaign</Tag><br />
<Tag>Parkour</Tag><br />
<br />
=== SupportedVersion ===<br />
<br />
Which update of the game this mod can be used in. Can be something like <code>b4</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.<br />
<br />
Example:<br />
<code><SupportedVersion>b4</SupportedVersion></code><br />
<br />
=== LevelHookFile ===<br />
<br />
Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.<br />
<br />
Example:<br />
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code><br />
<br />
=== MenuItem ===<br />
Adds a campaign button to the Play menu running the script from the path attribute. The script type is a [[Scriptable Menu]]. Read [[Custom Menu Bar Items|the tutorial]] for more information.<br />
<br />
Example:<br />
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code><br />
<br />
=== Campaign ===<br />
<br />
Describes a set of levels that belong together.<br />
<br />
Has a few attributes that describe the campaign:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the campaign, shown in the menu.<br />
|-<br />
! type<br />
| TODO: Write description<br />
TODO: What can this be set to? A limited set? Whatever you want?<br />
|-<br />
! is_linear<br />
| Sets if you need to finish the first level to unlock access to the second and so on.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the campaign in the play menu.<br />
|}<br />
<br />
Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.<br />
<br />
Example:<br />
<Campaign title="My Campaign"<br />
type="general"<br />
is_linear="true"><br />
<Level title="Intro" <br />
thumbnail="Images/MyMod/intro_thumb.jpg"><br />
MyMod/intro.xml<br />
</Level><br />
<Level title="Big Challenge" <br />
thumbnail="Images/MyMod/challenge_thumb.jpg"><br />
MyMod/challenge.xml<br />
</Level><br />
<Level title="Ending" <br />
thumbnail="Images/MyMod/end_cutscene_thumb.jpg"><br />
MyMod/end_cutscene.xml<br />
</Level><br />
</Campaign><br />
<br />
=== Level ===<br />
<br />
Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.<br />
<br />
Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.<br />
<br />
Attributes:<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the level, shown in the menu.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the level in the play menu. This attribute is not required.<br />
|}<br />
<br />
Example:<br />
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code><br />
<br />
=== NeedsRestart ===<br />
<br />
This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.<br />
<br />
Can be <code>true</code> or <code>false</code>.<br />
<br />
TODO: For what types of mods is this useful?<br />
<br />
Example:<br />
<code><NeedsRestart>false</NeedsRestart></code><br />
<br />
=== ModDependency ===<br />
<br />
Here is a list of other mods that this mod depends on to work. Has two tags for each mod:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Tag !! Purpose<br />
|-<br />
! Id<br />
| The unique ID for the other mod.<br />
|-<br />
! Version<br />
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.<br />
|}<br />
<br />
Example:<br />
<ModDependency><br />
<Id>other-mod</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
<br />
=== OverloadFile ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><OverloadFile>TODO: Write example</OverloadFile></code><br />
<br />
=== Item ===<br />
<br />
Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.<br />
<br />
Has a few attributes for each entry:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! category<br />
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.<br />
|-<br />
! title<br />
| Name of the item to display in the list.<br />
|-<br />
! path<br />
| Path to the object file for this item.<br />
|-<br />
! thumbnail<br />
| Path to image to use as a preview image for this item.<br />
|}<br />
<br />
Example:<br />
<Item category="My Mod"<br />
title="My item"<br />
path="Data/Items/MyItem.xml"<br />
thumbnail="Data/UI/spawner/MyItem.png" /></div>Autioushttps://wiki.wolfire.com/index.php?title=Creating_a_new_Mod&diff=4685Creating a new Mod2017-08-14T11:38:08Z<p>Autious: /* MenuItem */</p>
<hr />
<div>== Folder structure ==<br />
<br />
Overgrowth has a powerful and simple to use mod system that allow modders to create mods by both "overshadowing" existing files, and creating new files.<br />
<br />
Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There each mod folder has a readable name.<br />
<br />
The folder for a mod contains at least a mod.xml file. But usually other data as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mods folder, resulting in the following structure<br />
<br />
Overgrowth/Data/Mods/<br />
└── my_mod/<br />
├── mod.xml<br />
└── Data/<br />
├── Scripts/<br />
├── Shaders/<br />
├── Models/<br />
├── Textures/<br />
└── Levels/<br />
<br />
The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].<br />
<br />
== The mod.xml file ==<br />
<br />
The mod.xml file contains the mods meta data. The game uses this file to understand how to use the mod with the game. Here is a complete example:<br />
<br />
<? xml version="1.0" ?><br />
<Mod><br />
<!-- The ID is necessary and should never change between versions of the same mod --><br />
<Id>unique-name</Id> <br />
<!-- The human readable name is presented in UI's --><br />
<Name>Human Readable Name</Name> <br />
<!-- Version number, can have any formatting you wish. --><br />
<Version>1.2.5</Version><br />
<SupportedVersion>b4</SupportedVersion><br />
<ModDependency><br />
<Id>other-mod2</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
</Mod><br />
<br />
You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.<br />
<br />
== Advanced mod menu ==<br />
<br />
[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]<br />
<br />
To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.<br />
<br />
This shows all the available information for the selected mod.<br />
<br />
== Steam Workshop ==<br />
<br />
[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]<br />
<br />
To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.<br />
<br />
If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.<br />
<br />
Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.<br />
<br />
If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".<br />
<br />
=== Updating a Mod on Steam Workshop ===<br />
<br />
TODO: What is the process for updating an already uploaded mod on Steam Workshop?<br />
<br />
== mod.xml tags ==<br />
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.<br />
<br />
=== Id ===<br />
<br />
The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency.<br />
<br />
Example:<br />
<code><Id>my-mod</Id></code><br />
<br />
=== Name ===<br />
<br />
The name of the mod, shown in the mod menu.<br />
<br />
Example:<br />
<code><Name>My Mod</Name></code><br />
<br />
=== Category ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><Category>Campaign</Category></code><br />
<br />
=== Author ===<br />
<br />
Is shown in the user interface to tell the user who made the mod.<br />
<br />
Example:<br />
<code><Author>John Doe</Author></code><br />
<br />
=== Description ===<br />
<br />
Is shown in the user interface to tell the user what this mod does.<br />
<br />
Example:<br />
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code><br />
<br />
=== Version ===<br />
<br />
The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.<br />
<br />
Example:<br />
<code><Version>1.0.0</Version></code><br />
<br />
=== Thumbnail ===<br />
<br />
The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.<br />
<br />
Example:<br />
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code><br />
<br />
=== PreviewImage ===<br />
<br />
This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.<br />
<br />
Example:<br />
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code><br />
<br />
=== Tag ===<br />
<br />
Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.<br />
<br />
Example:<br />
<Tag>Campaign</Tag><br />
<Tag>Parkour</Tag><br />
<br />
=== SupportedVersion ===<br />
<br />
Which update of the game this mod can be used in. Can be something like <code>b4</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.<br />
<br />
Example:<br />
<code><SupportedVersion>b4</SupportedVersion></code><br />
<br />
=== LevelHookFile ===<br />
<br />
Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.<br />
<br />
Example:<br />
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code><br />
<br />
=== MenuItem ===<br />
Adds a campaign button to the Play menu running the script menu in the path attribute. The script type is a [[Scriptable Menu]]. Read [[Custom Menu Bar Items|the tutorial]] for more information.<br />
<br />
Example:<br />
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code><br />
<br />
=== Campaign ===<br />
<br />
Describes a set of levels that belong together.<br />
<br />
Has a few attributes that describe the campaign:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the campaign, shown in the menu.<br />
|-<br />
! type<br />
| TODO: Write description<br />
TODO: What can this be set to? A limited set? Whatever you want?<br />
|-<br />
! is_linear<br />
| Sets if you need to finish the first level to unlock access to the second and so on.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the campaign in the play menu.<br />
|}<br />
<br />
Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.<br />
<br />
Example:<br />
<Campaign title="My Campaign"<br />
type="general"<br />
is_linear="true"><br />
<Level title="Intro" <br />
thumbnail="Images/MyMod/intro_thumb.jpg"><br />
MyMod/intro.xml<br />
</Level><br />
<Level title="Big Challenge" <br />
thumbnail="Images/MyMod/challenge_thumb.jpg"><br />
MyMod/challenge.xml<br />
</Level><br />
<Level title="Ending" <br />
thumbnail="Images/MyMod/end_cutscene_thumb.jpg"><br />
MyMod/end_cutscene.xml<br />
</Level><br />
</Campaign><br />
<br />
=== Level ===<br />
<br />
Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.<br />
<br />
Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.<br />
<br />
Attributes:<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the level, shown in the menu.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the level in the play menu. This attribute is not required.<br />
|}<br />
<br />
Example:<br />
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code><br />
<br />
=== NeedsRestart ===<br />
<br />
This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.<br />
<br />
Can be <code>true</code> or <code>false</code>.<br />
<br />
TODO: For what types of mods is this useful?<br />
<br />
Example:<br />
<code><NeedsRestart>false</NeedsRestart></code><br />
<br />
=== ModDependency ===<br />
<br />
Here is a list of other mods that this mod depends on to work. Has two tags for each mod:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Tag !! Purpose<br />
|-<br />
! Id<br />
| The unique ID for the other mod.<br />
|-<br />
! Version<br />
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.<br />
|}<br />
<br />
Example:<br />
<ModDependency><br />
<Id>other-mod</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
<br />
=== OverloadFile ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><OverloadFile>TODO: Write example</OverloadFile></code><br />
<br />
=== Item ===<br />
<br />
Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.<br />
<br />
Has a few attributes for each entry:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! category<br />
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.<br />
|-<br />
! title<br />
| Name of the item to display in the list.<br />
|-<br />
! path<br />
| Path to the object file for this item.<br />
|-<br />
! thumbnail<br />
| Path to image to use as a preview image for this item.<br />
|}<br />
<br />
Example:<br />
<Item category="My Mod"<br />
title="My item"<br />
path="Data/Items/MyItem.xml"<br />
thumbnail="Data/UI/spawner/MyItem.png" /></div>Autioushttps://wiki.wolfire.com/index.php?title=Creating_a_new_Mod&diff=4684Creating a new Mod2017-08-14T11:37:31Z<p>Autious: /* MenuItem */</p>
<hr />
<div>== Folder structure ==<br />
<br />
Overgrowth has a powerful and simple to use mod system that allow modders to create mods by both "overshadowing" existing files, and creating new files.<br />
<br />
Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There each mod folder has a readable name.<br />
<br />
The folder for a mod contains at least a mod.xml file. But usually other data as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mods folder, resulting in the following structure<br />
<br />
Overgrowth/Data/Mods/<br />
└── my_mod/<br />
├── mod.xml<br />
└── Data/<br />
├── Scripts/<br />
├── Shaders/<br />
├── Models/<br />
├── Textures/<br />
└── Levels/<br />
<br />
The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].<br />
<br />
== The mod.xml file ==<br />
<br />
The mod.xml file contains the mods meta data. The game uses this file to understand how to use the mod with the game. Here is a complete example:<br />
<br />
<? xml version="1.0" ?><br />
<Mod><br />
<!-- The ID is necessary and should never change between versions of the same mod --><br />
<Id>unique-name</Id> <br />
<!-- The human readable name is presented in UI's --><br />
<Name>Human Readable Name</Name> <br />
<!-- Version number, can have any formatting you wish. --><br />
<Version>1.2.5</Version><br />
<SupportedVersion>b4</SupportedVersion><br />
<ModDependency><br />
<Id>other-mod2</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
</Mod><br />
<br />
You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.<br />
<br />
== Advanced mod menu ==<br />
<br />
[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]<br />
<br />
To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.<br />
<br />
This shows all the available information for the selected mod.<br />
<br />
== Steam Workshop ==<br />
<br />
[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]<br />
<br />
To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.<br />
<br />
If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.<br />
<br />
Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.<br />
<br />
If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".<br />
<br />
=== Updating a Mod on Steam Workshop ===<br />
<br />
TODO: What is the process for updating an already uploaded mod on Steam Workshop?<br />
<br />
== mod.xml tags ==<br />
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.<br />
<br />
=== Id ===<br />
<br />
The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency.<br />
<br />
Example:<br />
<code><Id>my-mod</Id></code><br />
<br />
=== Name ===<br />
<br />
The name of the mod, shown in the mod menu.<br />
<br />
Example:<br />
<code><Name>My Mod</Name></code><br />
<br />
=== Category ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><Category>Campaign</Category></code><br />
<br />
=== Author ===<br />
<br />
Is shown in the user interface to tell the user who made the mod.<br />
<br />
Example:<br />
<code><Author>John Doe</Author></code><br />
<br />
=== Description ===<br />
<br />
Is shown in the user interface to tell the user what this mod does.<br />
<br />
Example:<br />
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code><br />
<br />
=== Version ===<br />
<br />
The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.<br />
<br />
Example:<br />
<code><Version>1.0.0</Version></code><br />
<br />
=== Thumbnail ===<br />
<br />
The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.<br />
<br />
Example:<br />
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code><br />
<br />
=== PreviewImage ===<br />
<br />
This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.<br />
<br />
Example:<br />
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code><br />
<br />
=== Tag ===<br />
<br />
Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.<br />
<br />
Example:<br />
<Tag>Campaign</Tag><br />
<Tag>Parkour</Tag><br />
<br />
=== SupportedVersion ===<br />
<br />
Which update of the game this mod can be used in. Can be something like <code>b4</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.<br />
<br />
Example:<br />
<code><SupportedVersion>b4</SupportedVersion></code><br />
<br />
=== LevelHookFile ===<br />
<br />
Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.<br />
<br />
Example:<br />
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code><br />
<br />
=== MenuItem ===<br />
<br />
TODO: Verify that this is correct<br />
<br />
Adds a campaign button to the Play menu running the scriptable menu in the path attribute. Read [[Custom Menu Bar Items|the tutorial]] for more information.<br />
<br />
Example:<br />
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code><br />
<br />
=== Campaign ===<br />
<br />
Describes a set of levels that belong together.<br />
<br />
Has a few attributes that describe the campaign:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the campaign, shown in the menu.<br />
|-<br />
! type<br />
| TODO: Write description<br />
TODO: What can this be set to? A limited set? Whatever you want?<br />
|-<br />
! is_linear<br />
| Sets if you need to finish the first level to unlock access to the second and so on.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the campaign in the play menu.<br />
|}<br />
<br />
Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.<br />
<br />
Example:<br />
<Campaign title="My Campaign"<br />
type="general"<br />
is_linear="true"><br />
<Level title="Intro" <br />
thumbnail="Images/MyMod/intro_thumb.jpg"><br />
MyMod/intro.xml<br />
</Level><br />
<Level title="Big Challenge" <br />
thumbnail="Images/MyMod/challenge_thumb.jpg"><br />
MyMod/challenge.xml<br />
</Level><br />
<Level title="Ending" <br />
thumbnail="Images/MyMod/end_cutscene_thumb.jpg"><br />
MyMod/end_cutscene.xml<br />
</Level><br />
</Campaign><br />
<br />
=== Level ===<br />
<br />
Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.<br />
<br />
Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.<br />
<br />
Attributes:<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the level, shown in the menu.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the level in the play menu. This attribute is not required.<br />
|}<br />
<br />
Example:<br />
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code><br />
<br />
=== NeedsRestart ===<br />
<br />
This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.<br />
<br />
Can be <code>true</code> or <code>false</code>.<br />
<br />
TODO: For what types of mods is this useful?<br />
<br />
Example:<br />
<code><NeedsRestart>false</NeedsRestart></code><br />
<br />
=== ModDependency ===<br />
<br />
Here is a list of other mods that this mod depends on to work. Has two tags for each mod:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Tag !! Purpose<br />
|-<br />
! Id<br />
| The unique ID for the other mod.<br />
|-<br />
! Version<br />
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.<br />
|}<br />
<br />
Example:<br />
<ModDependency><br />
<Id>other-mod</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
<br />
=== OverloadFile ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><OverloadFile>TODO: Write example</OverloadFile></code><br />
<br />
=== Item ===<br />
<br />
Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.<br />
<br />
Has a few attributes for each entry:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! category<br />
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.<br />
|-<br />
! title<br />
| Name of the item to display in the list.<br />
|-<br />
! path<br />
| Path to the object file for this item.<br />
|-<br />
! thumbnail<br />
| Path to image to use as a preview image for this item.<br />
|}<br />
<br />
Example:<br />
<Item category="My Mod"<br />
title="My item"<br />
path="Data/Items/MyItem.xml"<br />
thumbnail="Data/UI/spawner/MyItem.png" /></div>Autioushttps://wiki.wolfire.com/index.php?title=Creating_a_new_Mod&diff=4683Creating a new Mod2017-08-14T11:36:42Z<p>Autious: /* MenuItem */</p>
<hr />
<div>== Folder structure ==<br />
<br />
Overgrowth has a powerful and simple to use mod system that allow modders to create mods by both "overshadowing" existing files, and creating new files.<br />
<br />
Mods that are installed via the Steam workshop end up in <code>../Steam/steamapps/workshop/content/25000/</code>. Each folder in there has a number assigned to it, so it can be hard to see which folder belongs to which mod. All other mods, such as manually installed ones, those from SUM Launcher and those you make yourself live in the <code>../Overgrowth/Data/Mods/</code> folder. There each mod folder has a readable name.<br />
<br />
The folder for a mod contains at least a mod.xml file. But usually other data as well, such as scripts, shaders, models, textures or levels. All these folders are contained in a Data folder inside the mods folder, resulting in the following structure<br />
<br />
Overgrowth/Data/Mods/<br />
└── my_mod/<br />
├── mod.xml<br />
└── Data/<br />
├── Scripts/<br />
├── Shaders/<br />
├── Models/<br />
├── Textures/<br />
└── Levels/<br />
<br />
The folder called my_mod in the tree structure above is what is compressed into a zip file and distributed when a mod is released. You can also release the mod on Steam Workshop, which is a different process that you can read about [[#Steam_Workshop|a bit further down]].<br />
<br />
== The mod.xml file ==<br />
<br />
The mod.xml file contains the mods meta data. The game uses this file to understand how to use the mod with the game. Here is a complete example:<br />
<br />
<? xml version="1.0" ?><br />
<Mod><br />
<!-- The ID is necessary and should never change between versions of the same mod --><br />
<Id>unique-name</Id> <br />
<!-- The human readable name is presented in UI's --><br />
<Name>Human Readable Name</Name> <br />
<!-- Version number, can have any formatting you wish. --><br />
<Version>1.2.5</Version><br />
<SupportedVersion>b4</SupportedVersion><br />
<ModDependency><br />
<Id>other-mod2</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
</Mod><br />
<br />
You can find all available tags and their uses under the [[#mod.xml_tags|mod.xml_tags]] heading below.<br />
<br />
== Advanced mod menu ==<br />
<br />
[[File:Advanced_mod_menu.jpg|200px|thumb|right|The advanced mod menu]]<br />
<br />
To help modders validate their mods and upload them to the Steam Workshop there is a tool called the "Advanced mod menu". Access it by going to the main menu, then in the top menu bar, click <code>Windows -> Mods</code>. This brings up a simpler version of the mod menu. To activate the advanced mod menu, click <code>Menu -> Advanced</code>. Make sure to increase the size of the window to see all the new information in the window.<br />
<br />
This shows all the available information for the selected mod.<br />
<br />
== Steam Workshop ==<br />
<br />
[[File:Steamworks_upload.jpg|200px|thumb|right|The Steamworks New Upload menu]]<br />
<br />
To release a mod on Steam Workshop, first create your mod and make sure it works as intended. Then open up the [[#Advanced_mod_menu|advanced mod menu]], make sure the "Valid" item says "Yes", press "Upload To Steamworks..." and follow the instructions at the bottom.<br />
<br />
If it says something about needing to accept an agreement when you've uploaded a mod, go to http://steamcommunity.com/sharedfiles/workshoplegalagreement, log in, read through and accept the agreement if you do.<br />
<br />
Any mod that has just been uploaded will be private. And before you make it public you should brush up the mod's page a bit. It's a good idea to add a video, some screenshots, a description that tells the user what makes the mod interesting, how to use it and so on.<br />
<br />
If the mod requires some other mod to work, make sure to specify that using the "Add/Remove Required Items" in the "Owner Controls".<br />
<br />
=== Updating a Mod on Steam Workshop ===<br />
<br />
TODO: What is the process for updating an already uploaded mod on Steam Workshop?<br />
<br />
== mod.xml tags ==<br />
There are quite a few tags that can be used in the mod.xml file to set up your mod. Here we go through all of those tags.<br />
<br />
=== Id ===<br />
<br />
The unique ID for this mod that is not allowed to conflict with any other existing mod. One suggestion is to keep it the same as the folder name for the mod. The ID is not shown to the user, but it is used for instance when another mod wants to use this mod as a dependency.<br />
<br />
Example:<br />
<code><Id>my-mod</Id></code><br />
<br />
=== Name ===<br />
<br />
The name of the mod, shown in the mod menu.<br />
<br />
Example:<br />
<code><Name>My Mod</Name></code><br />
<br />
=== Category ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><Category>Campaign</Category></code><br />
<br />
=== Author ===<br />
<br />
Is shown in the user interface to tell the user who made the mod.<br />
<br />
Example:<br />
<code><Author>John Doe</Author></code><br />
<br />
=== Description ===<br />
<br />
Is shown in the user interface to tell the user what this mod does.<br />
<br />
Example:<br />
<code><Description>This is my really cool mod that adds some excellent functionality</Description></code><br />
<br />
=== Version ===<br />
<br />
The version of the mod. It is both shown in the user interface, and is used by other mods that depend on this mod to make sure that the user has the right version of your mod installed. Does not need to follow any specific pattern.<br />
<br />
Example:<br />
<code><Version>1.0.0</Version></code><br />
<br />
=== Thumbnail ===<br />
<br />
The path to an image to show in the user interface for your mod when the user is browsing their installed mods. Make sure you include the supplied image in the mod folder.<br />
<br />
Example:<br />
<code><Thumbnail>Data/Images/my-mod/thumb.jpg</Thumbnail></code><br />
<br />
=== PreviewImage ===<br />
<br />
This image is used in Steam Workshop to represent the mod in search results, when browsing mods and on the mod's page.<br />
<br />
Example:<br />
<code><PreviewImage>Data/Images/my-mod/preview-image.jpg</PreviewImage></code><br />
<br />
=== Tag ===<br />
<br />
Once the mod is uploaded to Steam Workshop, you can search for the tags to find the mod. You can have as many tags as you want.<br />
<br />
Example:<br />
<Tag>Campaign</Tag><br />
<Tag>Parkour</Tag><br />
<br />
=== SupportedVersion ===<br />
<br />
Which update of the game this mod can be used in. Can be something like <code>b4</code>, or <code>*</code> to indicate that it can be used with any version. Using <code>*</code> is useful for mods that don't rely on the game code as much, such as assets, levels and so on.<br />
<br />
Example:<br />
<code><SupportedVersion>b4</SupportedVersion></code><br />
<br />
=== LevelHookFile ===<br />
<br />
Specifies a path to a script file. Functions in this script are run for every level in the game when the mod is active. Every mod can add their own level hook script. [[LevelScripts#Per-mod_Level_Script|Read this]] for more information.<br />
<br />
Example:<br />
<code><LevelHookFile>Scripts/my_mod/level_script.as</LevelHookFile></code><br />
<br />
=== MenuItem ===<br />
<br />
TODO: Verify that this is correct<br />
<br />
Adds a campaign menu item to the Play menu. Clicking the menu item will open a new scriptable menu from the script given in the path attribute. Read [[Custom Menu Bar Items|the tutorial]] for more information.<br />
<br />
Example:<br />
<code><MenuItem title="My Menu" category="My Category" thumbnail="Data/Images/my_mod/my_item.png" path="Data/Scripts/my_menu_script.as"/></code><br />
<br />
=== Campaign ===<br />
<br />
Describes a set of levels that belong together.<br />
<br />
Has a few attributes that describe the campaign:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the campaign, shown in the menu.<br />
|-<br />
! type<br />
| TODO: Write description<br />
TODO: What can this be set to? A limited set? Whatever you want?<br />
|-<br />
! is_linear<br />
| Sets if you need to finish the first level to unlock access to the second and so on.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the campaign in the play menu.<br />
|}<br />
<br />
Inside the campaign tag there are two or more "Level" tags in the desired order that make up the campaign. For more information about what is included in the "Level" tag, see the "Level" heading just below.<br />
<br />
Example:<br />
<Campaign title="My Campaign"<br />
type="general"<br />
is_linear="true"><br />
<Level title="Intro" <br />
thumbnail="Images/MyMod/intro_thumb.jpg"><br />
MyMod/intro.xml<br />
</Level><br />
<Level title="Big Challenge" <br />
thumbnail="Images/MyMod/challenge_thumb.jpg"><br />
MyMod/challenge.xml<br />
</Level><br />
<Level title="Ending" <br />
thumbnail="Images/MyMod/end_cutscene_thumb.jpg"><br />
MyMod/end_cutscene.xml<br />
</Level><br />
</Campaign><br />
<br />
=== Level ===<br />
<br />
Can be placed in the root "Mod" tag to make the specified levels show up under the play menu in the game. You can also place them in a "Campaign" tag to put them into a campaign, for more information on that, see the "Campaign" tag above.<br />
<br />
Each level has two attributes, and between the start and end tags you write the path to the level. The root for the path is in the /Data/Levels/ folder, so leave everything up to the Levels folder out of the path, and make sure the level is stored inside the <code>../Overgrowth/Data/Mods/my_mod/Data/Levels/</code> folder.<br />
<br />
Attributes:<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! title<br />
| The name of the level, shown in the menu.<br />
|-<br />
! thumbnail<br />
| The path to the image to use for the level in the play menu. This attribute is not required.<br />
|}<br />
<br />
Example:<br />
<code><Level title="My Level" thumbnail="Images/MyMod/my_level_thumb.jpg">MyMod/my_level.xml</Level></code><br />
<br />
=== NeedsRestart ===<br />
<br />
This tag is used to determine if the game should let the user know that they need to restart the game in order for the mod to function properly.<br />
<br />
Can be <code>true</code> or <code>false</code>.<br />
<br />
TODO: For what types of mods is this useful?<br />
<br />
Example:<br />
<code><NeedsRestart>false</NeedsRestart></code><br />
<br />
=== ModDependency ===<br />
<br />
Here is a list of other mods that this mod depends on to work. Has two tags for each mod:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Tag !! Purpose<br />
|-<br />
! Id<br />
| The unique ID for the other mod.<br />
|-<br />
! Version<br />
| The version of the other mod that this mod requires. Set to <code>*</code> to accept any version of the other mod.<br />
|}<br />
<br />
Example:<br />
<ModDependency><br />
<Id>other-mod</Id><br />
<Version>1.0.0</Version> <br />
</ModDependency><br />
<br />
=== OverloadFile ===<br />
<br />
TODO: Write description<br />
<br />
Example:<br />
<code><OverloadFile>TODO: Write example</OverloadFile></code><br />
<br />
=== Item ===<br />
<br />
Allows you to add entries to the "Load Item" list in the editor. This is useful if the mod adds weapons, characters, static objects, decals and similar things.<br />
<br />
Has a few attributes for each entry:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Attribute !! Purpose<br />
|-<br />
! category<br />
| Name of the sub-menu to add the item to. If the sub-menu does not exist it will automatically be created.<br />
|-<br />
! title<br />
| Name of the item to display in the list.<br />
|-<br />
! path<br />
| Path to the object file for this item.<br />
|-<br />
! thumbnail<br />
| Path to image to use as a preview image for this item.<br />
|}<br />
<br />
Example:<br />
<Item category="My Mod"<br />
title="My item"<br />
path="Data/Items/MyItem.xml"<br />
thumbnail="Data/UI/spawner/MyItem.png" /></div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Alpha_FAQ&diff=4598Overgrowth Alpha FAQ2017-04-18T08:39:46Z<p>Autious: </p>
<hr />
<div>This is the Overgrowth Alpha FAQ.<br />
<br />
* This FAQ is intended for useful tips for new users as well as answer common bug-related questions.<br />
* If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
<br />
Please feel free to contribute to this FAQ, and the wiki as a whole!<br />
<br />
== I just pre-ordered the game, what's next?==<br />
<br />
By pre-ordering Overgrowth, you can do two things:<br />
<br />
* Access the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forums] (referred to as SPF)<br />
* Check out the latest alphas<br />
<br />
First of all, you need an account on the forum. If you don't have one already, [http://forums.wolfire.com/ucp.php?mode=register register there]. Then follow the link given in your pre-order email, and type your nickname to get access to the SPF.<br />
<br />
In the SPF, you'll find a sticky named "Unofficial alpha XX, weekly build". You can check that post out to get the link to download the latest Overgrowth alpha.<br />
<br />
The SPF is also a place where all the preorderers discuss about the alpha, speculate about Overgrowth and ask questions to the Wolfire team. Participate and join us in the discussions!<br />
<br />
== What is an alpha exactly, and what can I do with it?==<br />
<br />
The Overgrowth alphas are very early stage "leaks" of the development progress. You are free to play around with them, but they should be not be held to the standards of a completed game.<br />
<br />
== How do I create content for Overgrowth?==<br />
<br />
Overgrowth Alphas come with a level-editor. For more info about modding, check out the rest of this wiki, and go to the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum]. For installing community-created content, you can check out [http://blog.wolfire.com/2013/04/Introducing-SUMLauncher-3 SUMLauncher].<br />
<br />
==What do I do if I encounter a Bug?==<br />
If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
Please follow the instructions [[How To Report a Bug in Overgrowth]], it increases the chances that we will be able to find and fix it.<br />
<br />
Your email should contain the following:<br />
* The Alpha Version in which the problem was encountered<br />
* Your system setup (Hardware, OS, etc.)<br />
* A Brief explanation of the problem<br />
* Actions performed, step by step, which led up to encountering the problem<br />
* Expected and Actual Results<br />
* Attachments (screenshots, crash reports, etc.)<br />
<br />
Refer to [http://university.utest.com/writing-quality-bug-reports-and-utest-etiquette/ this webpage] for tips on how to write a quality bug report.<br />
<br />
Here are additional steps you can take:<br />
* Check the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum] and look for posts that describe similar problems.<br />
* Ask on Wolfire's [http://www.wolfire.com/irc IRC channel]. Many users are long time Alpha testers and will be happy to help you.<br />
<br />
== What can I do if Overgrowth is running slow on my computer?==<br />
<br />
The Overgrowth alpha is currently set to use the maximum graphics settings, even if this is grossly inappropriate for your computer. There is not currently any UI available to change this, so you will need to edit the config.txt file. On Windows, this is located in %USERPROFILE%\Documents\Wolfire\Overgrowth\Data where %USERPROFILE% is often C:\Users\YOUR_USERNAME and YOUR_USERNAME is your Windows account name. On Mac, you will need to right click the Overgrowth application and choose show package contents. It is then located in the Data folder found in the Contents/Mac OS folder.<br />
<br />
Change the following values to these new ones:<br />
<br />
<pre>screenwidth: 800<br />
screenheight: 600<br />
multisample: 4<br />
anisotropy: 4<br />
texture_reduce: 1</pre><br />
<br />
If it's still running slow, try this:<br />
<br />
<pre>screenwidth: 640<br />
screenheight: 480<br />
multisample: 0<br />
anisotropy: 0<br />
texture_reduce: 2</pre><br />
<br />
==I can't access all of the GUI. The window crops important parts of the screen. What do I do?==<br />
This turned up, when the default resolution was lowered from 1024x768 to 800x600. You can resolve this issue by changing the settings, either to a higher resolution or to full screen mode. Changing display settings is done in the 'config.txt'-file. <br />
You can find it on computer with Windows system at:<br />
C:\Documents and Settings\Username\My Documents\Wolfire\Overgrowth\Data\config.txt<br />
or a computer with Mac system at:<br />
/Users/Username/Library/Application Support/Lugaru 2/Data/config.txt<br />
<br />
The first lines of the default config file should look like this:<br />
<pre><br />
screenwidth: 800<br />
screenheight: 600<br />
fullscreen: false<br />
</pre><br />
You can change the resolution by changing the values for screenwidth/screenheight and go to fullscreen mode by changing the 'false' to 'true'.<br />
<br />
== How do I load a model into the game? ==<br />
You need to make sure that you're not loading the model file, but the object file.<br />
* A Model file is a 3d mesh saved as a *.obj file. this file contains no textures or shader data and so cannot be loaded by itself.<br />
* An Object file is an XML that stores the filepaths for all the relevant data of an object, including the Model file as well as the textures and shader.<br />
For example if you are trying to load a file located in Data/Models/example.obj you should really be opening Data/Objects/example.xml<br />
<br />
== How do I load my custom level in the main menu?==<br />
# Make sure that you typed the name correctly, including the *.xml ending<br />
# Make sure that it exists in Data/Levels/<br />
<br />
* Recently (as at alpha 65) there have been some issues with loading custom maps from the main menu. to make sure this isn't the case:<br />
# Back up the map 'DesertFort_IGF.xml' (for example add "backup" to the name)<br />
# Rename your map as 'DesertFort_IGF.xml'<br />
# Attempt to load it by clicking the Desert map in the main menu.<br />
<br />
== How do i clear my game cache? ==<br />
<br />
http://wiki.wolfire.com/index.php/How_to_clear_the_game%27s_cache<br />
<br />
=Common Platform-Specific Problems=<br />
==Windows==<br />
=== I get the following error on startup on Windows ===<br />
<br />
<pre>The application has failed to start because its side-by-side configuration is incorrect. Please see the application event<br />
log or use the command-line sxstrace.exe tool for more detail.</pre><br />
<br />
Please install the Visual Studio 2005 C++ runtime. You can get it from this URL:<br />
http://www.microsoft.com/downloads/details.aspx?familyid=200b2fd9-ae1a-4a14-984d-389c36f85647&displaylang=en<br />
<br />
===Error: cannot create the C:\program files\Overgrowth\Data\config.txt file. ... ===<br />
This error applies to both Lugaru and Overgrowth.<br />
<br />
Symptom: When attempting to edit the config.txt file the following error message is displayed:<br />
cannot create the C:\program files\Overgrowth\Data\config.txt file. Make sure the path and file name are correct.<br />
<br />
Explanation: Windows Vista & 7 like to save the config file in a different location to the actual directory. As discussed in a thread on the forums[http://forums.wolfire.com/viewtopic.php?f=7&t=4890&p=78033#p78033], The file is actually stored in: C:\Users\USERNAME\Application Data\Local Virtual Store\Program Files/Overgrowth/config.txt<br />
<br />
==Mac==<br />
===Where is the Data folder?===<br />
With the Mac version of Overgrowth, the Data folder is located within the application package.<br />
You can access it by right clicking the "Overgrowth" application and choosing 'Show Contents", and then browsing to Contents/MacOS/Data<br />
*Note - For some users, "Show Package Contents" may not appear in the right-click menu. A workaround should be posted as soon as a more Mac-savvy user edits this entry.<br />
<br />
To make future access easier right click 'Data' and choose 'Make Alias'. Now drag this alias out of the application, somewhere easy to find, on your Desktop for example.<br />
<br />
Then, next time you need to open a file from within the Overgrowth package, simply navigate to the alias and you should have access to the Contents of the Data folder.<br />
<br />
===It says on the forums/blog that you can right click with command+click, but it won't work!===<br />
Unfortunately in recent alphas this functionality has been broken.<br />
Right clicking is possible with an external mouse, or on a trackpad with enabled two-finger right click.<br />
<br />
Since alpha 67 you can set a keyboard button equivalent to right click. To do so find the "config.txt" file in the Data folder, and add a line for "key[rclick]" if it doesn't exist already. then set that equal to whatever button you want to act as right click.<br />
<br />
<br />
===I want to see live console output, but the console doesn't show it until after the program closes===<br />
If you want to see the console output live you will need to run Overgrowth from the Terminal.<br />
<br />
To do so right click the Overgrowth alpha, choose 'Show Package Contents', then navigate to /Contents/MacOS/ and double click 'lugaru2'. This will open Overgrowth along with a new terminal window that displays all the data written to the console but in real time.<br />
<br />
To make accessing this file easier in the future right click the 'lugaru 2' file, choose 'Make Alias' and drag the resulting file to a more convenient location.<br />
<br />
==Linux==<br />
===Running Overgrowth on Linux===<br />
Overgrowth's Linux port was introduced in Alpha Build 180. For installation instructions, see the [[Linux]] page.<br />
<br />
=Accessing internal_testing on Steam=<br />
<br />
The development of Overgrowth is quite transparent, as such we allow our players to access the latest nightly build of our games, containing the latest changes.<br />
This build is often unstable and breaks all the time, but can be useful in sneak peaking at new content and features or for verifying if a patch fixed your problem.<br />
<br />
This build is available via Steam.<br />
<br />
Sometimes you'll be directed by bugs@wolfire.com to "Test internal_testing".<br />
<br />
To access the build, do the following.<br />
<br />
1. Locate Overgrowth in your games list<br />
2. Right click on Overgrowth and select properties<br />
3. Go into tab reading "BETA" or similar (locale variations apply)<br />
4. Click the drop-down list and select internal_testing<br />
5. Press Ok to close the properties window<br />
<br />
After making this change, steam should immediately update the game. To switch back to the latest released version, just go back into the same menu and switch back to default.<br />
<br />
[[Category:FAQs]]<br />
[[Category:Overgrowth]]<br />
[[Category:SPF]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Alpha_FAQ&diff=4597Overgrowth Alpha FAQ2017-04-18T08:39:10Z<p>Autious: </p>
<hr />
<div>This is the Overgrowth Alpha FAQ.<br />
<br />
* This FAQ is intended for useful tips for new users as well as answer common bug-related questions.<br />
* If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
<br />
Please feel free to contribute to this FAQ, and the wiki as a whole!<br />
<br />
== I just pre-ordered the game, what's next?==<br />
<br />
By pre-ordering Overgrowth, you can do two things:<br />
<br />
* Access the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forums] (referred to as SPF)<br />
* Check out the latest alphas<br />
<br />
First of all, you need an account on the forum. If you don't have one already, [http://forums.wolfire.com/ucp.php?mode=register register there]. Then follow the link given in your pre-order email, and type your nickname to get access to the SPF.<br />
<br />
In the SPF, you'll find a sticky named "Unofficial alpha XX, weekly build". You can check that post out to get the link to download the latest Overgrowth alpha.<br />
<br />
The SPF is also a place where all the preorderers discuss about the alpha, speculate about Overgrowth and ask questions to the Wolfire team. Participate and join us in the discussions!<br />
<br />
== What is an alpha exactly, and what can I do with it?==<br />
<br />
The Overgrowth alphas are very early stage "leaks" of the development progress. You are free to play around with them, but they should be not be held to the standards of a completed game.<br />
<br />
== How do I create content for Overgrowth?==<br />
<br />
Overgrowth Alphas come with a level-editor. For more info about modding, check out the rest of this wiki, and go to the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum]. For installing community-created content, you can check out [http://blog.wolfire.com/2013/04/Introducing-SUMLauncher-3 SUMLauncher].<br />
<br />
==What do I do if I encounter a Bug?==<br />
If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
Please follow the instructions [[How To Report a Bug in Overgrowth]], it increases the chances that we will be able to find and fix it.<br />
<br />
Your email should contain the following:<br />
* The Alpha Version in which the problem was encountered<br />
* Your system setup (Hardware, OS, etc.)<br />
* A Brief explanation of the problem<br />
* Actions performed, step by step, which led up to encountering the problem<br />
* Expected and Actual Results<br />
* Attachments (screenshots, crash reports, etc.)<br />
<br />
Refer to [http://university.utest.com/writing-quality-bug-reports-and-utest-etiquette/ this webpage] for tips on how to write a quality bug report.<br />
<br />
Here are additional steps you can take:<br />
* Check the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum] and look for posts that describe similar problems.<br />
* Ask on Wolfire's [http://www.wolfire.com/irc IRC channel]. Many users are long time Alpha testers and will be happy to help you.<br />
<br />
== What can I do if Overgrowth is running slow on my computer?==<br />
<br />
The Overgrowth alpha is currently set to use the maximum graphics settings, even if this is grossly inappropriate for your computer. There is not currently any UI available to change this, so you will need to edit the config.txt file. On Windows, this is located in %USERPROFILE%\Documents\Wolfire\Overgrowth\Data where %USERPROFILE% is often C:\Users\YOUR_USERNAME and YOUR_USERNAME is your Windows account name. On Mac, you will need to right click the Overgrowth application and choose show package contents. It is then located in the Data folder found in the Contents/Mac OS folder.<br />
<br />
Change the following values to these new ones:<br />
<br />
<pre>screenwidth: 800<br />
screenheight: 600<br />
multisample: 4<br />
anisotropy: 4<br />
texture_reduce: 1</pre><br />
<br />
If it's still running slow, try this:<br />
<br />
<pre>screenwidth: 640<br />
screenheight: 480<br />
multisample: 0<br />
anisotropy: 0<br />
texture_reduce: 2</pre><br />
<br />
==I can't access all of the GUI. The window crops important parts of the screen. What do I do?==<br />
This turned up, when the default resolution was lowered from 1024x768 to 800x600. You can resolve this issue by changing the settings, either to a higher resolution or to full screen mode. Changing display settings is done in the 'config.txt'-file. <br />
You can find it on computer with Windows system at:<br />
C:\Documents and Settings\Username\My Documents\Wolfire\Overgrowth\Data\config.txt<br />
or a computer with Mac system at:<br />
/Users/Username/Library/Application Support/Lugaru 2/Data/config.txt<br />
<br />
The first lines of the default config file should look like this:<br />
<pre><br />
screenwidth: 800<br />
screenheight: 600<br />
fullscreen: false<br />
</pre><br />
You can change the resolution by changing the values for screenwidth/screenheight and go to fullscreen mode by changing the 'false' to 'true'.<br />
<br />
== How do I load a model into the game? ==<br />
You need to make sure that you're not loading the model file, but the object file.<br />
* A Model file is a 3d mesh saved as a *.obj file. this file contains no textures or shader data and so cannot be loaded by itself.<br />
* An Object file is an XML that stores the filepaths for all the relevant data of an object, including the Model file as well as the textures and shader.<br />
For example if you are trying to load a file located in Data/Models/example.obj you should really be opening Data/Objects/example.xml<br />
<br />
== How do I load my custom level in the main menu?==<br />
# Make sure that you typed the name correctly, including the *.xml ending<br />
# Make sure that it exists in Data/Levels/<br />
<br />
* Recently (as at alpha 65) there have been some issues with loading custom maps from the main menu. to make sure this isn't the case:<br />
# Back up the map 'DesertFort_IGF.xml' (for example add "backup" to the name)<br />
# Rename your map as 'DesertFort_IGF.xml'<br />
# Attempt to load it by clicking the Desert map in the main menu.<br />
<br />
== How do i clear my game cache? ==<br />
<br />
http://wiki.wolfire.com/index.php/How_to_clear_the_game%27s_cache<br />
<br />
=Common Platform-Specific Problems=<br />
==Windows==<br />
=== I get the following error on startup on Windows ===<br />
<br />
<pre>The application has failed to start because its side-by-side configuration is incorrect. Please see the application event<br />
log or use the command-line sxstrace.exe tool for more detail.</pre><br />
<br />
Please install the Visual Studio 2005 C++ runtime. You can get it from this URL:<br />
http://www.microsoft.com/downloads/details.aspx?familyid=200b2fd9-ae1a-4a14-984d-389c36f85647&displaylang=en<br />
<br />
===Error: cannot create the C:\program files\Overgrowth\Data\config.txt file. ... ===<br />
This error applies to both Lugaru and Overgrowth.<br />
<br />
Symptom: When attempting to edit the config.txt file the following error message is displayed:<br />
cannot create the C:\program files\Overgrowth\Data\config.txt file. Make sure the path and file name are correct.<br />
<br />
Explanation: Windows Vista & 7 like to save the config file in a different location to the actual directory. As discussed in a thread on the forums[http://forums.wolfire.com/viewtopic.php?f=7&t=4890&p=78033#p78033], The file is actually stored in: C:\Users\USERNAME\Application Data\Local Virtual Store\Program Files/Overgrowth/config.txt<br />
<br />
==Mac==<br />
===Where is the Data folder?===<br />
With the Mac version of Overgrowth, the Data folder is located within the application package.<br />
You can access it by right clicking the "Overgrowth" application and choosing 'Show Contents", and then browsing to Contents/MacOS/Data<br />
*Note - For some users, "Show Package Contents" may not appear in the right-click menu. A workaround should be posted as soon as a more Mac-savvy user edits this entry.<br />
<br />
To make future access easier right click 'Data' and choose 'Make Alias'. Now drag this alias out of the application, somewhere easy to find, on your Desktop for example.<br />
<br />
Then, next time you need to open a file from within the Overgrowth package, simply navigate to the alias and you should have access to the Contents of the Data folder.<br />
<br />
===It says on the forums/blog that you can right click with command+click, but it won't work!===<br />
Unfortunately in recent alphas this functionality has been broken.<br />
Right clicking is possible with an external mouse, or on a trackpad with enabled two-finger right click.<br />
<br />
Since alpha 67 you can set a keyboard button equivalent to right click. To do so find the "config.txt" file in the Data folder, and add a line for "key[rclick]" if it doesn't exist already. then set that equal to whatever button you want to act as right click.<br />
<br />
<br />
===I want to see live console output, but the console doesn't show it until after the program closes===<br />
If you want to see the console output live you will need to run Overgrowth from the Terminal.<br />
<br />
To do so right click the Overgrowth alpha, choose 'Show Package Contents', then navigate to /Contents/MacOS/ and double click 'lugaru2'. This will open Overgrowth along with a new terminal window that displays all the data written to the console but in real time.<br />
<br />
To make accessing this file easier in the future right click the 'lugaru 2' file, choose 'Make Alias' and drag the resulting file to a more convenient location.<br />
<br />
==Linux==<br />
===Running Overgrowth on Linux===<br />
Overgrowth's Linux port was introduced in Alpha Build 180. For installation instructions, see the [[Linux]] page.<br />
<br />
==Accessing internal_testing on Steam==<br />
<br />
The development of Overgrowth is quite transparent, as such we allow our players to access the latest nightly build of our games, containing the latest changes.<br />
This build is often unstable and breaks all the time, but can be useful in sneak peaking at new content and features or for verifying if a patch fixed your problem.<br />
<br />
This build is available via Steam.<br />
<br />
Sometimes you'll be directed by bugs@wolfire.com to "Test internal_testing".<br />
<br />
To access the build, do the following.<br />
<br />
1. Locate Overgrowth in your games list<br />
2. Right click on Overgrowth and select properties<br />
3. Go into tab reading "BETA" or similar (locale variations apply)<br />
4. Click the drop-down list and select internal_testing<br />
5. Press Ok to close the properties window<br />
<br />
After making this change, steam should immediately update the game. To switch back to the latest released version, just go back into the same menu and switch back to default.<br />
<br />
[[Category:FAQs]]<br />
[[Category:Overgrowth]]<br />
[[Category:SPF]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4596Overgrowth Linux2017-03-30T10:51:40Z<p>Autious: /* LaunchApp: failed to execvp: [...]/AwesomiumProcess */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
<br />
''We currently don't ship an installer anymore, but we intend to do this in the future.''<br />
<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
''The following is no longer necessary as we build and deliver a 64 bit binary package, but is still necessary if you wish to run the 32 bit version.''<br />
<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2<br />
# emerge -av media-libs/libsdl-net:1.2<br />
</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl sdlnet</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4595Overgrowth Linux2017-03-30T10:51:02Z<p>Autious: /* Libraries */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
<br />
''We currently don't ship an installer anymore, but we intend to do this in the future.''<br />
<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
''The following is no longer necessary as we build and deliver a 64 bit binary package, but is still necessary if you wish to run the 32 bit version.''<br />
<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2<br />
# emerge -av media-libs/libsdl-net:1.2<br />
</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl sdlnet</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.<br />
<br />
==LaunchApp: failed to execvp: [...]/AwesomiumProcess==<br />
<br />
In case the game simply freezes after being started, it might be a good idea to start it through the terminal in order to read its output log:<br />
<pre>./Overgrowth.bin.x86</pre><br />
<br />
You might be able to see an error message similar to this:<br />
<br />
''LaunchApp: failed to execvp:<br />
<br />
[path to Overgrowth]/lib/AwesomiumProcess''<br />
<br />
This means that the system has no permission to run the file called AwesomiumProcess inside the lib directory. In order to grant the necessary permissions for the file, open a terminal, go to the lib folder where AwesomiumProcess is and run the following command:<br />
<br />
<pre>chmod +x AwesomiumProcess</pre><br />
<br />
[[Category: Overgrowth]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4594Overgrowth Linux2017-03-30T10:50:36Z<p>Autious: /* Libraries */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
<br />
''We currently don't ship an installer anymore, but we intend to do this in the future.''<br />
<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
''The following is no longer necessary as we build and deliver a 64 bit binary package, but is still necessary if you wish to run the 32 bit version.''<br />
<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl sdlnet</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.<br />
<br />
==LaunchApp: failed to execvp: [...]/AwesomiumProcess==<br />
<br />
In case the game simply freezes after being started, it might be a good idea to start it through the terminal in order to read its output log:<br />
<pre>./Overgrowth.bin.x86</pre><br />
<br />
You might be able to see an error message similar to this:<br />
<br />
''LaunchApp: failed to execvp:<br />
<br />
[path to Overgrowth]/lib/AwesomiumProcess''<br />
<br />
This means that the system has no permission to run the file called AwesomiumProcess inside the lib directory. In order to grant the necessary permissions for the file, open a terminal, go to the lib folder where AwesomiumProcess is and run the following command:<br />
<br />
<pre>chmod +x AwesomiumProcess</pre><br />
<br />
[[Category: Overgrowth]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4593Overgrowth Linux2017-03-30T10:49:58Z<p>Autious: /* 64-bit systems */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
<br />
''We currently don't ship an installer anymore, but we intend to do this in the future.''<br />
<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
''The following is no longer necessary as we build and deliver a 64 bit binary package, but is still necessary if you wish to run the 32 bit version.''<br />
<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.<br />
<br />
==LaunchApp: failed to execvp: [...]/AwesomiumProcess==<br />
<br />
In case the game simply freezes after being started, it might be a good idea to start it through the terminal in order to read its output log:<br />
<pre>./Overgrowth.bin.x86</pre><br />
<br />
You might be able to see an error message similar to this:<br />
<br />
''LaunchApp: failed to execvp:<br />
<br />
[path to Overgrowth]/lib/AwesomiumProcess''<br />
<br />
This means that the system has no permission to run the file called AwesomiumProcess inside the lib directory. In order to grant the necessary permissions for the file, open a terminal, go to the lib folder where AwesomiumProcess is and run the following command:<br />
<br />
<pre>chmod +x AwesomiumProcess</pre><br />
<br />
[[Category: Overgrowth]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4592Overgrowth Linux2017-03-30T10:49:45Z<p>Autious: /* Installer */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
<br />
''We currently don't ship an installer anymore, but we intend to do this in the future.''<br />
<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
The following is no longer necessary as we build and deliver a 64 bit binary package, but is still necessary if you wish to run the 32 bit version.<br />
<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.<br />
<br />
==LaunchApp: failed to execvp: [...]/AwesomiumProcess==<br />
<br />
In case the game simply freezes after being started, it might be a good idea to start it through the terminal in order to read its output log:<br />
<pre>./Overgrowth.bin.x86</pre><br />
<br />
You might be able to see an error message similar to this:<br />
<br />
''LaunchApp: failed to execvp:<br />
<br />
[path to Overgrowth]/lib/AwesomiumProcess''<br />
<br />
This means that the system has no permission to run the file called AwesomiumProcess inside the lib directory. In order to grant the necessary permissions for the file, open a terminal, go to the lib folder where AwesomiumProcess is and run the following command:<br />
<br />
<pre>chmod +x AwesomiumProcess</pre><br />
<br />
[[Category: Overgrowth]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4591Overgrowth Linux2017-03-30T10:48:43Z<p>Autious: /* 64-bit systems */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
The following is no longer necessary as we build and deliver a 64 bit binary package, but is still necessary if you wish to run the 32 bit version.<br />
<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.<br />
<br />
==LaunchApp: failed to execvp: [...]/AwesomiumProcess==<br />
<br />
In case the game simply freezes after being started, it might be a good idea to start it through the terminal in order to read its output log:<br />
<pre>./Overgrowth.bin.x86</pre><br />
<br />
You might be able to see an error message similar to this:<br />
<br />
''LaunchApp: failed to execvp:<br />
<br />
[path to Overgrowth]/lib/AwesomiumProcess''<br />
<br />
This means that the system has no permission to run the file called AwesomiumProcess inside the lib directory. In order to grant the necessary permissions for the file, open a terminal, go to the lib folder where AwesomiumProcess is and run the following command:<br />
<br />
<pre>chmod +x AwesomiumProcess</pre><br />
<br />
[[Category: Overgrowth]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Linux&diff=4590Overgrowth Linux2017-03-30T10:47:33Z<p>Autious: /* Libraries */</p>
<hr />
<div>The Linux version of Overgrowth has different dependencies which need to be fulfilled, otherwise the game won't run. Those dependencies can vary from distribution to distribution.<br />
<br />
=Installer=<br />
The Linux installer is a Bash script which loads a graphical installer. The shebang points to ''/bin/sh'', but it will not work with every shell.<br />
<br />
<pre># readlink -f /bin/sh<br />
/bin/bash</pre><br />
<br />
If the installer won't load and ''/bin/sh'' doesn't point to bash try to force using bash.<br />
<br />
<pre># bash overgrowth-xxx-linux.sh</pre><br />
<br />
''root'' rights are not necessarily required to install Overgrowth. If you only have a single user on your system (that wants to play Overgrowth) it is not a bad idea to install it to your home directory, because then you do not have to start SUMLauncher as root user.<br />
<br />
=Distributions=<br />
==Debian==<br />
This also includes Ubuntu, Mint etc.<br />
<br />
===Libraries===<br />
<pre># apt-get install libfreeimage3<br />
# apt-get install libalut0<br />
# apt-get install libsdl-net1.2<br />
</pre><br />
<br />
===64-bit systems===<br />
Overgrowth tries to access the 32-bit (i386) version of many libraries whose 64-bit version (amd64) might already be installed in your system. In order to install the 32-bit version of these libraries, append '':i386'' at the end of the package name when using apt-get. For example, when running Overgrowth Alpha 208 on a 64-bit Ubuntu 14.04, the following 32-bit libraries must be installed, despite its 64-bit versions already being installed:<br />
<pre>sudo apt-get install libgconf2-4:i386 libnss3:i386 libgtk2.0-0:i386 libglu1-mesa:i386 libxft2:i386</pre><br />
<br />
==Gentoo==<br />
===Libraries===<br />
Overgrowth needs different libraries in order to work. This list might not be complete.<br />
<br />
<pre># emerge -av gnome-base/gconf<br />
# emerge -av media-libs/freeimage<br />
# emerge -av media-libs/freealut<br />
# emerge -av media-libs/libpng:1.2</pre><br />
<br />
===Groups===<br />
If your user is not already in this groups you have to add him. Otherwise the game may not start and it is even possible that X will completely crash.<br />
<br />
<pre># gpasswd -a your_user audio<br />
# gpasswd -a your_user video</pre><br />
<br />
===SUMLauncher===<br />
SUMLauncher does not work with ''dev-java/sun-jdk'', you will need ''dev-java/icedtea-bin'' to use it.<br />
<br />
<pre># emerge -av dev-java/icedtea-bin<br />
# eselect java-vm list<br />
Available Java Virtual Machines:<br />
[1] icedtea-bin-6 <br />
[2] sun-jre-bin-1.6 system-vm<br />
# eselect java-vm user set 1<br />
</pre><br />
<br />
==Arch==<br />
You can install the package [https://aur.archlinux.org/packages/overgrowth/ overgrowth] from the AUR.<br />
===Libraries===<br />
If you install the AUR package all required libraries should be pulled in automatically. If you install Overgrowth manually or using SUMLauncher you will need to acquire the dependencies manually. The following should provide a good starting point:<br />
<pre># pacman -S --needed freeimage freealut sdl</pre><br />
<br />
===SUMLauncher===<br />
You can install the package [https://aur.archlinux.org/packages/sumlauncher/ sumlauncher] from the AUR.<br />
<br />
=Problems and solutions=<br />
Overgrowth currently has many severe bugs and issues on Linux. Luckily, there are fixes or workarounds for most of them. The below specifically assumes a199, so please upgrade before trying the suggestions here.<br />
<br />
==Errors about GLSL appear, mentioning GLSL versions.==<br />
<br />
This is another one that happens with Intel graphics on Linux. Add #version 130 to the tops of all files that end with .vert or .frag, but ''not'' any of the files that end with .glsl, in the Overgrowth/Data/GLSL directory. If you install mods that provide new shaders you may need to fix them as well.<br />
<br />
You can use BASH code:<br />
<br />
<pre><br />
# cd to your Overgrowth/Data/GLSL<br />
cd /usr/local/games/Overgrowth/Data/GLSL<br />
# adds #version 130 to files<br />
for f in $(ls *.vert *.frag); do echo -e "#version 130\n$(cat $f)" > $f; done<br />
</pre><br />
<br />
==Textures are missing. Loading screen shows a white box and the game appears in black and white==<br />
<br />
Overgrowth requires S3TC texture support, which is not enabled by default in open source graphics drivers. If you have this issue, you need to set up S3TC texture support. You can probably find out how by googling<br />
<br />
S3TC <your distro here><br />
<br />
Also, you may need to start with "LC_ALL=en_US" parameter e.g.:<br />
<pre>LC_ALL=en_US ./Overgrowth.bin.x86_64 </pre><br />
<br />
==Could not find "Data" folder==<br />
<br />
Unlike Windows systems, Unix-based systems are mostly case-sensitive in its directory paths. This reflects when, after starting Overgrowth, the system tries to find a "Data" folder, when the folder that is provided is actually called "data", without the capital D. Changing the lowercase D to uppercase should fix this issue.<br />
<br />
==LaunchApp: failed to execvp: [...]/AwesomiumProcess==<br />
<br />
In case the game simply freezes after being started, it might be a good idea to start it through the terminal in order to read its output log:<br />
<pre>./Overgrowth.bin.x86</pre><br />
<br />
You might be able to see an error message similar to this:<br />
<br />
''LaunchApp: failed to execvp:<br />
<br />
[path to Overgrowth]/lib/AwesomiumProcess''<br />
<br />
This means that the system has no permission to run the file called AwesomiumProcess inside the lib directory. In order to grant the necessary permissions for the file, open a terminal, go to the lib folder where AwesomiumProcess is and run the following command:<br />
<br />
<pre>chmod +x AwesomiumProcess</pre><br />
<br />
[[Category: Overgrowth]]</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4566How To Report a Bug in Overgrowth2016-08-26T19:41:24Z<p>Autious: /* Files we are interested in */</p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== General Information ==<br />
<br />
To fix a bug, it's usually important that we are able to reproduce the problem in control circumstances. To help us achieve this we appreciate the following information in your mail.<br />
<br />
* What version of the game you're running, including where you downloaded the game and if you're running the official alpha or some other test version.<br />
* What you were doing when the game crashed, including how long the game as been running, what levels you've been playing and what in-game features have been used in the editor.<br />
* What operating system you are running, and what version.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs.<br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Overgrowth/</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\</code><br />
* Linux: <code>~/.local/share/Overgrowth/</code><br />
<br />
In the cache directory there are primarily two files we are interested in.<br />
<br />
* '''Data/hwreport.txt''' - Contains information about what hardware your computer contains.<br />
* '''logfile.txt''' - Logfile of the games execution.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.<br />
<br />
== Finally ==<br />
<br />
Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.<br />
<br />
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.<br />
<br />
And finally, thanks again for giving us the time to report bugs. It goes a far way to ensure we build the best product we can.</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Alpha_FAQ&diff=4563Overgrowth Alpha FAQ2016-03-01T09:00:44Z<p>Autious: /* Editting Settings */</p>
<hr />
<div>This is the Overgrowth Alpha FAQ.<br />
<br />
* This FAQ is intended for useful tips for new users as well as answer common bug-related questions.<br />
* If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
<br />
Please feel free to contribute to this FAQ, and the wiki as a whole!<br />
<br />
== I just pre-ordered the game, what's next?==<br />
<br />
By pre-ordering Overgrowth, you can do two things:<br />
<br />
* Access the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forums] (referred to as SPF)<br />
* Check out the latest alphas<br />
<br />
First of all, you need an account on the forum. If you don't have one already, [http://forums.wolfire.com/ucp.php?mode=register register there]. Then follow the link given in your pre-order email, and type your nickname to get access to the SPF.<br />
<br />
In the SPF, you'll find a sticky named "Unofficial alpha XX, weekly build". You can check that post out to get the link to download the latest Overgrowth alpha.<br />
<br />
The SPF is also a place where all the preorderers discuss about the alpha, speculate about Overgrowth and ask questions to the Wolfire team. Participate and join us in the discussions!<br />
<br />
== What is an alpha exactly, and what can I do with it?==<br />
<br />
The Overgrowth alphas are very early stage "leaks" of the development progress. You are free to play around with them, but they should be not be held to the standards of a completed game.<br />
<br />
== How do I create content for Overgrowth?==<br />
<br />
Overgrowth Alphas come with a level-editor. For more info about modding, check out the rest of this wiki, and go to the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum]. For installing community-created content, you can check out [http://blog.wolfire.com/2013/04/Introducing-SUMLauncher-3 SUMLauncher].<br />
<br />
==What do I do if I encounter a Bug?==<br />
If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
Please follow the instructions [[How To Report a Bug in Overgrowth]], it increases the chances that we will be able to find and fix it.<br />
<br />
Your email should contain the following:<br />
* The Alpha Version in which the problem was encountered<br />
* Your system setup (Hardware, OS, etc.)<br />
* A Brief explanation of the problem<br />
* Actions performed, step by step, which led up to encountering the problem<br />
* Expected and Actual Results<br />
* Attachments (screenshots, crash reports, etc.)<br />
<br />
Refer to [http://university.utest.com/writing-quality-bug-reports-and-utest-etiquette/ this webpage] for tips on how to write a quality bug report.<br />
<br />
Here are additional steps you can take:<br />
* Check the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum] and look for posts that describe similar problems.<br />
* Ask on Wolfire's [http://www.wolfire.com/irc IRC channel]. Many users are long time Alpha testers and will be happy to help you.<br />
<br />
== What can I do if Overgrowth is running slow on my computer?==<br />
<br />
The Overgrowth alpha is currently set to use the maximum graphics settings, even if this is grossly inappropriate for your computer. There is not currently any UI available to change this, so you will need to edit the config.txt file. On Windows, this is located in %USERPROFILE%\Documents\Wolfire\Overgrowth\Data where %USERPROFILE% is often C:\Users\YOUR_USERNAME and YOUR_USERNAME is your Windows account name. On Mac, you will need to right click the Overgrowth application and choose show package contents. It is then located in the Data folder found in the Contents/Mac OS folder.<br />
<br />
Change the following values to these new ones:<br />
<br />
<pre>screenwidth: 800<br />
screenheight: 600<br />
multisample: 4<br />
anisotropy: 4<br />
texture_reduce: 1</pre><br />
<br />
If it's still running slow, try this:<br />
<br />
<pre>screenwidth: 640<br />
screenheight: 480<br />
multisample: 0<br />
anisotropy: 0<br />
texture_reduce: 2</pre><br />
<br />
==I can't access all of the GUI. The window crops important parts of the screen. What do I do?==<br />
This turned up, when the default resolution was lowered from 1024x768 to 800x600. You can resolve this issue by changing the settings, either to a higher resolution or to full screen mode. Changing display settings is done in the 'config.txt'-file. <br />
You can find it on computer with Windows system at:<br />
C:\Documents and Settings\Username\My Documents\Wolfire\Overgrowth\Data\config.txt<br />
or a computer with Mac system at:<br />
/Users/Username/Library/Application Support/Lugaru 2/Data/config.txt<br />
<br />
The first lines of the default config file should look like this:<br />
<pre><br />
screenwidth: 800<br />
screenheight: 600<br />
fullscreen: false<br />
</pre><br />
You can change the resolution by changing the values for screenwidth/screenheight and go to fullscreen mode by changing the 'false' to 'true'.<br />
<br />
== How do I load a model into the game? ==<br />
You need to make sure that you're not loading the model file, but the object file.<br />
* A Model file is a 3d mesh saved as a *.obj file. this file contains no textures or shader data and so cannot be loaded by itself.<br />
* An Object file is an XML that stores the filepaths for all the relevant data of an object, including the Model file as well as the textures and shader.<br />
For example if you are trying to load a file located in Data/Models/example.obj you should really be opening Data/Objects/example.xml<br />
<br />
== How do I load my custom level in the main menu?==<br />
# Make sure that you typed the name correctly, including the *.xml ending<br />
# Make sure that it exists in Data/Levels/<br />
<br />
* Recently (as at alpha 65) there have been some issues with loading custom maps from the main menu. to make sure this isn't the case:<br />
# Back up the map 'DesertFort_IGF.xml' (for example add "backup" to the name)<br />
# Rename your map as 'DesertFort_IGF.xml'<br />
# Attempt to load it by clicking the Desert map in the main menu.<br />
<br />
== How do i clear my game cache? ==<br />
<br />
http://wiki.wolfire.com/index.php/How_to_clear_the_game%27s_cache<br />
<br />
=Common Platform-Specific Problems=<br />
==Windows==<br />
=== I get the following error on startup on Windows ===<br />
<br />
<pre>The application has failed to start because its side-by-side configuration is incorrect. Please see the application event<br />
log or use the command-line sxstrace.exe tool for more detail.</pre><br />
<br />
Please install the Visual Studio 2005 C++ runtime. You can get it from this URL:<br />
http://www.microsoft.com/downloads/details.aspx?familyid=200b2fd9-ae1a-4a14-984d-389c36f85647&displaylang=en<br />
<br />
===Error: cannot create the C:\program files\Overgrowth\Data\config.txt file. ... ===<br />
This error applies to both Lugaru and Overgrowth.<br />
<br />
Symptom: When attempting to edit the config.txt file the following error message is displayed:<br />
cannot create the C:\program files\Overgrowth\Data\config.txt file. Make sure the path and file name are correct.<br />
<br />
Explanation: Windows Vista & 7 like to save the config file in a different location to the actual directory. As discussed in a thread on the forums[http://forums.wolfire.com/viewtopic.php?f=7&t=4890&p=78033#p78033], The file is actually stored in: C:\Users\USERNAME\Application Data\Local Virtual Store\Program Files/Overgrowth/config.txt<br />
<br />
==Mac==<br />
===Where is the Data folder?===<br />
With the Mac version of Overgrowth, the Data folder is located within the application package.<br />
You can access it by right clicking the "Overgrowth" application and choosing 'Show Contents", and then browsing to Contents/MacOS/Data<br />
*Note - For some users, "Show Package Contents" may not appear in the right-click menu. A workaround should be posted as soon as a more Mac-savvy user edits this entry.<br />
<br />
To make future access easier right click 'Data' and choose 'Make Alias'. Now drag this alias out of the application, somewhere easy to find, on your Desktop for example.<br />
<br />
Then, next time you need to open a file from within the Overgrowth package, simply navigate to the alias and you should have access to the Contents of the Data folder.<br />
<br />
===It says on the forums/blog that you can right click with command+click, but it won't work!===<br />
Unfortunately in recent alphas this functionality has been broken.<br />
Right clicking is possible with an external mouse, or on a trackpad with enabled two-finger right click.<br />
<br />
Since alpha 67 you can set a keyboard button equivalent to right click. To do so find the "config.txt" file in the Data folder, and add a line for "key[rclick]" if it doesn't exist already. then set that equal to whatever button you want to act as right click.<br />
<br />
<br />
===I want to see live console output, but the console doesn't show it until after the program closes===<br />
If you want to see the console output live you will need to run Overgrowth from the Terminal.<br />
<br />
To do so right click the Overgrowth alpha, choose 'Show Package Contents', then navigate to /Contents/MacOS/ and double click 'lugaru2'. This will open Overgrowth along with a new terminal window that displays all the data written to the console but in real time.<br />
<br />
To make accessing this file easier in the future right click the 'lugaru 2' file, choose 'Make Alias' and drag the resulting file to a more convenient location.<br />
<br />
==Linux==<br />
===Running Overgrowth on Linux===<br />
Overgrowth's Linux port was introduced in Alpha Build 180. For installation instructions, see the [[Linux]] page.<br />
<br />
<br />
<br />
[[Category:FAQs]]<br />
[[Category:Overgrowth]]<br />
[[Category:SPF]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Alpha_FAQ&diff=4562Overgrowth Alpha FAQ2016-03-01T09:00:37Z<p>Autious: /* Editting Settings */</p>
<hr />
<div>This is the Overgrowth Alpha FAQ.<br />
<br />
* This FAQ is intended for useful tips for new users as well as answer common bug-related questions.<br />
* If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
<br />
Please feel free to contribute to this FAQ, and the wiki as a whole!<br />
<br />
== I just pre-ordered the game, what's next?==<br />
<br />
By pre-ordering Overgrowth, you can do two things:<br />
<br />
* Access the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forums] (referred to as SPF)<br />
* Check out the latest alphas<br />
<br />
First of all, you need an account on the forum. If you don't have one already, [http://forums.wolfire.com/ucp.php?mode=register register there]. Then follow the link given in your pre-order email, and type your nickname to get access to the SPF.<br />
<br />
In the SPF, you'll find a sticky named "Unofficial alpha XX, weekly build". You can check that post out to get the link to download the latest Overgrowth alpha.<br />
<br />
The SPF is also a place where all the preorderers discuss about the alpha, speculate about Overgrowth and ask questions to the Wolfire team. Participate and join us in the discussions!<br />
<br />
== What is an alpha exactly, and what can I do with it?==<br />
<br />
The Overgrowth alphas are very early stage "leaks" of the development progress. You are free to play around with them, but they should be not be held to the standards of a completed game.<br />
<br />
== How do I create content for Overgrowth?==<br />
<br />
Overgrowth Alphas come with a level-editor. For more info about modding, check out the rest of this wiki, and go to the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum]. For installing community-created content, you can check out [http://blog.wolfire.com/2013/04/Introducing-SUMLauncher-3 SUMLauncher].<br />
<br />
==What do I do if I encounter a Bug?==<br />
If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
Please follow the instructions [[How To Report a Bug in Overgrowth]], it increases the chances that we will be able to find and fix it.<br />
<br />
Your email should contain the following:<br />
* The Alpha Version in which the problem was encountered<br />
* Your system setup (Hardware, OS, etc.)<br />
* A Brief explanation of the problem<br />
* Actions performed, step by step, which led up to encountering the problem<br />
* Expected and Actual Results<br />
* Attachments (screenshots, crash reports, etc.)<br />
<br />
Refer to [http://university.utest.com/writing-quality-bug-reports-and-utest-etiquette/ this webpage] for tips on how to write a quality bug report.<br />
<br />
Here are additional steps you can take:<br />
* Check the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum] and look for posts that describe similar problems.<br />
* Ask on Wolfire's [http://www.wolfire.com/irc IRC channel]. Many users are long time Alpha testers and will be happy to help you.<br />
<br />
== What can I do if Overgrowth is running slow on my computer?==<br />
<br />
The Overgrowth alpha is currently set to use the maximum graphics settings, even if this is grossly inappropriate for your computer. There is not currently any UI available to change this, so you will need to edit the config.txt file. On Windows, this is located in %USERPROFILE%\Documents\Wolfire\Overgrowth\Data where %USERPROFILE% is often C:\Users\YOUR_USERNAME and YOUR_USERNAME is your Windows account name. On Mac, you will need to right click the Overgrowth application and choose show package contents. It is then located in the Data folder found in the Contents/Mac OS folder.<br />
<br />
Change the following values to these new ones:<br />
<br />
<pre>screenwidth: 800<br />
screenheight: 600<br />
multisample: 4<br />
anisotropy: 4<br />
texture_reduce: 1</pre><br />
<br />
If it's still running slow, try this:<br />
<br />
<pre>screenwidth: 640<br />
screenheight: 480<br />
multisample: 0<br />
anisotropy: 0<br />
texture_reduce: 2</pre><br />
<br />
==I can't access all of the GUI. The window crops important parts of the screen. What do I do?==<br />
This turned up, when the default resolution was lowered from 1024x768 to 800x600. You can resolve this issue by changing the settings, either to a higher resolution or to full screen mode. Changing display settings is done in the 'config.txt'-file. <br />
You can find it on computer with Windows system at:<br />
C:\Documents and Settings\Username\My Documents\Wolfire\Overgrowth\Data\config.txt<br />
or a computer with Mac system at:<br />
/Users/Username/Library/Application Support/Lugaru 2/Data/config.txt<br />
<br />
The first lines of the default config file should look like this:<br />
<pre><br />
screenwidth: 800<br />
screenheight: 600<br />
fullscreen: false<br />
</pre><br />
You can change the resolution by changing the values for screenwidth/screenheight and go to fullscreen mode by changing the 'false' to 'true'.<br />
<br />
== How do I load a model into the game? ==<br />
You need to make sure that you're not loading the model file, but the object file.<br />
* A Model file is a 3d mesh saved as a *.obj file. this file contains no textures or shader data and so cannot be loaded by itself.<br />
* An Object file is an XML that stores the filepaths for all the relevant data of an object, including the Model file as well as the textures and shader.<br />
For example if you are trying to load a file located in Data/Models/example.obj you should really be opening Data/Objects/example.xml<br />
<br />
== How do I load my custom level in the main menu?==<br />
# Make sure that you typed the name correctly, including the *.xml ending<br />
# Make sure that it exists in Data/Levels/<br />
<br />
* Recently (as at alpha 65) there have been some issues with loading custom maps from the main menu. to make sure this isn't the case:<br />
# Back up the map 'DesertFort_IGF.xml' (for example add "backup" to the name)<br />
# Rename your map as 'DesertFort_IGF.xml'<br />
# Attempt to load it by clicking the Desert map in the main menu.<br />
<br />
== How do i clear my game cache? ==<br />
<br />
http://wiki.wolfire.com/index.php/How_to_clear_the_game%27s_cache<br />
<br />
=Common Platform-Specific Problems=<br />
==Windows==<br />
=== I get the following error on startup on Windows ===<br />
<br />
<pre>The application has failed to start because its side-by-side configuration is incorrect. Please see the application event<br />
log or use the command-line sxstrace.exe tool for more detail.</pre><br />
<br />
Please install the Visual Studio 2005 C++ runtime. You can get it from this URL:<br />
http://www.microsoft.com/downloads/details.aspx?familyid=200b2fd9-ae1a-4a14-984d-389c36f85647&displaylang=en<br />
<br />
===Error: cannot create the C:\program files\Overgrowth\Data\config.txt file. ... ===<br />
This error applies to both Lugaru and Overgrowth.<br />
<br />
Symptom: When attempting to edit the config.txt file the following error message is displayed:<br />
cannot create the C:\program files\Overgrowth\Data\config.txt file. Make sure the path and file name are correct.<br />
<br />
Explanation: Windows Vista & 7 like to save the config file in a different location to the actual directory. As discussed in a thread on the forums[http://forums.wolfire.com/viewtopic.php?f=7&t=4890&p=78033#p78033], The file is actually stored in: C:\Users\USERNAME\Application Data\Local Virtual Store\Program Files/Overgrowth/config.txt<br />
<br />
==Mac==<br />
===Where is the Data folder?===<br />
With the Mac version of Overgrowth, the Data folder is located within the application package.<br />
You can access it by right clicking the "Overgrowth" application and choosing 'Show Contents", and then browsing to Contents/MacOS/Data<br />
*Note - For some users, "Show Package Contents" may not appear in the right-click menu. A workaround should be posted as soon as a more Mac-savvy user edits this entry.<br />
<br />
To make future access easier right click 'Data' and choose 'Make Alias'. Now drag this alias out of the application, somewhere easy to find, on your Desktop for example.<br />
<br />
Then, next time you need to open a file from within the Overgrowth package, simply navigate to the alias and you should have access to the Contents of the Data folder.<br />
<br />
===It says on the forums/blog that you can right click with command+click, but it won't work!===<br />
Unfortunately in recent alphas this functionality has been broken.<br />
Right clicking is possible with an external mouse, or on a trackpad with enabled two-finger right click.<br />
<br />
Since alpha 67 you can set a keyboard button equivalent to right click. To do so find the "config.txt" file in the Data folder, and add a line for "key[rclick]" if it doesn't exist already. then set that equal to whatever button you want to act as right click.<br />
<br />
<br />
===I want to see live console output, but the console doesn't show it until after the program closes===<br />
If you want to see the console output live you will need to run Overgrowth from the Terminal.<br />
<br />
To do so right click the Overgrowth alpha, choose 'Show Package Contents', then navigate to /Contents/MacOS/ and double click 'lugaru2'. This will open Overgrowth along with a new terminal window that displays all the data written to the console but in real time.<br />
<br />
To make accessing this file easier in the future right click the 'lugaru 2' file, choose 'Make Alias' and drag the resulting file to a more convenient location.<br />
<br />
==Linux==<br />
===Running Overgrowth on Linux===<br />
Overgrowth's Linux port was introduced in Alpha Build 180. For installation instructions, see the [[Linux]] page.<br />
<br />
===Editting Settings===<br />
<br />
<br />
[[Category:FAQs]]<br />
[[Category:Overgrowth]]<br />
[[Category:SPF]]</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4560How To Report a Bug in Overgrowth2016-02-20T21:20:36Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== General Information ==<br />
<br />
To fix a bug, it's usually important that we are able to reproduce the problem in control circumstances. To help us achieve this we appreciate the following information in your mail.<br />
<br />
* What version of the game you're running, including where you downloaded the game and if you're running the official alpha or some other test version.<br />
* What you were doing when the game crashed, including how long the game as been running, what levels you've been playing and what in-game features have been used in the editor.<br />
* What operating system you are running, and what version.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs.<br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\</code><br />
* Linux: <code>~/.local/share/Overgrowth/</code><br />
<br />
In the cache directory there are primarily two files we are interested in.<br />
<br />
* '''Data/hwreport.txt''' - Contains information about what hardware your computer contains.<br />
* '''logfile.txt''' - Logfile of the games execution.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.<br />
<br />
== Finally ==<br />
<br />
Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.<br />
<br />
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.<br />
<br />
And finally, thanks again for giving us the time to report bugs. It goes a far way to ensure we build the best product we can.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4559How To Report a Bug in Overgrowth2016-02-20T21:18:45Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== General Information ==<br />
<br />
To fix a bug, it's usually important that we are able to reproduce the problem in control circumstances. To help us achieve this we appreciate the following information in your mail.<br />
<br />
* What version of the game you're running, including where you downloaded the game and if you're running the official alpha or some other test version.<br />
* What you were doing when the game crashed, including how long the game as been running, what levels you've been playing and what in-game features have been used in the editor.<br />
* What operating system you are running, and what version.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\</code><br />
* Linux: <code>~/.local/share/Overgrowth/</code><br />
<br />
In the cache directory there are primarily two files we are interested in.<br />
<br />
* '''Data/hwreport.txt''' - Contains information about what hardware your computer contains.<br />
* '''logfile.txt''' - Logfile of the games execution.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.<br />
<br />
== Finally ==<br />
<br />
Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.<br />
<br />
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.<br />
<br />
And finally, thanks again for giving us the time to report bugs. It goes a far way to ensure we build the best product we can.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4558How To Report a Bug in Overgrowth2016-02-20T21:18:13Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== General Information ==<br />
<br />
To fix a bug, it's usually important that we are able to reproduce the problem in control circumstances. To help us achieve this we appreciate the following information in your mail.<br />
<br />
* What version of the game you're running, including where you downloaded the game and if you're running the official alpha or some other test version.<br />
* What you were doing when the game crashed, including how long the game as been running, what levels you've been playing and what in-game features have been used in the editor.<br />
* What operating system you are running, and what version.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\</code><br />
* Linux: <code>~/.local/share/Overgrowth/</code><br />
<br />
In the cache directory there are primarily two files we are interested in.<br />
<br />
* Data/hwreport.txt - Contains information about what hardware your computer contains.<br />
* logfile.txt - Logfile of the games execution.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.<br />
<br />
== Finally ==<br />
<br />
Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.<br />
<br />
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.<br />
<br />
And finally, thanks again for giving us the time to report bugs. It goes a far way to ensure we build the best product we can.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4557How To Report a Bug in Overgrowth2016-02-20T21:16:44Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== General Information ==<br />
<br />
To fix a bug, it's usually important that we are able to reproduce the problem in control circumstances. To help us achieve this we appreciate the following information in your mail.<br />
<br />
* What version of the game you're running, including where you downloaded the game and if you're running the official alpha or some other test version.<br />
* What you were doing when the game crashed, including how long the game as been running, what levels you've been playing and what in-game features have been used in the editor.<br />
* What operating system you are running, and what version.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\</code><br />
* Linux: <code>~/.local/share/Overgrowth/</code><br />
<br />
In the cache directory there are primarily two files we are interested in.<br />
<br />
* Data/hwreport.txt <br />
* logfile.txt<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it, it will be in a folder with the name crash and the date of the crash. Send all the contents.<br />
<br />
== Finally ==<br />
<br />
Note that we get multiple bug reports daily and we have a limited staff. This means we can't follow up on all bug reports, even less solve all of them. So don't feel offended if you don't get a response.<br />
<br />
We might call back on you to give us additional information, if so we'll contact you on the same email you initially reported from.<br />
<br />
And finally, thanks again for giving us the time to report bugs. It goes a far way to ensure we build the best product we can.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4556How To Report a Bug in Overgrowth2016-02-20T20:56:35Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\</code><br />
* Linux: <code>~/.local/share/Overgrowth/</code><br />
<br />
In the cache directory there are primarily two files we are interested in. <br />
<br />
If the problem occurred in relation to a crash, you will have gotten a '''.dmp''' file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4555How To Report a Bug in Overgrowth2016-02-20T20:46:20Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/Data</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\Data</code><br />
* Linux: <code>~/.local/share/Overgrowth/Data</code><br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4554How To Report a Bug in Overgrowth2016-02-20T20:45:52Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/Data</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\Data</code><br />
* Linux: <code>~/.local/share/Overgrowth/Data</code><br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4553How To Report a Bug in Overgrowth2016-02-20T20:45:01Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/Data</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\Data</code><br />
* Linux: <code>~/.local/share/Overgrowth/Data</code><br />
<br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4552How To Report a Bug in Overgrowth2016-02-20T20:44:50Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/Data</code>. Where '~' is your username.<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\Data</code> '''(NOT Program Files\Wolfire\Overgrowth\Data!)'''<br />
* Linux: <code>~/.local/share/Overgrowth/Data</code><br />
<br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4551How To Report a Bug in Overgrowth2016-02-20T20:44:14Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
* Mac: <code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/Data</code><br />
Where '~' is your username.<br />
<br />
* Windows: <code>My Documents\Wolfire\Overgrowth\Data</code> '''(NOT Program Files\Wolfire\Overgrowth\Data!)'''<br />
<br />
<br />
* Linux: <code>~/.local/share/Overgrowth/Data</code><br />
<br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4550How To Report a Bug in Overgrowth2016-02-20T20:43:09Z<p>Autious: </p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
=Mac=<br />
Delete the following folder:<br />
<code>Macintosh HD/Users/~/Library/Application Support/Lugaru 2/Data</code><br />
Where '~' is your username.<br />
<br />
=Windows=<br />
Delete the following folder:<br />
<code>My Documents\Wolfire\Overgrowth\Data</code> '''(NOT Program Files\Wolfire\Overgrowth\Data!)'''<br />
<br />
<br />
=Linux=<br />
Delete the following folder: <br />
<code>~/.local/share/Overgrowth/Data</code><br />
<br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=How_To_Report_a_Bug_in_Overgrowth&diff=4549How To Report a Bug in Overgrowth2016-02-20T20:38:24Z<p>Autious: Created page with "Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps. == Files we are in..."</p>
<hr />
<div>Hi! Thanks for giving us your time to report a bug in Overgrowth. To ensure that we get as much relevant information as possible, follow the following steps.<br />
<br />
<br />
== Files we are interested in ==<br />
<br />
While running, the game writes multiple files into a local cache directory, included in these are some logs and other files. <br />
<br />
Depending on your operating system (Windows, Linux or Ubuntu) the local cache directory will be in a different place, following are the directories for the respective operating system. Any file we refer to that we might want you to send will be in this directory.<br />
<br />
If the problem occurred in relation to a crash, you will have gotten a .dmp file, please include it.</div>Autioushttps://wiki.wolfire.com/index.php?title=My_First_Mod&diff=4548My First Mod2016-02-20T20:38:10Z<p>Autious: Created page with "Lets make a mod where we create our own hotspot."</p>
<hr />
<div>Lets make a mod where we create our own hotspot.</div>Autioushttps://wiki.wolfire.com/index.php?title=Portal:Overgrowth&diff=4547Portal:Overgrowth2016-02-20T20:37:43Z<p>Autious: /* Modding Tutorials */</p>
<hr />
<div><noinclude>[[Category:Portals|{{PAGENAME}}]] [[Category:Overgrowth|{{PAGENAME}}]] </noinclude><br />
{{Overgrowth Portal Header}}<br />
<br />
-----<br />
<br />
<br />
[http://www.wolfire.com/overgrowth Overgrowth] is a cross-platform game in development by Wolfire Games, an independent game company consisting of David Rosen, founder and lead programmer, and Aubrey Serr, lead artist. Overgrowth is the spiritual successor to [[Lugaru]], a game also developed by Wolfire. Development of Overgrowth was officially announced on September 17th, 2008. The game is currently in Alpha and is playable via [http://www.wolfire.com/overgrowth/preorder preorder].<br />
<br />
Gameplay emphasises 3rd-person, fluid, fast-paced melee combat, and 3D-platforming. Overgrowth uses a custom game engine codenamed "[[Phoenix Engine|Phoenix]]", and a lot of work has been put into making it accessible to [[Editor_Interface|modding]].<br />
<br />
The game currently consists of a collection of maps (some of which are populated by enemies) which the player is able to explore (and modify if they are so inclined). As of Alpha v197, there is are two additional gameplay modes, one dubbed "Arena", in which the player is pitted against procedurally generated enemies in gladiatorial matches, and one dubbed "Challenge", a collection of 12 levels in which the player must complete a certain task or set of tasks.<br />
<br />
As of yet there is no definite story line. However, in a 2012 interview with British video gaming website zConnection, the Wolfire team stated that they are planning on continuing the story of [[Turner]], a couple of years after the events of [[Lugaru]]. In addition to anthropomorphic rabbits and wolves, the Overgrowth Universe now already includes cats, dogs, and rats (see article: [[Races]]).<br />
<br />
== Getting Started ==<br />
* [[Getting_Started | First Steps]]<br />
* [[Configuring Overgrowth]]<br />
* [[Control Reference]]<br />
* [[Overgrowth Alpha FAQ| Overgrowth FAQ]]<br />
* [[Alpha List]]<br />
<br />
== Phoenix Engine Documentation ==<br />
''NOTE: A lot of (somewhat dated) information can be found via [http://blog.wolfire.com/2010/12/Overgrowth-graphics-overview this blog post] by David. If you have some time, please merge that info into the wiki, and update/add as needed!<br />
* [[Editor Interface]]<br />
* [[Scripting]]<br />
** [[Hotspots]]<br />
* [[3D Objects]]<br />
* [[Character Models]]<br />
* [[Particle Effects]]<br />
* [[Post Processing Effects]]<br />
* [[Overgrowth Levels]]<br />
<br />
==Modding Tutorials==<br />
* [[Creating a new Mod]]<br />
* [[My First Mod]]<br />
* [[Making New Models & Textures]]<br />
* [[Custom Decals]]<br />
* [[Custom Terrain]]<br />
<br />
==Alpha Testing==<br />
* [[Overgrowth tests]] {{stub}}<br />
<br />
== The Overgrowth Universe ==<br />
* [[Races]]<br />
* [[Locations]]<br />
* [[Characters]]<br />
* [[Equipment and Weapons]]<br />
* [[Alpha Stages]]<br />
* [[Lore]]<br />
<br />
== Misc ==<br />
* [[Useful Links]]<br />
* [[Supported Video Cards]]<br />
* [[Overgrowth_Linux|Linux]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Alpha_FAQ&diff=4546Overgrowth Alpha FAQ2016-02-20T20:26:44Z<p>Autious: /* What do I do if I encounter a Bug? */</p>
<hr />
<div>This is the Overgrowth Alpha FAQ.<br />
<br />
* This FAQ is intended for useful tips for new users as well as answer common bug-related questions.<br />
* If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
<br />
Please feel free to contribute to this FAQ, and the wiki as a whole!<br />
<br />
== I just pre-ordered the game, what's next?==<br />
<br />
By pre-ordering Overgrowth, you can do two things:<br />
<br />
* Access the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forums] (referred to as SPF)<br />
* Check out the latest alphas<br />
<br />
First of all, you need an account on the forum. If you don't have one already, [http://forums.wolfire.com/ucp.php?mode=register register there]. Then follow the link given in your pre-order email, and type your nickname to get access to the SPF.<br />
<br />
In the SPF, you'll find a sticky named "Unofficial alpha XX, weekly build". You can check that post out to get the link to download the latest Overgrowth alpha.<br />
<br />
The SPF is also a place where all the preorderers discuss about the alpha, speculate about Overgrowth and ask questions to the Wolfire team. Participate and join us in the discussions!<br />
<br />
== What is an alpha exactly, and what can I do with it?==<br />
<br />
The Overgrowth alphas are very early stage "leaks" of the development progress. You are free to play around with them, but they should be not be held to the standards of a completed game.<br />
<br />
== How do I create content for Overgrowth?==<br />
<br />
Overgrowth Alphas come with a level-editor. For more info about modding, check out the rest of this wiki, and go to the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum]. For installing community-created content, you can check out [http://blog.wolfire.com/2013/04/Introducing-SUMLauncher-3 SUMLauncher].<br />
<br />
==What do I do if I encounter a Bug?==<br />
If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
Please follow the instructions [[How To Report a Bug in Overgrowth]], it increases the chances that we will be able to find and fix it.<br />
<br />
Your email should contain the following:<br />
* The Alpha Version in which the problem was encountered<br />
* Your system setup (Hardware, OS, etc.)<br />
* A Brief explanation of the problem<br />
* Actions performed, step by step, which led up to encountering the problem<br />
* Expected and Actual Results<br />
* Attachments (screenshots, crash reports, etc.)<br />
<br />
Refer to [http://university.utest.com/writing-quality-bug-reports-and-utest-etiquette/ this webpage] for tips on how to write a quality bug report.<br />
<br />
Here are additional steps you can take:<br />
* Check the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum] and look for posts that describe similar problems.<br />
* Ask on Wolfire's [http://www.wolfire.com/irc IRC channel]. Many users are long time Alpha testers and will be happy to help you.<br />
<br />
== What can I do if Overgrowth is running slow on my computer?==<br />
<br />
The Overgrowth alpha is currently set to use the maximum graphics settings, even if this is grossly inappropriate for your computer. There is not currently any UI available to change this, so you will need to edit the config.txt file. On Windows, this is located in %USERPROFILE%\Documents\Wolfire\Overgrowth\Data where %USERPROFILE% is often C:\Users\YOUR_USERNAME and YOUR_USERNAME is your Windows account name. On Mac, you will need to right click the Overgrowth application and choose show package contents. It is then located in the Data folder found in the Contents/Mac OS folder.<br />
<br />
Change the following values to these new ones:<br />
<br />
<pre>screenwidth: 800<br />
screenheight: 600<br />
multisample: 4<br />
anisotropy: 4<br />
texture_reduce: 1</pre><br />
<br />
If it's still running slow, try this:<br />
<br />
<pre>screenwidth: 640<br />
screenheight: 480<br />
multisample: 0<br />
anisotropy: 0<br />
texture_reduce: 2</pre><br />
<br />
==I can't access all of the GUI. The window crops important parts of the screen. What do I do?==<br />
This turned up, when the default resolution was lowered from 1024x768 to 800x600. You can resolve this issue by changing the settings, either to a higher resolution or to full screen mode. Changing display settings is done in the 'config.txt'-file. <br />
You can find it on computer with Windows system at:<br />
C:\Documents and Settings\Username\My Documents\Wolfire\Overgrowth\Data\config.txt<br />
or a computer with Mac system at:<br />
/Users/Username/Library/Application Support/Lugaru 2/Data/config.txt<br />
<br />
The first lines of the default config file should look like this:<br />
<pre><br />
screenwidth: 800<br />
screenheight: 600<br />
fullscreen: false<br />
</pre><br />
You can change the resolution by changing the values for screenwidth/screenheight and go to fullscreen mode by changing the 'false' to 'true'.<br />
<br />
== How do I load a model into the game? ==<br />
You need to make sure that you're not loading the model file, but the object file.<br />
* A Model file is a 3d mesh saved as a *.obj file. this file contains no textures or shader data and so cannot be loaded by itself.<br />
* An Object file is an XML that stores the filepaths for all the relevant data of an object, including the Model file as well as the textures and shader.<br />
For example if you are trying to load a file located in Data/Models/example.obj you should really be opening Data/Objects/example.xml<br />
<br />
== How do I load my custom level in the main menu?==<br />
# Make sure that you typed the name correctly, including the *.xml ending<br />
# Make sure that it exists in Data/Levels/<br />
<br />
* Recently (as at alpha 65) there have been some issues with loading custom maps from the main menu. to make sure this isn't the case:<br />
# Back up the map 'DesertFort_IGF.xml' (for example add "backup" to the name)<br />
# Rename your map as 'DesertFort_IGF.xml'<br />
# Attempt to load it by clicking the Desert map in the main menu.<br />
<br />
== How do i clear my game cache? ==<br />
<br />
http://wiki.wolfire.com/index.php/How_to_clear_the_game%27s_cache<br />
<br />
=Common Platform-Specific Problems=<br />
==Windows==<br />
=== I get the following error on startup on Windows ===<br />
<br />
<pre>The application has failed to start because its side-by-side configuration is incorrect. Please see the application event<br />
log or use the command-line sxstrace.exe tool for more detail.</pre><br />
<br />
Please install the Visual Studio 2005 C++ runtime. You can get it from this URL:<br />
http://www.microsoft.com/downloads/details.aspx?familyid=200b2fd9-ae1a-4a14-984d-389c36f85647&displaylang=en<br />
<br />
===Error: cannot create the C:\program files\Overgrowth\Data\config.txt file. ... ===<br />
This error applies to both Lugaru and Overgrowth.<br />
<br />
Symptom: When attempting to edit the config.txt file the following error message is displayed:<br />
cannot create the C:\program files\Overgrowth\Data\config.txt file. Make sure the path and file name are correct.<br />
<br />
Explanation: Windows Vista & 7 like to save the config file in a different location to the actual directory. As discussed in a thread on the forums[http://forums.wolfire.com/viewtopic.php?f=7&t=4890&p=78033#p78033], The file is actually stored in: C:\Users\USERNAME\Application Data\Local Virtual Store\Program Files/Overgrowth/config.txt<br />
<br />
==Mac==<br />
===Where is the Data folder?===<br />
With the Mac version of Overgrowth, the Data folder is located within the application package.<br />
You can access it by right clicking the "Overgrowth" application and choosing 'Show Contents", and then browsing to Contents/MacOS/Data<br />
*Note - For some users, "Show Package Contents" may not appear in the right-click menu. A workaround should be posted as soon as a more Mac-savvy user edits this entry.<br />
<br />
To make future access easier right click 'Data' and choose 'Make Alias'. Now drag this alias out of the application, somewhere easy to find, on your Desktop for example.<br />
<br />
Then, next time you need to open a file from within the Overgrowth package, simply navigate to the alias and you should have access to the Contents of the Data folder.<br />
<br />
===It says on the forums/blog that you can right click with command+click, but it won't work!===<br />
Unfortunately in recent alphas this functionality has been broken.<br />
Right clicking is possible with an external mouse, or on a trackpad with enabled two-finger right click.<br />
<br />
Since alpha 67 you can set a keyboard button equivalent to right click. To do so find the "config.txt" file in the Data folder, and add a line for "key[rclick]" if it doesn't exist already. then set that equal to whatever button you want to act as right click.<br />
<br />
<br />
===I want to see live console output, but the console doesn't show it until after the program closes===<br />
If you want to see the console output live you will need to run Overgrowth from the Terminal.<br />
<br />
To do so right click the Overgrowth alpha, choose 'Show Package Contents', then navigate to /Contents/MacOS/ and double click 'lugaru2'. This will open Overgrowth along with a new terminal window that displays all the data written to the console but in real time.<br />
<br />
To make accessing this file easier in the future right click the 'lugaru 2' file, choose 'Make Alias' and drag the resulting file to a more convenient location.<br />
<br />
==Linux==<br />
===Running Overgrowth on Linux===<br />
Overgrowth's Linux port was introduced in Alpha Build 180. For installation instructions, see the [[Linux]] page.<br />
<br />
===Editting Settings===<br />
Overgrowth does not support changing your settings in game as of yet, so if you wish to do this you need to edit default configuration files. <br />
For more information, visit the [http://wiki.wolfire.com/index.php/How_to_modify_the_game%27s_configuration Modify Configurations] page.<br />
<br />
<br />
[[Category:FAQs]]<br />
[[Category:Overgrowth]]<br />
[[Category:SPF]]</div>Autioushttps://wiki.wolfire.com/index.php?title=Overgrowth_Alpha_FAQ&diff=4545Overgrowth Alpha FAQ2016-02-20T20:26:14Z<p>Autious: /* What do I do if I encounter a Bug? */</p>
<hr />
<div>This is the Overgrowth Alpha FAQ.<br />
<br />
* This FAQ is intended for useful tips for new users as well as answer common bug-related questions.<br />
* If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
<br />
Please feel free to contribute to this FAQ, and the wiki as a whole!<br />
<br />
== I just pre-ordered the game, what's next?==<br />
<br />
By pre-ordering Overgrowth, you can do two things:<br />
<br />
* Access the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forums] (referred to as SPF)<br />
* Check out the latest alphas<br />
<br />
First of all, you need an account on the forum. If you don't have one already, [http://forums.wolfire.com/ucp.php?mode=register register there]. Then follow the link given in your pre-order email, and type your nickname to get access to the SPF.<br />
<br />
In the SPF, you'll find a sticky named "Unofficial alpha XX, weekly build". You can check that post out to get the link to download the latest Overgrowth alpha.<br />
<br />
The SPF is also a place where all the preorderers discuss about the alpha, speculate about Overgrowth and ask questions to the Wolfire team. Participate and join us in the discussions!<br />
<br />
== What is an alpha exactly, and what can I do with it?==<br />
<br />
The Overgrowth alphas are very early stage "leaks" of the development progress. You are free to play around with them, but they should be not be held to the standards of a completed game.<br />
<br />
== How do I create content for Overgrowth?==<br />
<br />
Overgrowth Alphas come with a level-editor. For more info about modding, check out the rest of this wiki, and go to the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum]. For installing community-created content, you can check out [http://blog.wolfire.com/2013/04/Introducing-SUMLauncher-3 SUMLauncher].<br />
<br />
==What do I do if I encounter a Bug?==<br />
If you wish to report a bug, email it to [mailto:bugs@wolfire.com bugs@wolfire.com].<br />
Please follow the instructions [[How To Report a Bug in Overgrowth]].<br />
<br />
Your email should contain the following:<br />
* The Alpha Version in which the problem was encountered<br />
* Your system setup (Hardware, OS, etc.)<br />
* A Brief explanation of the problem<br />
* Actions performed, step by step, which led up to encountering the problem<br />
* Expected and Actual Results<br />
* Attachments (screenshots, crash reports, etc.)<br />
<br />
Refer to [http://university.utest.com/writing-quality-bug-reports-and-utest-etiquette/ this webpage] for tips on how to write a quality bug report.<br />
<br />
Here are additional steps you can take:<br />
* Check the [http://forums.wolfire.com/viewforum.php?f=13 Secret Preorder Forum] and look for posts that describe similar problems.<br />
* Ask on Wolfire's [http://www.wolfire.com/irc IRC channel]. Many users are long time Alpha testers and will be happy to help you.<br />
<br />
== What can I do if Overgrowth is running slow on my computer?==<br />
<br />
The Overgrowth alpha is currently set to use the maximum graphics settings, even if this is grossly inappropriate for your computer. There is not currently any UI available to change this, so you will need to edit the config.txt file. On Windows, this is located in %USERPROFILE%\Documents\Wolfire\Overgrowth\Data where %USERPROFILE% is often C:\Users\YOUR_USERNAME and YOUR_USERNAME is your Windows account name. On Mac, you will need to right click the Overgrowth application and choose show package contents. It is then located in the Data folder found in the Contents/Mac OS folder.<br />
<br />
Change the following values to these new ones:<br />
<br />
<pre>screenwidth: 800<br />
screenheight: 600<br />
multisample: 4<br />
anisotropy: 4<br />
texture_reduce: 1</pre><br />
<br />
If it's still running slow, try this:<br />
<br />
<pre>screenwidth: 640<br />
screenheight: 480<br />
multisample: 0<br />
anisotropy: 0<br />
texture_reduce: 2</pre><br />
<br />
==I can't access all of the GUI. The window crops important parts of the screen. What do I do?==<br />
This turned up, when the default resolution was lowered from 1024x768 to 800x600. You can resolve this issue by changing the settings, either to a higher resolution or to full screen mode. Changing display settings is done in the 'config.txt'-file. <br />
You can find it on computer with Windows system at:<br />
C:\Documents and Settings\Username\My Documents\Wolfire\Overgrowth\Data\config.txt<br />
or a computer with Mac system at:<br />
/Users/Username/Library/Application Support/Lugaru 2/Data/config.txt<br />
<br />
The first lines of the default config file should look like this:<br />
<pre><br />
screenwidth: 800<br />
screenheight: 600<br />
fullscreen: false<br />
</pre><br />
You can change the resolution by changing the values for screenwidth/screenheight and go to fullscreen mode by changing the 'false' to 'true'.<br />
<br />
== How do I load a model into the game? ==<br />
You need to make sure that you're not loading the model file, but the object file.<br />
* A Model file is a 3d mesh saved as a *.obj file. this file contains no textures or shader data and so cannot be loaded by itself.<br />
* An Object file is an XML that stores the filepaths for all the relevant data of an object, including the Model file as well as the textures and shader.<br />
For example if you are trying to load a file located in Data/Models/example.obj you should really be opening Data/Objects/example.xml<br />
<br />
== How do I load my custom level in the main menu?==<br />
# Make sure that you typed the name correctly, including the *.xml ending<br />
# Make sure that it exists in Data/Levels/<br />
<br />
* Recently (as at alpha 65) there have been some issues with loading custom maps from the main menu. to make sure this isn't the case:<br />
# Back up the map 'DesertFort_IGF.xml' (for example add "backup" to the name)<br />
# Rename your map as 'DesertFort_IGF.xml'<br />
# Attempt to load it by clicking the Desert map in the main menu.<br />
<br />
== How do i clear my game cache? ==<br />
<br />
http://wiki.wolfire.com/index.php/How_to_clear_the_game%27s_cache<br />
<br />
=Common Platform-Specific Problems=<br />
==Windows==<br />
=== I get the following error on startup on Windows ===<br />
<br />
<pre>The application has failed to start because its side-by-side configuration is incorrect. Please see the application event<br />
log or use the command-line sxstrace.exe tool for more detail.</pre><br />
<br />
Please install the Visual Studio 2005 C++ runtime. You can get it from this URL:<br />
http://www.microsoft.com/downloads/details.aspx?familyid=200b2fd9-ae1a-4a14-984d-389c36f85647&displaylang=en<br />
<br />
===Error: cannot create the C:\program files\Overgrowth\Data\config.txt file. ... ===<br />
This error applies to both Lugaru and Overgrowth.<br />
<br />
Symptom: When attempting to edit the config.txt file the following error message is displayed:<br />
cannot create the C:\program files\Overgrowth\Data\config.txt file. Make sure the path and file name are correct.<br />
<br />
Explanation: Windows Vista & 7 like to save the config file in a different location to the actual directory. As discussed in a thread on the forums[http://forums.wolfire.com/viewtopic.php?f=7&t=4890&p=78033#p78033], The file is actually stored in: C:\Users\USERNAME\Application Data\Local Virtual Store\Program Files/Overgrowth/config.txt<br />
<br />
==Mac==<br />
===Where is the Data folder?===<br />
With the Mac version of Overgrowth, the Data folder is located within the application package.<br />
You can access it by right clicking the "Overgrowth" application and choosing 'Show Contents", and then browsing to Contents/MacOS/Data<br />
*Note - For some users, "Show Package Contents" may not appear in the right-click menu. A workaround should be posted as soon as a more Mac-savvy user edits this entry.<br />
<br />
To make future access easier right click 'Data' and choose 'Make Alias'. Now drag this alias out of the application, somewhere easy to find, on your Desktop for example.<br />
<br />
Then, next time you need to open a file from within the Overgrowth package, simply navigate to the alias and you should have access to the Contents of the Data folder.<br />
<br />
===It says on the forums/blog that you can right click with command+click, but it won't work!===<br />
Unfortunately in recent alphas this functionality has been broken.<br />
Right clicking is possible with an external mouse, or on a trackpad with enabled two-finger right click.<br />
<br />
Since alpha 67 you can set a keyboard button equivalent to right click. To do so find the "config.txt" file in the Data folder, and add a line for "key[rclick]" if it doesn't exist already. then set that equal to whatever button you want to act as right click.<br />
<br />
<br />
===I want to see live console output, but the console doesn't show it until after the program closes===<br />
If you want to see the console output live you will need to run Overgrowth from the Terminal.<br />
<br />
To do so right click the Overgrowth alpha, choose 'Show Package Contents', then navigate to /Contents/MacOS/ and double click 'lugaru2'. This will open Overgrowth along with a new terminal window that displays all the data written to the console but in real time.<br />
<br />
To make accessing this file easier in the future right click the 'lugaru 2' file, choose 'Make Alias' and drag the resulting file to a more convenient location.<br />
<br />
==Linux==<br />
===Running Overgrowth on Linux===<br />
Overgrowth's Linux port was introduced in Alpha Build 180. For installation instructions, see the [[Linux]] page.<br />
<br />
===Editting Settings===<br />
Overgrowth does not support changing your settings in game as of yet, so if you wish to do this you need to edit default configuration files. <br />
For more information, visit the [http://wiki.wolfire.com/index.php/How_to_modify_the_game%27s_configuration Modify Configurations] page.<br />
<br />
<br />
[[Category:FAQs]]<br />
[[Category:Overgrowth]]<br />
[[Category:SPF]]</div>Autious