Modularized the game to be easier to expand and maintain
Fixed bugs
Added scsm for versioning
Added setup.py with scripts to launch the game
Changes:
- Deleted unused conditions from .gitignore
- Restructured folders as follow:
- civsim main file removed to create a project structure oriented folder( civsim is the name of the project):
- setup.py: inits game, loads config file and starts game_master instance)
- game_master: controls world generation, civilization generation, game loop and display
- scmversion: for automatic versioning (not finished configuring yet)
- version: it takes the version from scmversion which is automatically generated when you run setup and install the project
- config: game configuration parameters, logo, log url (in the future I plan to create a configuration class)
- module civ:
- civ: class with the class method born_civ, class variables civ_ptr (pointer) and the instance methods actions (previous name execute), registry(previous name update (reasoning kingdom do an annual registry so it's kinda a better name looking into what update does)) expand, collapse, disslove. Renamed symbol to emblem as kingdom, countries have emblems
- constants
- utils: scan method was not necessary anymore (scan functionality without delete was never used as you can check if something is inside a list directly so I renamed it to sweep the land and not it is only used for delete), updated findciv and renamed to find_civ
- module world:
- world: class with all the world and civilization grid stuff
- constants
- utils: messy_noice method
- third rpgtools library was moved here and the .gitmodule command updated to point here
- scripts
- version: returns game version
- run: runs the game (it support parameters like --debug, --seed and --age (--seed and --age are a proof of concept yet, looking into expanding debug and adding a profiler to measure times))
- utils: argument parser class for commands
- In order to install the game you only need to clone the repository and in the root folder GitHub\civsim just use the command
pip install -e .
. the game will proceed to install the directory package and submodules and all the needed third party libraries from the requirements.txt file. If the game is already installed it will uninstall the old version first and update dependencies if any. It is recommended to install the game inside a virtual env with the commands $python3 -m venv .
$ . bin/activate
or Scripts\activate.bat
(window). This approach allows to use effectively absolute imports and it allows to upload civsim to pip in the future. Finally run the game with civsim-run.
- Renamed readme.md to README.md following conventions (LICENSE and CONTRIBUTION are missing btw I can create an issue requesting that later)
- Added game_master class which instantiate world and civilisation class, saving the instances into dictionaries, after seeding the first civilisations it continues with the while loop game until year is equal to age.
- Improved player initialization concept with cpu=True variable by default
- Images moved to docs so all the project information is together. CHANGELOG.md added (there is a program which creates automatic changelogs but I need to tune in yet)
- Changes on civ class:
- make_civ renamed to born_civ
- renamed civletter to civ emblems
- Fixed bugs on collapse, expand and dissolve methods (I can explain this in further details tomorrow) but random.choice was replaced by sample to avoid taking the same tile in the foor loop and there was inconsistencies with dead civilisations (collapse takes all the territories of a civilization but dissolve method was not called until the next iteration), finally civilisation was trying to be created (collapse and dissolve) but failing because no more civ emblems were available (for example if only emblems ZX are availables and civ A collapses with 5 territories and the 5 of them try to create a civ only the 3 first can do it, this could creates phantom expand method calls crashing the game)
- Added reason why civ is collapsing for a nature disaster (placeholder I plan to expand it to a weather class and checking the biome before hand to avoid drought on snow biomes unless we have global warming ofc)
- Optimized _priorities array generation: (in general two for loops should be avoided complexity O(n2) but same times is not possible) for priority array I could improve the performance using only one loop and a bit of magic
This is a first draft I didn't have time to polish all the methods and optimize then but I tested the two game modes and I believe no bugs were left, the game was tested 20 or 30 times. Logs over all the game were improved to be more helpful and some try catch added for debugging. BTW I recommend using ipdb; ipdb.set_trace() for execution time debugging you just need to install it with pip.
There seems to be lot of changes but mostly the code it the same just structured to be project friendly, added setup so people can just use pip install, optimizations and bugs related with the class oriented approach or legacy bugs. The project folder update was the most important thing to do as the project would quickly grows unmanageable without it and the class oriented concept is desired for games.
I have a trello with ideas I can share with you, I think you have plenty of good ideas with they way you are developing the game, can't wait to see what you do with language. One of the first thing I would like to do is optimizing probably adding numpy, adding automatic testing, improve debug mode, finish automatic versioning, update README.md
Name for all the method classes can be discussed if you prefer one over another
I added your last changes to the civilisation class (language and name) but I disabled them (commented) because I got an error OSError: [E050] Can't find model 'en_core_web_sm'. It doesn't seem to be a Python package or a valid path to a data directory
. in the file github\civsim\civsim\third\rpgtools\subject_verb_object_extract.py maybe you can point out to me if this is a bug or I did something wrong.
Sorry for the long post feel free to check all the files and discuss doubts or improvements!