Skip to content
This repository was archived by the owner on Jul 8, 2020. It is now read-only.

Commit 1e1d964

Browse files
committed
Create README.md
Adding readme file
1 parent 7d107d5 commit 1e1d964

1 file changed

Lines changed: 47 additions & 0 deletions

File tree

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
php-micrork
2+
===========
3+
Text based action adventure game build on PHP and Symfony components.
4+
This is a work in progress and is part of the end of the year 2014 SDPHP studygroup programming project.
5+
6+
##Installation
7+
- Download/Clone the project
8+
- Change directory to the project root: `cd php-micrork`
9+
- Download Composer `curl -sS https://getcomposer.org/installer | php`
10+
- Install Dependencies `php composer.phar install`
11+
12+
##Start the game
13+
Just type the following command
14+
```
15+
> php app/game micrork:run
16+
```
17+
18+
## Things to work on
19+
- [ ] Update Game Mechanics
20+
- [X] Create an YAML config loader
21+
- [ ] Create an XML config loader (optional)
22+
- [ ] Update game to load additional rooms/worlds
23+
- [ ] Add persistent storage to save game state (optional)
24+
- [ ] Use DI container to setup game based on parameters.yml file.
25+
- [ ] Update Gameplay
26+
- [ ] Add world objectives
27+
- [ ] Add enemies
28+
- [ ] Add hero stats
29+
- [ ] Add a fight system
30+
- [ ] Add an interaction system
31+
- [ ] Give an end to the game
32+
- [ ] Update Configuration
33+
- [ ] Extend the story
34+
- [ ] Create user configuration
35+
- [ ] Create NPC configuration
36+
- [ ] Create item configuration
37+
38+
##Resources
39+
###ZORK Text:
40+
http://i7-dungeon.sourceforge.net/source.txt
41+
42+
###ZORK Emulator:
43+
thcnet.net/zork/index.php
44+
45+
###Text based game configuration
46+
http://www.tuxradar.com/practicalphp/21/4/2
47+

0 commit comments

Comments
 (0)