FreeCraft is a free open-source voxel game engine with easy modding and game creation.

FreeCraft Engine is a modificated version of Minetest engine, used for extra content under the FreeCraft game.

Copyright (C):
2010-2022 Perttu Ahola [email protected] (Minetest creator)
2022-2023 KanuX-14 [email protected] (FreeCraft creator)
and contributors (see source file comments and the version control log)

If you downloaded the FreeCraft Engine source code in which this file is contained, you probably want to download the FreeCraft game project too. See its README.txt for more information.

1. Further Documentation
2. Default Controls
3. Paths
4. Configuration File
5. Command-line Options
6. Compiling
7. Docker
8. Version Scheme

• Website: Here.
• Wiki: https://wiki.minetest.net/
• Developer wiki: https://dev.minetest.net/
• Forum: https://forum.minetest.net/
• GitLab: https://gitlab.com/KanuX/freecraft/ (GitHub)
• doc/ directory of source distribution

All controls are re-bindable using settings. Some can be changed in the key config dialog in the settings tab.

Locations:

• bin - Compiled binaries
• share - Distributed read-only data
• user - User-created modifiable data

Where each location is on each platform:

• Windows .zip / RUN_IN_PLACE source:
  • bin = bin
  • share = .
  • user = .
• Windows installed:
  • bin = C:\Program Files\FreeCraft\bin (Depends on the install location)
  • share = C:\Program Files\FreeCraft (Depends on the install location)
  • user = %APPDATA%\FreeCraft or %FREECRAFT_USER_PATH%
• Linux installed:
  • bin = /usr/bin
  • share = /usr/share/freecraft
  • user = ~/.freecraft or $FREECRAFT_USER_PATH
• macOS:
  • bin = Contents/MacOS
  • share = Contents/Resources
  • user = Contents/User or ~/Library/Application Support/freecraft or $FREECRAFT_USER_PATH

Worlds can be found as separate folders in: user/worlds/

• Default location: user/freecraft.conf
• This file is created by closing FreeCraft for the first time.
• A specific file can be specified on the command line: --config <path-to-file>
• A run-in-place build will look for the configuration file in location_of_exe/../freecraft.conf and also location_of_exe/../../freecraft.conf

• Use --help

This section got separated into pieces, as it was filling the entire repository space.
It can be accessed here.

• Developing freecraftserver with Docker

We provide FreeCraft server Docker images using the GitLab mirror registry.

Images are built on each commit and available using the following tag scheme:

• registry.gitlab.com/KanuX/freecraft/server:latest (latest build)
• registry.gitlab.com/KanuX/freecraft/server:<branch/tag> (current branch or current tag)
• registry.gitlab.com/KanuX/freecraft/server:<commit-id> (current commit id)

As root:

If you want to test it on a Docker server you can easily run:

docker run registry.gitlab.com/KanuX/freecraft/server:<docker tag>

If you want to use it in a production environment you should use volumes bound to the Docker host to persist data and modify the configuration:

docker create -v /home/freecraft/data/:/var/lib/freecraft/ -v /home/freecraft/conf/:/etc/freecraft/ registry.gitlab.com/KanuX/freecraft/server:master

Data will be written to /home/freecraft/data on the host, and configuration will be read from /home/freecraft/conf/freecraft.conf.

Note: If you don't understand the previous commands please read the official Docker documentation before use.

You can also host your FreeCraft server inside a Kubernetes cluster. See our example implementation in misc/kubernetes.yml.

We use major.minor.patch.

• Major is incremented when the release contains breaking changes, all other numbers are set to 0.
• Minor is incremented when the release contains new non-breaking features, patch is set to 0.
• Patch is incremented when the release only contains bug-fixes and very minor/trivial features considered necessary.

The dev notation refers to the unstable release.
i.e.: 0.1.4-dev is the development version and 0.1.4 is the official stable version.

If your device is misbehaving, consider posting it on issues using this template.
Known issued can be found under the troubleshoot page.