Skip to content

Latest commit

 

History

History
166 lines (103 loc) · 7.38 KB

README.md

File metadata and controls

166 lines (103 loc) · 7.38 KB
Raw

helapordo

A roguelike terminal game.

Small personal project.

It uses ncurses to provide text interface.

Here's a gif of a new game being started.

Gif of game screen

Table of Contents

Latest Release

📦 v1.4.11 10/08/2024 I try to upload precompiled binaries for the ncurses build:

  • x86_64-Linux : download latest

  • aarch64-Linux (from Termux on Android).

  • x86_64-w64-mingw32 (JUST A DEMO. Any help with debugging the full game is welcome.) : download latest (Available = 1.4.8)

  • darwin-arm64 : download latest (Available = 1.4.10)

    • You should always check if the releases page has a newer build for you than the one linked here.

https://github.com/jgabaut/helapordo/releases

Building

The source code should build for:

  • x86_64-Linux
  • aarch64-Linux(see this section)
  • aarch64-apple-darwin
  • Windows (through x86_64-w64-mingw32)

DISCLAIMER: The Windows ncurses build is proof-of-concept as:

  • The gameplay loop is a simplified version of Rogue gamemode from the main build.
    • Work in progress on running the original gameloop.
  • Windows terminal can't change its color pairs as far as I know, rendering it unsuitable for the game.
    • A solution to reject extra/modified colors could be implemented.

Dependencies

  • autoconf and automake are needed to generate the Makefile used to compile the game.
  • ncurses-dev is needed as a library dependecy.
  • python3 is needed to generate ./src/palette.c and ./src/palette.h.

Initialising submodules

You can initialise the submodules by running:

`git submodule update --init`

Anvil

  • Some source files are expected to be generated at build time, by a symlink executable named anvil.

  • This dependency can be disabled entirely by running ./configure --enable-anvil=no

    • This can be useful when missing some of the required programs to bootstrap/use anvil.
    • See this section for info about generating the ./configure script in the first place.

  • By default, the configuration will pick an implementation for anvil depending on passed host:

    • darwin*: default is repo_invil. This means you need the Rust build toolchain to be installed.
    • linux*, mingw*: default is repo_amboso. This means you need bash >=4.x, and gawk.

  • To readily override the default implementation for anvil, you can pass --enable-anvilpick to the ./configure script: ./configure --enable-anvilpick This will ensure you get an interactive prompt to pick an implementation (and can still use the default one by pressing Enter without typing anything), whenever make needs to create ./anvil.

  • Needed programs, depending on chosen ANVIL_IMPL:

    • gawk is needed by amboso to generate ./src/anvil__helapordo.h.
      • bash >=4 is needed to run amboso.
      • Unfortunately, nawk and mawk are not compatible with amboso.
    • If you dont' have those, you can use invil to generate ./src/anvil__helapordo.h.
      • You will need cargo to build invil.
    • If you want to just build the code without ./src/anvil__helapordo.h., you can apply the patch file provided at this link.

Autoreconf and ./configure

You may need to run automake --add-missing to ensure your system provides the missing files needed by autoreconf.

Run autoreconf to generate the ./configure script. Run the script to generate the Makefile used for the project.

Enable game debug

After generating the ./configure script, you may enable game debug mode by running:

`./configure --enable-debug=yes`

Which should prepare a Makefile with the correct macro definitions to turn on game debug at compile time. To reset the Makefile to release state, run:

`./configure --enable-debug=no`

If you're compiling without using autotools, you may want to define the compiler macros:

  • -DHELAPORDO_DEBUG_LOG (Enables debug logging)
  • -DHELAPORDO_DEBUG_ACCESS (Enables the -d flag to turn on debug mode)
  • -DKLS_DEBUG_CORE (Enables debugging for Koliseo funcalls)

Build with x86_64-w64-mingw32

After generating the ./configure script, you may switch target host and use mingw32 with:

`./configure --host x86_64-w64-mingw32`

Which should prepare a Makefile with the correct macro definitions. To reset the Makefile to release state, run:

`./configure --host $(./config.guess)`

You may need to correct the configure.ac flags if your installation does not have the expected layout, providing the correct paths for:

  • mingw32's lib and include dirs, for ncursesw
  • mingw32's correct gcc.

Preprocessor macros based on the Makefile passing -DWINDOWS_BUILD are present to enable/disable Windows specific code.

Compiling and running

Once you have the Makefile, you can compile the project by running, in its directory:

`make`

The build chain expects some files to be generated from already given ones.

If you want to build without using make, you can see in the Makefile.am how to generate ./src/palette.c, ./src/palette.h, ./src/anvil__helapordo.c and ./src/anvil__helapordo.h

You can have a look at the CLI syntax with:

`./helapordo -h`

Installation

You can install the game at ~/helapordo-local and have a working alias for your PATH by running:

`make install`
`make do_alias`

The second command needs root privileges to symlink ~/helapordo-local/helapordo to /usr/local/bin/helapordo.

You can skip the alias and maybe add the helapordo-local dir to your PATH instead.

Documentation

HTML docs are available at this Github Pages link.

You can also get the ready pdf version of the docs from the latest release.

If you have doxygen installed you can generate the HTML yourself, or even the pdf if you have doxygen-latex or equivalents.

You if you have those packages, running make doc should give you ./docs/docs.pdf, just the pdf output from latex, and delete the doxygen folder by itself.