README.md

Tile-Game

A tile-based multiplayer game with procedural terrain generation (using the Perlin Noise algorithm).

Currently in development.

Pre-release v0.0.1a is now available.

Table of contents:

• Preview
• Controls
• Setup
  • Debug mode
• Documentation
• Information
  • Project
  • Contributors
  • Credits
  • Compatibility
  • Dependencies

Preview

Controls

Key(s)	Action
Z/Q/S/D	Move player (temporary)
LMB	Break breakable tiles
Mouse Wheel	Switch item in hotbar
Space	Show map
Esc	Pause menu/Main menu
Alt + Enter	Fullscreen mode

Setup

Requires: Python 3.11 or later

Before installing the necessary modules, it is recommended to set up a virtual environment. This allows for a clean workspace and avoids installing packages to your global environment.

Set up a new virtual environment. For the sake of conventions, we'll call ours venv:

python -m venv venv   # Windows
python3 -m venv venv  # MacOS / Unix	

Activate it using:

venv\Scripts\activate     # Windows
source venv/bin/activate  # MacOS / Unix

In order to install the necessary modules, Poetry is recommended but not required. You can install it using the following:

pip install poetry

Install the pre-requisites:

poetry install

If you prefer not to install the development dependencies, then feel free to use the --only main flag.

If you prefer not to use poetry, then you may manually install the dependencies listed here with pip.

Run the game using:

python -m game  # Windows
python3 -m game # MacOS / Unix

Debug mode

If you wish to launch the game with extra debugging information, use the --debug or -d flag:

python -m game --debug   # Windows
python3 -m game --debug  # MacOS / Unix

Note that using this mode will significantly impact the performance of the game, and therefore should not be used when playing normally.

Documentation

The official documentation of this repository is hosted on Readthedocs.

You may find it here.

Other versions in different languages may exist in the future, but for now it is only in English.

The tools/gen_docs tool must be run in order generate relevant doc files before pushing to the repository.

Information

Project

Current pre-release: v0.0.1a

Contributors [A-Z]:

• Jatzylap (art, alpha-testing)
• o.nihilist (programming, translation)
• Pickmonde (art)
• SammygoodTunes (art, programming)

Credits:

• Original "Pixeled" typeface by OmegaPC777
  • Edited to support more characters

Compatibility

This project was tested on the following operating systems:

• Debian 12
• Windows 10

If you are using an operating system/distribution that isn't listed above, then the game may or may not work as intended.

Dependencies

Name	Version	Required?
Pygame	^2.6.1	Yes
Python-i18n	^0.3.9	Yes
PyYAML	^6.0.2	Yes
PyTest	^8.3.3	No

Go back to the top