Skip to content
This repository has been archived by the owner on Feb 19, 2019. It is now read-only.

Latest commit

 

History

History
116 lines (77 loc) · 3.77 KB

INSTALL.md

File metadata and controls

116 lines (77 loc) · 3.77 KB
Raw

Installing ZetaGlest

It's recommended to first read about the system requirements. (even though they probably need editing and updating)

You can install from source or download Installers or packages for your operating system.

There hasn't been a formal first release of ZetaGlest yet, but you may try development snapshots.

Binary Packages

Note: Installation is not necessary to run the game. You can build the game from source and run it without installing

Windows

Linux, Mac OS, BSD

Review the dependency information and instructions for building from source.

From the top of the project source directory:

mkdir build
cd build

Note: Using the paths specified below, you will need super-user privileges when you run make install.

cmake On Linux or Mac OS

cmake .. -DCMAKE_INSTALL_PREFIX=/usr

cmake on BSD. Setting the 2 variables before the cmake command tells cmake to use the correct compiler.

CC=`which egcc` CXX=`which eg++` cmake .. -DCMAKE_INSTALL_PREFIX=/usr

Make and install the program:

make
make install

The binaries will be installed to CMAKE_INSTALL_PREFIX/games (i.e. /usr/games)

Before you run make, you can confirm the installation directories by entering cmake .. -LH. For example, These are the destination directories when -DCMAKE_INSTALL_PREFIX=/home/andy/local is used:

// The installation path for binaries
INSTALL_DIR_BIN:PATH=/home/andy/local/games

// The installation path for data files
INSTALL_DIR_DATA:PATH=/home/andy/local/share/zetaglest

// The installation path for desktop files
INSTALL_DIR_DESKTOP:PATH=/home/andy/local/applications

// The installation path for icon files
INSTALL_DIR_ICON:PATH=/home/andy/local/share/pixmaps

// The installation path for manpage files
INSTALL_DIR_MAN:PATH=/home/andy/local/share/man/man6

If you wish to install to a location that does not require super-user privileges, change '/usr' to a location to which you have write access.

See running for detailed information about running a server or hosting a game.

The value for INSTALL_DIR_DATA is written to the game when compiled, therefore if you ever move your data directory, you will have to recompile ZetaGlest.

After you run cmake for the first time, you won't need to specify any options unless you want to change previously-used options. Just use

cmake ..

(You'll need to run make and make install to rebuild.)

If you want to completely erase your previously-used options, remove build/CMakeCache.txt.

If your build doesn't seem to be using the options you gave it, first try removing CMakeCache.txt and rebuilding.

Note: The majority of the game data is not installed during the steps above. The files from the zetaglest-data repo must be copied into CMAKE_INSTALL_PREFIX/share/zetaglest, or specify an existing path to data by adding this option to cmake:

`-DINSTALL_DIR_DATA=<absolute-path-to-data>`

(data packages will be created soon -andy5995 2018-09-16)

Uninstalling

Makefiles generated with cmake do not have an 'uninstall' option. There is a discussion at this link on how to do that.

Instead of using make install, you may wish to install using a distribution package. Later, you could uninstall using your package manager.