Merge pull request #40 from sebastianluczak/feature/cities-dlc

Feature/cities dlc

Author: sebastianluczak

.gitignore

@@ -10,3 +10,13 @@
 /.idea
 /db/data/*
 ###< symfony/framework-bundle ###
+
+###> friendsofphp/php-cs-fixer ###
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
+###< friendsofphp/php-cs-fixer ###
+
+###> squizlabs/php_codesniffer ###
+/.phpcs-cache
+/phpcs.xml
+###< squizlabs/php_codesniffer ###

.php-cs-fixer.dist.php

@@ -0,0 +1,13 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->exclude('var')
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+    ])
+    ->setFinder($finder)
+;

Dockerfile

@@ -2,6 +2,7 @@ FROM php:7.4-cli
 COPY . /app
 WORKDIR /app
 RUN docker-php-ext-install mysqli pdo pdo_mysql && docker-php-ext-enable mysqli
+RUN pecl install xdebug && docker-php-ext-enable xdebug
 RUN apt update
 RUN apt install -y wget netcat zip
 RUN wget -O composer-setup.php https://getcomposer.org/installer

README.md

@@ -1,6 +1,6 @@
 # php-roguelike
+![Logo](docs/images/logo.png)
 
-Worst game on the planet.
 
 ## What is this?
 
@@ -21,8 +21,16 @@ This game is done as a part of side-project to show'up some programming skills i
 
 ## Purpose
 
-Ok, so I'm a middle aged PHP developer looking for a project or a job. This project should give me head start. :)
-Also, it's so fun to fiddle with some side-project and have a time sink for myself.
+It's so fun to fiddle with some side-project and have a time sink for myself. I was missing side project and playground/testing area to experiment and keep on track with everything.
+I'll produce a roadmap in some time to see some final goal and keep myself motivated.
+
+## Influences
+
+Ok, so in fact I've gathered a few ideas from different games. Most notably you'll see elements from:
+- Dungeons and Dragons
+- Fallout
+- ADOM
+- Enter the Gungeon
 
 ## Run & build
 
@@ -40,6 +48,7 @@ bin/build.sh
 
 ## Keymap
 
+See: [Keymap](https://github.com/sebastianluczak/php-roguelike/blob/feature/cities-dlc/src/Enum/Game/KeyboardMapEnum.php)
 ```shell
 W/A/S/D - Movement of character
 I - Player Interface (WIP)
@@ -53,6 +62,8 @@ R - regenerates the level
 P - switches DevMode (required for some output and commands)
 R - regenerate a map (DEV_MODE required) 
 M - DevRoom :D (╯°□°)╯︵ ┻━┻ 
+G - God Mode!
+K - Increase MapLevel
 ```
 
 ## Win/Lose conditions
@@ -61,15 +72,15 @@ As all roguelikes - you'll die eventually. It's just part of the process. Your s
 
 ## Legend
 
-There're multiple tiles with scattered logic all around the board.
+There are multiple tiles with scattered logic all around the board.
 
 ```shell
 # - Chest or RareChest - guaranteed drop of Item, Gold or Health Potion
 $ - Mysterious Man - can do good things for you
 * - Boss Fight - be prepared!
 o - Altar, drop some gold for a buff or curse
 ```
-TODO: {LEGEND_OF_TILES_AND_SUMMARY_OF_MECHANICS}
+Go figure the rest by yourself, see [here](https://github.com/sebastianluczak/php-roguelike/tree/feature/cities-dlc/src/Model/Tile) to get started. No documentation folks :).
 
 ## Win strategy
 1. Go for Luck > 1

bin/analyze.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+vendor/bin/php-cs-fixer fix src/
+vendor/bin/phpstan analyse src

composer.json

@@ -13,26 +13,35 @@
         "doctrine/doctrine-bundle": "^2.4",
         "doctrine/doctrine-migrations-bundle": "^3.2",
         "doctrine/orm": "^2.10",
+        "friendsofphp/php-cs-fixer": "^3.3",
         "fzaninotto/faker": "^1.9",
         "irfa/php-gatcha": "^2.1",
         "myclabs/php-enum": "^1.8",
         "nesbot/carbon": "^2.54",
+        "phpdocumentor/reflection-docblock": "^5.3",
         "porthou/dicebag": "^0.1.0",
+        "squizlabs/php_codesniffer": "*",
         "symfony/console": "5.3.*",
         "symfony/dotenv": "5.3.*",
         "symfony/flex": "^1.3.1",
         "symfony/framework-bundle": "5.3.*",
         "symfony/messenger": "5.3.*",
         "symfony/monolog-bundle": "^3.7",
+        "symfony/property-access": "5.3.*",
+        "symfony/property-info": "5.3.*",
         "symfony/proxy-manager-bridge": "5.3.*",
         "symfony/redis-messenger": "5.3.*",
         "symfony/runtime": "5.3.*",
+        "symfony/serializer": "5.3.*",
         "symfony/validator": "5.3.*",
         "symfony/yaml": "5.3.*"
     },
     "require-dev": {
-        "php": "*",
-        "symfony/maker-bundle": "^1.34"
+        "phpstan/extension-installer": "^1.1",
+        "phpstan/phpstan": "^1.2",
+        "phpstan/phpstan-doctrine": "^1.0",
+        "symfony/maker-bundle": "^1.34",
+        "timeweb/phpstan-enum": "^3.0"
     },
     "config": {
         "optimize-autoloader": true,
@@ -66,7 +75,8 @@
         ],
         "post-update-cmd": [
             "@auto-scripts"
-        ]
+        ],
+        "php-cs-fixer": "php-cs-fixer --config=./.php_cs"
     },
     "conflict": {
         "symfony/symfony": "*"