scons-tool-bennugd 1.0.0

SCons tool to build BennuGD project

scons-tool-bennugd

SCons tool to build BennuGD projects.

Installation

There are a few ways to install this tool for your SCons project.

From pypi

This method may be preferable if you build your project under a virtualenv. To add a scons-tool-bennugd from pypi, type (within your virtualenv):

pip install scons-tool-bennugd

Or, if your project uses pipenv:

pipenv install --dev scons-tool-bennugd

Alternatively, you may add this to your Pipfile:

[dev-packages]
scons-tool-bennugd = "*"

The tool will be installed as a namespaced package sconstool.bennugd in the project's virtual environment.

As a git submodule

In your git repository, add the scons-tool-bennugd as a submodule:

git submodule add git://bitbucket.org/dacucar/scons-tool-bennugd.git

Manually downloading dcbc module

Download the dcbc tool module into the site_scons/site_tools.

mkdir -p site_scons/site_tools
curl https://bitbucket.org/dacucar/scons-tool-bennugd/raw/HEAD/sconstool/bennugd/dcbc.py -o site_scons/site_tools/dcbc.py 

Usage example

First, create your game sources:

game/
│
└───lib/
│   │   lib.prg
|   |   lib.h
│
└───game/
│   │   game.prg
│   │   game_part_1.prg
|   |   ...
│
└───tool/
    │   tool.prg
    │   tool_part_1.prg
    |   ...

In this example, tool and game depend on lib. Also game_part_1.prg is included in game.prg and tool_part_1.prg is included in tool.prg.

Then, write SConstruct file.

# SConstruct
env = Environment(
	# We need to tell scons how to find the tool package...
	# ...if you installed it with pip/pipenv use
	toolpath = [PyPackageDir('sconstool.bennugd')],
	# ... OR if you installed it as a git submodule
	# toolpath = ['scons-tool-bennugd/sconstool/bennugd']
	# ... OR if you downloaded the dcbc.py into site_scons/site_tools, then there is no need to specify toolpath

	tools = ['default', 'dcbc'],
	DCBC = '/path/to/bgdc'
	)

env.Dcl('lib', 'lib/lib')
env.Dcb('game', 'game/game', DCBCLIBS='lib/lib')
env.Dcb('tool', 'game/tool', DCBCLIBS='lib/lib')

Finally, try it out.

To build all targets:

scons

To clean:

scons -c

To build only game target:

scons game

SCons is a very feature rich build-system and highly customizable. Make sure to read the documentation if you want to know what else you can do.

It can also be used with PixTudio!

Instead of specifying path to bgdc, we can specify a path to pxtb.

env = Environment(
	toolpath = [PyPackageDir('sconstool.bennugd')],
	tools = ['default', 'dcbc'],
	DCBC = '/path/to/pxtb'
	)

Supported Options

The following options are accepted by the Dcl and the Dcb builders:

Variable	Default	Description
DCBC	"bgdc"	DCB compiler.
DCBCFLAGS	""	Additional compilation flags.
DCBCMACROS	{}	Additional compilation macros, expressed as a dictionary.
DCBCPATH	[]	Additional paths where the compiler shall search for files.
DCBCFILES	[]	A list of files that shall be added to the dcb.
DCBCLIBS	[]	A list of libraries that shall be included by the compiler.
DCBCLIBEXTENSION	".dcl"	The extension used when compiling in libmode.