Skip to content

pikkpoiss/twodee-support

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

twodee-support

Support files / scripts for twodee

Supported platforms

This library has been tested by developing games for:

  • OSX 10.10 Yosemite using x86_64 CPUs.
  • Windows 8.1 using x86_64 CPUs.

It should support:

  • Linux variants using x86_64 CPUs.

Other versions may work but have not been tested. 32-bit CPUs are not supported.

Requirements

Setup

This project sets up your environment to build and package twodee programs correctly.

To run the support scripts you must check out the library:

git clone https://github.com/pikkpoiss/twodee-support.git
cd twodee-support

This library depends on various C/C++ packages. To try and get a stable environment for building, sources have been included in the lib directory. Running the following will build each package and attempt to install a Golang wrapper:

./scripts/setup.sh

On Windows this will build shared libraries in .dll format and install them to build/usr/bin. These DLLs must be included next to a packaged executable in order for the built application to be portable.

On OSX this will build static libraries in .a format and install them to build/usr/lib. Packaged executables linked against these libraries should be portable without needing to package any shared libraries.

You can build a completely clean copy using:

CLEAN=1 ./scripts/setup.sh

Using

All go libs needed to run twodee projects have been installed to twodee-support/build/usr/gocode, including the twodee lib.

In order to use the correct paths for running your code, you must run the following in your shell environment first:

source <PATH_TO>/twodee-support/scripts/env.sh

Quick library use

You can import

github.com/pikkpoiss/twodee

In your projects if you don't need to have write access to twodee. This will make your code work quickly but will be harder to build packages for.

Initializing a new twodee project

Once you have the libraries installed, run:

./scripts/setup_project.sh PATH_TO_PROJECT_DIRECTORY

This will set up a project structure, install support scripts, and copy shared libraries if needed.

Once the project is set up, commit the files to git as needed and push to origin.

If you rebuild the twodee libs, run the setup_project.sh script again. Be careful though, as it will overwrite any modifications.

Include the twodee library by including the following path in your Go code:

"../lib/twodee"

Checking out the project

Other developers will need to follow the steps to set up the twodee library before checking out the other project. Once that is complete, they must check out the project from git and run the following from the project root:

git submodule init
git submodule update

Running the project

Run the project with the following command:

make run

Packaging the project

Build a distributable bundle with:

make package

This will place a zip file in the build/PLATFORM directory with a bundled executable.

About

Support files / scripts for twodee

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published