Directory Structure

Directories

After you run GoGo for the first time in a new project folder, the following directories will exist:

bin: Contains executable files necessary for running GoGo and building your project.

build: A temporary directory containing intermediate build files. You should not include this in any code repositories.

data: Place any non-image, non-sound data resources in this folder. They will be automatically with your project during the build process. Create a DataFile object to read in the contents of a data resource. Any data files in the subdirectory "data/windows" will only be included when building for Windows; any data files in the subdirectory "data/not-windows" will only be included if NOT building for Windows. In either case, the contained files are placed in the parent data directory; "windows" or "not-windows" is not present in the path. The same holds true for "mac", "android", "iphone", and "not-" versions of those names. For more help on datafiles, type "gogo doc DataFile".

dist: Contains the build products - the final executables for some platforms (Android and iPhone live in their own subdirectories). You should not include this in any code repositories.

images: Contains PNG and JPG images that are bundled with the app during the build. They are automatically compiled into image sheets for fast loading and drawing. See the Images section for more information.

libraries: "libraries/slag" contains libraries written in Slag and usable directly by your app, while "libraries/native" contains libraries needed to compile the native layer. If you only install the precompiled Windows or Mac platform modules, libraries/native will not exist.

platforms: Any Windows-specific files are in "platforms/windows" and so on. Depending on what platform modules you have installed, this may include source code or just precompiled binaries.

sounds: Contains WAV and files of other sound formats that are bundled with the app during the build and may be loaded as Sound objects. May contain platform-specific subdirectories as described under data, above. Custom sound formats vary per-platform. Recommended sound types include WAV and MP3 for any platform, OGG for Windows, and M4A for iPhone/iPad/Mac/Android.

src: Contains Slag source code for your project. Add other Slag files here as desired.

upgrade: The upgrade system places files here to be copied into the main project directory the next time GoGo is run. You can also manually place the "new_project" folder of a different Plasmacore version in this directory to see it installed.

Other notable files include:

build.slag: A customizable build file that may be used to add extra GoGo actions (aka targets). This file is created if it doesn't exist, but otherwise upgrading your project will not overwrite this file.

build_core.slag: The primary GoGo build file. This is replaced during Plasmacore upgrades and so it should not be directly modified.

gogo, gogo.bat: Script/batch files that are used to launch GoGo on your operating system.

local.properties: Contains paths and settings relative to your current workstation. This file should not be included in code repositories.

manifest.txt: The text file that GoGo uses to keep track of which modules have been installed.