New York Minute is a text-based game set in New York City. As a player, you choose your background and dream, then navigate through different locations in the city while making decisions to work, relax, network, and save your progress. The goal is to achieve your dream by gaining reputation points.
You can install New York Minute using pip:
pip install -i https://test.pypi.org/simple/ new-york-minute==0.2.0
New York Minute provides four different functions to start and play the game:
solo_game(player_name, player_dream, player_background): Start a single-player game with the provided player details.multiplayer_game(player_names, player_dreams, player_backgrounds): Start a multiplayer game with the provided player details for each player.custom_game(num_players, player_names, player_dreams, player_backgrounds): Start a custom game with the specified number of players and their details.load_game(save_file): Load a previously saved game from the specified save file.
To use these functions, first import them from the new_york_minute package:
from new_york_minute import solo_game, multiplayer_game, custom_game, load_gameTo start a solo game, either call the package directly
python -m new_york_minute
or the solo_game function with the player's name, dream, and background:
solo_game("John", "Become a successful artist", "Artist")You can also pass a list of actions to automate the game:
solo_game("John", "Become a famous musician", "Artist", actions=['work', 'relax', 'network'])To start a multiplayer game, call the multiplayer_game function with lists of player names, dreams, and backgrounds:
multiplayer_game(["Alice", "Bob"], ["Open a cafe", "Launch a tech startup"], ["Entrepreneur", "Student"])You can also pass a list of actions to automate the game:
multiplayer_game(["Alice", "Bob"], ["Open a cafe", "Launch a tech startup"], ["Entrepreneur", "Student"], actions=['work', 'relax', 'network'])To start a custom game with a specific number of players, call the custom_game function with the desired number of players and lists of player names, dreams, and backgrounds:
custom_game(3, ["Alice", "Bob", "Charlie"], ["Open a cafe", "Launch a tech startup", "Become a famous musician"], ["Entrepreneur", "Student", "Artist"])You can also pass a list of actions to automate the game:
custom_game(3, ["Alice", "Bob", "Charlie"], ["Open a cafe", "Launch a tech startup", "Become a famous musician"], ["Entrepreneur", "Student", "Artist"], actions=['work', 'relax', 'network'])To load a previously saved game, call the load_game function with the path to the save file:
load_game("savegame.json")You can also pass a list of actions to automate the game:
load_game("savegame.json", actions=['work', 'relax', 'network'])During each turn, you will be presented with the current location and a random event. You can choose to work, relax, network, or save your progress. The game ends when you achieve your dream by gaining enough reputation points or when you complete all the locations.
Here is an example program using our Python package.
To run tests for the New York Minute package in a pipenv, ensure you have pipenv installed. Then run pipenv install in a new testing directory.
After, run pipenv shell to activate the virtual environment. Now that we are in the virtual environment, run pipenv install -i https://test.pypi.org/simple/ new-york-minute==0.2.0
to download the new_york_minute package. Download the /tests directory from this repository and place it into the root directory. Lastly, run python -m pytest -s in the root directory.
The -s flag allows capturing of stdout and stderr during the tests because this project is a console-based game.
Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.
New York Minute Package
This project is licensed under the MIT License. See the LICENSE file for details.