Pycraft

<p align="center"> <a href="https://github.com/PycraftDeveloper" target="_blank" rel="noreferrer"><img src="https://github.com/PycraftDeveloper/Pycraft/assets/81379254/216d1c7f-d509-427b-b2e8-7a396cab8415" alt="my banner"></a> </p> <h1 align="center">Pycraft is the OpenGL, open world, video game made with Python.</h1>

<br />

Contents

• About
• Preview Video
• Setup
• • Installing the project (recommended)
• • Installing the project (manual approach)
• Execution
• Credits
• Changes
• Understanding the Release Notes
• Input Mapping
• Our Update Policy
• Version Naming
• Final Notices

• The Planned Storyline
• Sound Preview
• Difficulty Comparison

• The Documentation for Pycraft (Read-The-Docs)
• The Documentation for Pycraft (GitHub Wikis)

• Contact me on Twitter

About

Pycraft is a 3D open-source, open-world video game made in Python. For a long time attempts to make large 3D games in Python have been ignored, we believe there are two reasons: one; People use Python primarily for data handling and processing and not graphics and, two; there is little to no documentation out there to do anything more than make a 3D rotating cube in Python. Making a 3D game in Python for us hasn't been an easy experience, far from it but we have decided to share my project, complete with tutorials, explanations, articles and code explanations in the hope that 3D game development in Python can be seen as a more easily attainable target, and to fill that gap in documentation. Pycraft then is a trial project, as we learn and experiment on what goes best where and how thing go together, this is why development can sometimes appear to have stopped, because we are learning and testing what we have learned, so hopefully for people in the future it will be an easier experience. Also, don't forget there is more to game development than just graphics, there is AI, sound, physics and all the other GUIs that go with it, and as we learn the quality of the overall program will improve. Pycraft is not going to be the final name of the game, however until something better becomes available, we shall stick to it.

Setup

Note: Python version 3.7 to 3.11 is required!

Installing the project (recommended)

The way to install Pycraft is changing. For the best experience, we recommend this installation approach:

1. Navigate to the most recent release of Pycraft in the releases section
2. Download the installer in your desired format.
3. Run the installer and follow the installation instructions.

Note: If you run the installer from the source code, instead of through an executable format, make sure you have the following packages: requests, pillow. You can install these packages together using the command pip install requests pillow and on Linux make sure you also install pillow's dependencies using: sudo apt-get install python3-pil.imagetk and that you have the full Python standard library, which can be installed using the command: sudo apt install python3.10-full

Installing the project (manual approach)

The way we develop Pycraft is changing with code developed here and the resources hosted through MediaFire. The new installer is built to handle this, and is recommended, however if you wanted to install Pycraft on your system manually, do the following:

1. Download the source code for the most recent release of Pycraft in the releases section
2. Extract the contents to a directory of your choosing on your system.
3. Download the resources for Pycraft, found here
4. Extract the contents to the same directory as the code on your system.
5. You should end up with two sub-directories called: src and resources.
6. Run the command: pip install -r requirements.txt from the directory you just installed Pycraft to. This installs Pycraft's dependencies.

Note: When installing Pycraft manually, you will likely be automatically be updated to the latest version when a newer version is available. This behaviour can be configured in the settings menu.

Execution

In order to run Pycraft on your system, please follow the steps below before heaving to the "Everyone" section.

If you installed Pycraft through the installer

Or created a custom virtual environment in the Pycraft directory yourself.

1. Navigate to the directory Pycraft on your system.
2. From here the process is different depending on which operating system you are using:

• On Windows; head to this location within the Pycraft directory: /venv/pycraft/Scripts/python.exe
• On Linux; head to this location within the Pycraft directory: /venv/pycraft/bin/python

3. Make a note of the full path to this location.

If you manually created your own virtual environment

1. Navigate to the location you created your custom virtual environment in.
2. From here the process is different depending on which operating system you are using:

• On Windows; from there head to this location: /venv/pycraft/Scripts/python.exe
• On Linux; from there head to this location: /venv/pycraft/bin/python

3. Make a note of the full path to this location.

If you installed manually, and don't want to use a custom virtual environment

1. This process is much simpler, simply make a note of the command you would use to run python in the terminal.

• On Windows, this will likely be python
• On Linux, this will likely be python3 or python

Everyone

1. From the Pycraft directory, navigate to the src sub-directory.
2. Open this sub-directory in a terminal or command prompt window.
3. Type or paste (by right clicking or using the shortcut; CONTROL + SHIFT + v) the location of the Python executable you made a note of earlier.
4. Then type main.py and hit enter.

Note: We strongly advise you make a shortcut for this command as it makes the process of running Pycraft much easier.

Credits

With thanks to; <br />

• Thomas Jebson (PycraftDeveloper)
• Count of Freshness Traversal
• Dogukan Demir (demirdogukan)
• Henri Post (HenryFBP)
• FreeSound: - Erokia's "ambient wave compilation"
• [FreeSound: - Soundholder's "ambient meadow near forest"](ww