{{htmlmetatags>metatag-robots=()
metatag-title=(Installation | ugBASIC User Manual)
metatag-keywords=(ugBASIC,Commodore 64,Commodore PLUS/4,ZX Spectrum)
metatag-description=(Installation of ugBASIC)
metatag-media-og:image=(:ugbasic:logo-ugbasic-fb.png)
metatag-og:title=(Installation | ugBASIC User Manual) 
metatag-og:description=(Installation of ugBASIC)
}}

====== ugBASIC User Manual ======

===== Installation =====

==== Prerequisites ====

[[https://spotlessmind1975.itch.io/ugbasic-ide|{{ :ugbasic:ugbasic-ide-itchio3.png?nolink&400 |}}]] 
The **ugBASIC** compiler is a console application for Linux and Microsoft Windows operating system. A [[https://spotlessmind1975.itch.io/ugbasic-ide|convenient IDE environment]] is also available for Microsoft Windows operating system, which downloads and installs all dependencies. If you are using this operating system we recommend that you download and use it.

So, the compiler depends on different software in order to obtain an executable for the various targets (make sure you have the latest version):

  * Atari 400/800 (''atari''), Atari 1200XL (''atarixl''), Atari 600XL/800XL (''atarixl''), Atari XE Video Game System (''atarixl''), Commodore 128 (''c128''), Commodore 64 (''c64''), Commodore PLUS/4 (''plus4''), Commodore VIC-20 (''vic20'')
    * ''cl65'', an assembler / linker from [[https://www.cc65.org/|CC65]];
  * Dragon 32 (''d32''), Dragon 64 (''d64''), Dragon 200-E (''d64''), Olivetti PC128 Prodest (''pc128op''), Thomson (''mo5''), TRS-80 Color computer (''coco'')
    * ''asm6809'', an assembler / linker from [[https://www.6809.org.uk/asm6809/|6809.ORG]];
  * Amstrad CPC (''cpc''), ColecoVision (''coleco''), MSX (''msx1''), SEGA SC-3000 (''sc3000''), SEGA SG-1000 (''sg1000''), ZX Spectrum 48K (''zx'')
    * ''z88dk-z80asm'', an assembler / linker from [[https://z88dk.org/site/|Z88DK]];
    * ''z88dk-appmake'', an utility from [[https://z88dk.org/site/|Z88DK]];

So you need to download them from their website and make sure that you can launch them from any directory on your console. [[https://github.com/spotlessmind1975/ugbasic/tree/main/modules|There is a reference]] to the github repositories for each of these tools in the ugBASIC source, in case the latest version doesn't work.

==== Download precompiled ====

You will find all binaries under the [[https://github.com/spotlessmind1975/ugbasic/releases/latest|latest release]]. Each target has its compiler, and each compiler will run under Linux or Microsoft Windows. All of them are compiled for 64-bit processors. If you need the 32 bit version, you have to download sources and recompile the compiler from that.

If you downloaded binary please move to **[[ugbasic:usage|usage section]]**.

==== Download sources ====

You can download as a ZIP or clone the latest version directly from [[https://github.com/spotlessmind1975/ugbasic|github]], by clicking the the **Code** button. If you download the zip file, you must extract all the files before continuing. In order to compile the compiler, you need the following software installed:

  * ''gcc'' for GCC v10.3.0
  * ''xxd''
  * ''flex'' for GNU FLEX v2.6.4
  * ''bison'' for GNU BISON v3.7

Moreover, you have to download / init all submodules, as well, by executing the following command:

    git submodule update --recursive --init --remote

If something goes wrong, use this alternate command line:

    git config core.protectNTFS false
    cd modules/6502
    git config core.protectNTFS false
    cd ../..
    git submodule update --force --recursive --init --remote


==== Recompile the compiler ====

In order to compile the compiler you have to use the ''make'' command:

   make target=xxxx clean compiler

Where ''xxxx'' is one of the targets given above. 
The compiler will be placed under the ''ugbc/exe'' path.

If you recompiled the compiler, please move to **[[ugbasic:usage|usage section]]**.

===== POWERED BY =====

[[https://ugbasic.iwashere.eu|{{ :ugbasic:user:logo-ugbasic.png?nolink&600 |}}]]