Return to BUILD.md CVS log

Up to [contributed] / brogue-ce

Annotation of brogue-ce/BUILD.md, Revision 1.1

1.1     ! rubenllo    1: Building Brogue CE
        !             2: ==================
        !             3:
        !             4: You need these things to compile the game:
        !             5:
        !             6: - a C compiler (Clang or GCC)
        !             7: - Make
        !             8: - anything extra listed in `config.mk` that you require
        !             9:
        !            10: Once you have those, the game is built by running `make`. You can configure
        !            11: the build by editing `config.mk` or appending options to the Make command,
        !            12: e.g. `make TERMINAL=YES`.
        !            13:
        !            14: More specific instructions follow on how to acquire the dependencies and
        !            15: build the game.
        !            16:
        !            17:
        !            18: Windows
        !            19: -------
        !            20:
        !            21: There are many ways to compile software on Windows. The method here was
        !            22: tested by the author and is relatively simple.
        !            23:
        !            24: ### Setting up
        !            25:
        !            26: 1. Install [MSYS2][1] for x86_64. Refer to [its wiki][2] for essential info
        !            27: on how to use it.
        !            28:
        !            29: 2. (Installing the dependencies) Open the MSYS2 shell and run the following:
        !            30:
        !            31:     ```
        !            32:     pacman -S make mingw-w64-x86_64-{gcc,SDL2,SDL2_image}
        !            33:     ```
        !            34:
        !            35: ### Building
        !            36:
        !            37: 1. (Compiling the game) Open the Mingw64 shell. Navigate to the Brogue CE
        !            38: directory (the one containing this file; your Windows drives can be accessed
        !            39: at `/c`, `/d` etc.) and run
        !            40:
        !            41:     ```
        !            42:     make bin/brogue.exe
        !            43:     ```
        !            44:
        !            45: 2. Optional: You can now run the game by running `cd bin; ./brogue.exe`.
        !            46: However if you want to be able to run it from outside the Mingw64 shell,
        !            47: you'll need to add the `/mingw64/bin` directory of MSYS2 to your system
        !            48: PATH. By default this is at `C:\msys2\mingw64\bin`. Some info is here:
        !            49: [How do I set or change the PATH system variable?][3] You only need to
        !            50: perform this step once.
        !            51:
        !            52:
        !            53: Mac
        !            54: ---
        !            55:
        !            56: These instructions are intended for developers and testers, as this will
        !            57: not create an App. You will have to run the game with the `./brogue` script,
        !            58: just like for the Linux version.
        !            59:
        !            60: ### Setting up
        !            61:
        !            62: 1. Install the [Homebrew package manager][4].
        !            63:
        !            64: 2. Install the dependencies:
        !            65:
        !            66:     ```
        !            67:     brew install sdl2 sdl2_image
        !            68:     ```
        !            69:
        !            70: ### Building
        !            71:
        !            72: 1. Navigate to the Brogue CE directory (the one containing this file) and run:
        !            73:
        !            74:     ```
        !            75:     make bin/brogue
        !            76:     ```
        !            77:
        !            78: Linux
        !            79: -----
        !            80:
        !            81: These instructions are for the graphical version only.
        !            82:
        !            83: ### Setting up
        !            84:
        !            85: 1. Install the dependencies; for example, on Debian/Ubuntu, run
        !            86:
        !            87:     ```
        !            88:     sudo apt install make gcc libsdl2-2.0-0 libsdl2-dev libsdl2-image-2.0-0 libsdl2-image-dev
        !            89:     ```
        !            90:
        !            91: ### Building
        !            92:
        !            93: 1. Navigate to where this file is and run
        !            94:
        !            95:     ```
        !            96:     make bin/brogue
        !            97:     ```
        !            98:
        !            99:
        !           100: [1]: https://www.msys2.org/
        !           101: [2]: https://github.com/msys2/msys2/wiki
        !           102: [3]: https://www.java.com/en/download/help/path.xml
        !           103: [4]: https://brew.sh/