git.y1.nz

docs/pages/01_getting_started.md

@page docs_getting_started Getting Started


Follow the steps in this section to start using GBDK-2020.

# 1. Download a Release and unzip it
You can get the latest releases from here: https://github.com/gbdk-2020/gbdk-2020/releases

@anchor windows_sdcc_non_c_drive_path_spaces
## Known Issue: Windows and folder names with spaces on non-C drives 
There is a known issue on Windows where sdcc will fail when run from folder names with spaces on non-C drives.

For the time being the workaround is as follows (with `D:\My Stuff\` as an example folder):
  - Run Windows Command as administrator
  - Run: `fsutil.exe 8dot3name query D:`
    - Output: The volume state is: 1 (8dot3 name creation is disabled). The registry state is: 2 (Per volume setting - the default). Based on the above settings, 8dot3 name creation is disabled on D:
  - Run: `fsutil 8dot3name set D: 0`
    - Output: Successfully enabled 8dot3name generation on D:
  - Run: `fsutil.exe 8dot3name query D:`
    - Output: The volume state is: 0 (8dot3 name creation is enabled). The registry state is: 2 (Per volume setting - the default). Based on the above settings, 8dot3 name creation is enabled on D:
  - Only folders created AFTER the setting has been enabled will get 8.3 filename support, renaming folders does NOT appear to generate 8.3 filename support. However it is possible to manually generate a short path name for an existing folder:
    - Run: `D:\>fsutil file setshortname "D:\My stuff" "mystuf~1"`


# 2. Compile Example projects
Make sure your GBDK-2020 installation is working correctly by compiling some of the included @ref docs_example_programs "example projects".

If everything works in the steps below and there are no errors reported then each project that was built should have its own .gb ROM file (or suitable extension for the other supported targets).

## Windows (without Make installed):
Navigate to a project within the example projects folder (`"examples\gb\"` under your GBDK-2020 install folder) and open a command line. Then type:

    compile

or

    compile.bat

This should build the example project. You can also navigate into other example project folders and build in the same way.


## Linux / macOS / Windows with Make installed:
Navigate to the example projects folder (`"examples/gb/"` under your GBDK-2020 install folder) and open a command line. Then type:

    make

This should build all of the examples sequentially. You can also navigate into an individual example project's folder and build it by typing `make`.

@anchor macos_unsigned_security_workaround
### macOS security warnings
If you get a security warning on macOS that says ("`... developer cannot be verified, macOS cannot verify that this app is free from malware`"), it does not mean that GBDK is malware. It just means the GBDK toolchain binaries are not signed by Apple, so it won't run them without an additional step.

You will need to unquarrantine the files in the bin folder in order to run them. This can be fixed using the following steps.

Open a terminal and navigate to the gbdk bin folder (`"bin/"` under your GBDK-2020 install folder). Then type:

    xattr -d com.apple.quarantine *



# 3. Use a Template
__To create a new project use a template!__ 

There are template projects included in the @ref docs_example_programs "GBDK example projects" to help you get up and running. Their folder names start with `template_`.

1. Copy one of the template folders to a new folder name.

2. If you moved the folder out of the GBDK examples then you __must__ update the `GBDK` path variable and/or the path to `LCC` in the `Makefile` or `compile.bat` so that it will still build correctly.

3. Type `make` on the command line in that folder to verify it still builds.

4. Open main.c to start making changes.


# 4. If you use GBTD / GBMB, get the fixed version
If you plan to use GBTD / GBMB for making graphics, make sure to get the version with the `const` fix and other improvements. See @ref const_gbtd_gbmb.


# 5. Review Coding Guidelines
Take a look at the @ref docs_coding_guidelines "coding guidelines", even if you have experience writing software for other platforms. There is important information to help you get good results and performance on the Game Boy.

If you haven't written programs in C before, check the @ref docs_c_tutorials "C tutorials section".


# 6. Hardware and Resources
If you have a specific project in mind, consider what hardware you want to target. It isn't something that has to be decided up front, but it can influence design and implementation.

What size will your game or program be?
  - 32K Cart (no-MBC required)
  - Larger than 32K (MBC required)
  - See more details about @ref docs_rombanking_mbcs "ROM Banking and MBCs"

What console platform(s) will it run on?
  - Game Boy (GB/GBC)
  - Analogue Pocket (AP)
  - Sega Master System (SMS)
  - Game Gear (GG)
  - Mega Duck (DUCK)
  - See @ref docs_supported_consoles

If targeting the Game Boy, what hardware will it run on?
  - Game Boy (& Game Boy Color)
  - Game Boy Color only
  - Game Boy & Super Game Boy
  - See how to @ref faq_gb_type_header_setting "set the compatibility type in the cartridge header". Read more about hardware differences in the @ref Pandocs


# 7. Set up C Source debugging
Tracking down problems in code is easier with a debugger. Emulicious has a @ref Emulicious_debug "debug adapter" that provides C source debugging with GBDK-2020.


# 8. Try a GBDK Tutorial
You might want to start off with a guided GBDK tutorial from the @ref links_gbdk_tutorials "GBDK Tutorials section".

  - __Note:__ Tutorials (or parts of them) may be based on the older GBDK from the 2000's before it was updated to be GBDK-2020. The general principles are all the same, but the setup and parts of the @ref docs_toolchain "toolchain" (compiler/etc) may be somewhat different and some links may be outdated (pointing to the old GBDK or old tools).


# 9. Read up!
- It is strongly encouraged to read more @ref docs_index "GBDK-2020 General Documentation".
- Learn about the Game Boy hardware by reading through the @ref Pandocs technical reference.


# 10. Need help?
Check out the links for @ref links_help_and_community "online community and support" and read the @ref docs_faq "FAQ".



# Migrating From Pre-GBDK-2020 Tutorials
Several popular GBDK Tutorials, Videos and How-to's were made before GBDK-2020 was available, as a result some information they include is outdated or incompatible. The following summarizes changes that should be made for best results.

## Also see: 
- @ref docs_migrating_versions
- @ref docs_coding_guidelines
- @ref docs_getting_started (the section above this)

## Use auto-banking
GBDK-2020 now supports auto-banking (@ref rom_autobanking). In most cases using auto-banking will be easier and less error prone than manually assigning source and assets to banks.
- There is a source example `banks_autobank` project.

## Non-standard types (UINT8, etc)
The old GBDK types `UINT8`, `INT8`, `UINT16`, `INT16` are non-standard and less portable.

The following should be used instead: `uint8_t`, `int16_t`, `uint16_t`, `int32_t`, `uint32_t` and `bool`.

These are standard types defined in `stdint.h` (`#include <stdint.h>`) and `stdbool.h` (`#include <stdbool.h>`).

## If using GBTD / GBMB, get the fixed version
If you plan to use GBTD / GBMB for making graphics, make sure to get the version with the `const` fix and other improvements. See @ref const_gbtd_gbmb.

## LCC and SDCC flags that are not needed
The following flag is no longer needed with @ref lcc and @ref sdcc, it can be removed without any loss of performance.
- `-DUSE_SFR`
   - Behavior formerly enabled by USE_SFR_FOR_REG is on by default now (no need to specify it, it isn't a tested `#ifdef` anymore). Check here why: https://gbdev.gg8.se/forums/viewtopic.php?id=697

## ROM Header Settings (such as Color, SGB, etc)
Setting ROM bytes directly with `-Wl-yp0x<address>=0x<value>` is no longer supported. Instead use @ref makebin flags. For example, use `-Wm-yC` instead of `-Wl-yp0x143=0xC0`. See @ref faq_gb_type_header_setting.

## GBDK Header include changes
The following header files which are now cross platform were moved from `gb/` to `gbdk/`: `bcd.h`, `console.h`, `far_ptr.h`, `font.h`, `gbdecompress.h`, `gbdk-lib.h`, `incbin.h`, `metasprites.h`, `platform.h`, `version.h`
- When including them use `#include <gbdk/...>` instead of `#include <gb/>`

## Include .h headers, not .c source files
Do not `#include` `.c` source files into other `.c` source files. Instead create `.h` header files for them and include those.
- https://www.tutorialspoint.com/cprogramming/c_header_files.htm

## Use the Template Projects
Modern project templates are included with GBDK-2020. Using them (and their Makefile or compile.bat) as a starting point for projects is recommended and can help ensure better default settings and project organization.

## Use hUGEtracker instead of gbt_player
hUGEtracker and its driver @ref hUGEdriver are smaller, more efficient and more versatile than gbt_player.
    

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.