glest-source/README.md
2018-09-17 17:40:22 -05:00

5.2 KiB

Build Status Coverity Scan Build Status

This is the game engine source code repository.

ZetaGlest is a fork of MegaGlest, a libre software cross platform real-time strategy game.

ZetaGlest is an entertaining free (freeware and free software) and open source cross-platform 3D real-time strategy (RTS) game, where you control the armies of one of eight different factions: Tech, Magic, Egypt, Indians, Norsemen, Persian, Elves or Romans. The game is played in one of 17 naturally looking settings, which, like the unit models, are crafted with great attention to detail. A lot of additional game data can be downloaded from within the game at no cost.

README Contents

System Requirements

Screenshots

Open games and Server list and player stats

Detailed information about units in the game

Stay Informed (Updates)

Why this fork? (Project Goals)

ZetaGlest forked from MegaGlest at v3.13.0-dev (12998eb)

Because we love MegaGlest! We wanted to take the project into a slightly different direction, and therefore we forked MegaGlest into the ZetaGlest project.

Download executable files

On Windows, the easiest way to get started is to download and run the installer. If you want to contribute with the code on Windows, please follow these instructions.

For other operating systems, you must [build and install from source](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md) (Later, we'll be providing binary packages).

(The ETA for the first official release can be viewed from the development milestone.)

Running

./zetaglest (if you didn't install)

OR

zetaglest (if you installed and the binary is in your PATH)

To run your own headless (dedicated) server:

Forward TCP ports 61357-61368
./zetaglest --headless-server-mode

To start a server and host a game:

Forward TCP ports 61357-61368
Enter the ZetaGlest lobby and click "Host Game"

Note

When serving a running game, a headless ZG server uses almost the same amount of computer resources as a running game. Therefore, it is recommended not to try connecting your ZG client to a headless server running on the same computer.

Extra Tech trees, mods, tilesets, scenarious (not yet available on the ZetaGlest server)

Contributing and Testing

If you'll be contributing code or changes to data, the procedures for forking and cloning are outlined in CONTRIBUTING.md

Please see CONTRIBUTING.md for extended, important instructions and guidelines for contributing.

Contact