Astonishingly fast Amstrad CPC game engine for C and Assembler developers.
We give big thanks to all users, contributors and supporters, and all respects to our incredible Donors.
|CPCtelera Reference Manual|
|Welcome to CPCtelera!||If you want to create games for Amstrad CPC, you are at the right place.|
|Donors||We are incredibly grateful to these people, who sent us some economic support to continue with CPCtelera and other CPC-related projects.|
|Supporting CPCtelera||We, as authors of CPCtelera, have started this journey to create a usable, free, convenient and up-to-date game engine.|
|Installing CPCtelera||CPCtelera works under Windows, Linux and OSX.|
|Downloading CPCtelera||You can download CPCtelera from these sources|
|Software Requirements||In order to install CPCtelera, your system will require previous software.|
|Installing CPCtelera in your system||These are the steps to install CPCtelera in your system|
|Starting with CPCtelera||Once setup.sh completes without errors, CPCtelera will be ready to use.|
|Advice for Assembly coders||Just a few comments for those wanting to program in Assembly with CPCtelera.|
|Screenshots||Let’s have a quick look at some things that CPCtelera can do.|
If you want to create games for Amstrad CPC, you are at the right place. Welcome to CPCtelera!
And, of course, CPCtelera comes with a complete API documentation and lots of well documented examples for you to quickly and easily learn it!
All these features included in a single bundle for you to download and use, free and under LGPL v3.0. License. You have all source code available for you to analyse, explore, improve and distribute!
We are incredibly grateful to these people, who sent us some economic support to continue with CPCtelera and other CPC-related projects. Big most sincere thanks and respects to all of you,
|10/06/2015||Tim Riemann / Octoate|
|21/04/2016||Oscar Martínez Gómez|
We, as authors of CPCtelera, have started this journey to create a usable, free, convenient and up-to-date game engine. There are lots of things to do and improve in order to achieve our goals. If you want to help us, we are more than happy. Any kind of help is always welcome, but we prefer any of these ways,
Any donation to our team will be used either in hardware / software to support this project, or as an aid for other Amstrad CPC related projects we manage (such us, for instance, #CPCRetroDev anual contest!)
CPCtelera works under Windows, Linux and OSX. It has been tested in Windows XP, 7, 8 and 10, and in Ubuntu / Debian, Arch, Manjaro, Elementary OS and Raspbian Linux distributions. It works either on Intel architectures or on ARM’s.
You can download CPCtelera from these sources
git clone https://github.com/lronaldo/cpctelera
In order to install CPCtelera, your system will require previous software. Check your system and install it before launching setup.sh.
Install these packages on your Linux distribution. Although they are pretty standard, names may slightly vary on some distributions.
On Raspbian and other ARM Linux OSes, the package texinfo is often required. We recommend you to install it beforehand. If your compilation fails, it may be due this package lacking in your system.
Under Windows Cygwin is required for CPCtelera to work. You may download Cygwin 32 / 64 and install it along with these packages (you may launch cygwin’s setup.exe at any time to install them),
Windows users have reported some common issues installing CPCtelera. Please, have a look at this list if you have any problem,
If you experience any diffenrent problem with Windows/Cygwin, please report to us so that we can include it in this list.
|1.||Install XCode if you didn’t have it.|
|2.||Install Homebrew if you didn’t have it.|
|3.||Open a terminal and install XCode Command Line tools with this command,|
|4.||Install libboost and freeimage from homebrew with these commands,|
brew install boost freeimage
|5.||Optionally, install recommended packages, that some tools included with CPCtelera may require|
brew install wine wget
Some things to take into account on OSX,
These are the steps to install CPCtelera in your system
|1.||Install required Software Requirements|
|2.||Download and unzip current stable version 1.4. of CPCtelera (read “some considerations” below)|
|3.||Open a terminal an enter cpctelera/ folder.|
|5.||Once setup.sh finishes, close your terminal and open a new one for changes to be set.|
CPCtelera is ready to be used in your system.
Once setup.sh completes without errors, CPCtelera will be ready to use. To have a quick glance about what CPCtelera offers, you may enter examples/ folder and check all the examples included. You can build any one of them just by typing make inside the example folder, then CDT and DSK files will be automatically generated.
For creating your own projects, CPCtelera includes the cpct_mkproject command line tool. setup.sh configures your system’s $PATH variable so that you have direct access to cpct_mkproject anywhere on your system (you should close and open your terminal again after setup.sh finishes). Creating a new project is as easy as typing this
The rest is up to you. Navigate this reference manual, grasp code from examples and start your own projects. All of us are waiting to see your new games! :D
Just a few comments for those wanting to program in Assembly with CPCtelera. Most of the assemblers available out there use MAXAM assembly syntax, and most assembly code out there is coded this way. CPCtelera uses SDCC, which comes with ASZ80 integrated as assembler. ASZ80 has its own syntax and directives which are different to MAXAM’s. Take this into account when porting code to CPCtelera or when analyzing CPCtelera’s own code.
ASZ80 is developed by Alan R. Baldwin, and hast a good and detailed documentation for ASZ80 assembly syntax online. Check it to port your programs from MAXAM’s to CPCtelera.
CPCtelera lets you add assembly files to your projects by using the extension .s. Any .s file that you include in the src/ folder of your project (or any first-level subfolder) will be automatically detected and compiled by the default Makefile.
Let’s have a quick look at some things that CPCtelera can do.