Fallout Shelter Game is a web-based simulation game where the player manages a vault full of dwellers, balancing their needs and resources to keep the vault thriving.
To use the Fallout Shelter Game, you need to have Python installed on your computer. You can download Python from the official website: https://www.python.org/downloads/
You can install dependencies using pip by running the following command in your terminal:
pip install -r requirements.txt
If you prefer using uv, you can install the dependencies with:
On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
On Windows.
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
With pip.
pip install uv
To activate the virtual environment:
On macOS and Linux.
source .venv/bin/activate
On Windows.
.venv\Scripts\activate
To start playing the game, simply run following commands in your terminal:
alembic upgrade head
fastapi dev main.pyTo begin playing the Fallout Shelter Game, visit the web server at localhost. Here, you'll be able to create your vault and start managing your community of dwellers right away.
Navigate through the web interface to make decisions about building rooms, assigning tasks, and managing resources. Your choices will determine the success and growth of your vault.
Aim to develop a thriving community and ensure the well-being of your dwellers as you expand your vault.
https://app.eraser.io/workspace/yjdEyc0bpOXOKVfbGpl0?origin=share
We welcome contributions to the Fallout Shelter Game! If you're interested in helping improve the game, please follow these steps:
Setup Your Environment: Clone the repository and install the development dependencies from requirements-dev.txt to set up your local development environment.
pip install -r requirements-dev.txt
Install Pre-commit Hooks: Ensure code quality and consistency by installing pre-commit hooks:
pre-commit install
Make Changes: After making your changes, please ensure they meet our coding standards and pass all tests.
Submit a Pull Request: Push your changes to a branch in your fork and open a pull request to the main project. Include a clear description of the improvements and any relevant issue numbers.
Code Review: Your pull request will be reviewed by the maintainers, who may provide feedback or request changes before merging.
Thank you for helping us improve the Fallout Shelter Game!
This section not only guides potential contributors through the setup and contribution process but also establishes expectations for code quality and collaboration.
This game was developed by ElderEvil as a pet project.
The game is inspired by the Fallout Shelter game by Bethesda Softworks.