https://github.com/shijbey/cityvizgame
https://github.com/shijbey/cityvizgame
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/shijbey/cityvizgame
- Owner: ShiJbey
- License: mit
- Created: 2021-11-05T06:09:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-11-14T08:48:59.000Z (over 3 years ago)
- Last Synced: 2025-02-02T18:45:00.397Z (4 months ago)
- Language: Python
- Size: 4.18 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# CityViz Game
This is a visualizer tool/game for Talk of the Town, a city-scale character-based social simulation written in Python.
This game wraps that simulation and presents it using an isometric city-builder aesthetic.
This game is witten using pygame and pygame_gui. The project needed to be cross-platform and python based.
So, pygame fit perfectly. Unfortunately, this does result in low frame rates, but this is a research game
(low FPS isn't a huge dealbreaker).
Most of the functionality is not present yet. The UI is the thoughest component to work with. I'm still wrapping my
head around how to use pygame_gui
## How to Install
**Requirements**: Python: 3.6+, pygame, pygame_gui, talktown
_**We recommend installing all packages to a python virtual environment**_
This package is only available via this repo. You may clone it or download the source as a zip.
The required packages are listed above. Talktown is not available on Pypi, so you can only download it
from [GitHub](https://github.com/ShiJbey/talktown). Follow the installation instructions for that repo.
The other dependencies should be downloaded after running: `pip install "."` in the root of this project.
If you plan on editing and installing cityviz for development use `pip install -e ".[test]"` instead.
This will install the dependencies for running the main game and the test files.
## How to Play
The game is configure to be ran as a python module. Assuming that the package is installed
as outlined in the previous section, run `python -m cityviz` to play.
## To Do List
- [ ] (Quality of Life) Implement batch drawing for ground tiles to improve efficiency
- [ ] (Feature) Click on building to open a window displaying what residences and businesses it contains
- [ ] (Feature) Click on the name of a residence in the building info window to get a window with information about the residence
- [ ] (Feature) Click on the name of a character in the residence window to get information about that character
- [ ] (Feature) Click on the name of a business in the building info window to open a window with information about the business
- [ ] (Feature) Click on the name of an employee in the business info window and open a new character info window
- [ ] (Feature) Click on the names of other characters in the character info window to open additional character info windows
- [ ] (Feature) Stop/Start the simulation using the space bar
- [ ] (Quality of Life) Add additional building style images
- [ ] (Feature) Save the state of the simulation out to file
- [ ] (Feature) Load a simulation state from file