Skip to content

Latest commit

 

History

History
100 lines (73 loc) · 5.86 KB

README.md

File metadata and controls

100 lines (73 loc) · 5.86 KB
Raw

Epicinium

Epicinium is a multiplayer strategy game with simultaneous turns where nature is a finite resource, available for Windows, Mac and Linux.

Epicinium was released on October 12th, 2020 as a free game on Steam and itch.io. In this repository, the full source code (excluding proprietary Steam integrations) is made available under the AGPL-3.0 License.

Epicinium is being developed by A Bunch of Hacks, a worker cooperative for video game and software development from the Netherlands. Contact us at info@epicinium.nl.

Support

Epicinium is and will remain free software. If you wish to support Epicinium and A Bunch of Hacks, you have the option to name-your-own-price or buy the game's soundtrack.

Contents

  • src/ contains Epicinium's source files
  • libs/ contains header files for included dependencies
  • docs/ contains attribution and license files
  • archive/ contains sets of precompiled shared libraries (64-bit, as well as deprecated 32-bit)
  • translations/ contains translation files populated by the Epicinium community translation project

External dependencies

Locating the assets

In order to run the game, you must acquire a valid copy of Epicinium's assets.

The preferred way is to clone the Epicinium-assets repository. Note that the assets in the Epicinium-assets repository have their own license, separate from that of the source code (this repository). Epicinum-assets does not come with any fonts, so you will need to download a suitable font separately, such as GNU Unifont. Again note that fonts have their own separate licenses.

If you don't intend to modify the assets, you can also use a copy of the game downloaded from Steam or itch.io for this purpose. If for example you are on Windows and you have previously installed Epicinium through Steam, the assets might be stored here:

C:\Program Files (x86)\Steam\steamapps\common\Epicinium

On Mac, the assets are stored inside the application bundle:

[...]/epicinium.app/Contents/Resources

However you cannot redistribute assets that came with the game to anyone other than yourself, as they do not come with a license. Also beware that running anything other than the steps from Getting started below may overwrite and thus corrupt the assets.

Getting started (Windows)

  1. Open this project in Visual Studio.
  2. Right-click CMakeLists.txt in the Visual Studio's Solution Explorer and select "Add Debug Configuration". This opens a file called launch.vs.json. Change or add the fields "projectTarget", "name" and "args" as below:
{
  "version": "0.2.1",
  "defaults": {},
  "configurations": [
    {
        "type": "default",
        "project": "CMakeLists.txt",
        "projectTarget": "game.exe (bin\\game.exe)",
        "name": "game.exe (bin\\game.exe)",
        "args": [
            "--font-filename=\"C:\\PATH\\TO\\FONT\"",
            "--resource-root=\"C:\\PATH\\TO\\RESOURCES\""
        ]
    }
  ]
}
  1. Replace C:\\PATH\\TO\\RESOURCES to a folder containing Epicinium's assets (see Locating the assets above).
  2. Replace C:\\PATH\\TO\\FONT to the path of a TTF font file. If using assets downloaded from Steam or itch.io, you may instead remove that line altogether, which causes the font included with the assets to be used.
  3. Compile and run the target named "game.exe" from within Visual Studio.

Getting started (Mac or Linux)

  1. Create settings.json by copying settings.template.json, leaving "config-root" as is.
  2. Edit settings.json so that "resource-root" is set to a folder containing Epicinium's assets (see Locating the assets above).
  3. Edit settings.json so that "font-filename" is set to the path of a TTF font file. If using assets downloaded from Steam or itch.io, you may instead remove the setting from settings.json altogether, which causes the font included with the assets to be used.
  4. Compile the game with make.
  5. Run the resulting launcher: ./epicinium.

License

Epicinium was created by A Bunch of Hacks. It is made available to you under the AGPL-3.0 License, as specified in LICENSE.txt.

Epicinium is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License (AGPL) as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

Epicinium is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

Related repositories

  • Epicinium documentation, which includes a wiki and a tutorial for Epicinium
  • Epicinium assets, assets for Epicinium including audio, sprites, maps, rulesets and other resources
  • epicinium_server.rs, an asynchronous multiplayer server for Epicinium, written in Rust
  • Epicinium-NeuralNewt, a libtorch framework for training neural networks to play Epicinium via NeuralNewt, a parameterized decision tree AI, with evolutionary training techniques